Class HeartbeatModule

Hierarchy (View Summary)

MeshModule
- HeartbeatModule

Index

Constructors

Properties

name node portnum

Methods

getAgent getTrackedAgents handlePacket isOnline onAttach onStart onStatusChange onStop

Constructors

constructor

new HeartbeatModule(
config?: HeartbeatConfig,
topology?: TopologyMap,
): HeartbeatModule
Parameters
- Optionalconfig: HeartbeatConfig
- Optionaltopology: TopologyMap
Returns HeartbeatModule
Overrides MeshModule.constructor
- Defined in packages/core/src/runtime/modules/heartbeat-module.ts:56

Properties

`Readonly`name

name: "heartbeat" = 'heartbeat'

Human-readable module name for logging.

`Protected`node

node: MeshNode | null = null

Reference to the owning MeshNode, set by ModuleRegistry on registration.

`Readonly`portnum

portnum: 3 = PortNum.HEARTBEAT

The port number this module handles.

Methods

getAgent

getAgent(agentId: string): TrackedAgent | undefined
Get a specific tracked agent.
Parameters
- agentId: string
Returns TrackedAgent | undefined
- Defined in packages/core/src/runtime/modules/heartbeat-module.ts:80

getTrackedAgents

getTrackedAgents(): TrackedAgent[]
Get all tracked agents.

Returns TrackedAgent[]
- Defined in packages/core/src/runtime/modules/heartbeat-module.ts:75

handlePacket

handlePacket(packet: AgentMeshPacket): Promise<void>
Handle an incoming packet dispatched to this module's portnum.
Parameters
- packet: AgentMeshPacket
Returns Promise<void>
Overrides MeshModule.handlePacket
- Defined in packages/core/src/runtime/modules/heartbeat-module.ts:91

isOnline

isOnline(agentId: string): boolean
Check if an agent is considered online.
Parameters
- agentId: string
Returns boolean
- Defined in packages/core/src/runtime/modules/heartbeat-module.ts:85

onAttach

onAttach(node: MeshNode): Promise<void>
Called once when the module is registered with a MeshNode.
Parameters
- node: MeshNode
Returns Promise<void>
Inherited from MeshModule.onAttach
- Defined in packages/core/src/runtime/modules/mesh-module.ts:22

onStart

onStart(): Promise<void>
Called when the MeshNode starts. Override for periodic tasks.

Returns Promise<void>
Overrides MeshModule.onStart
- Defined in packages/core/src/runtime/modules/heartbeat-module.ts:131

onStatusChange

onStatusChange(
listener: (agentId: string, status: AgentStatus) => void,
): () => void
Register a listener for agent status changes.
Parameters
- listener: (agentId: string, status: AgentStatus) => void
Returns () => void
- Defined in packages/core/src/runtime/modules/heartbeat-module.ts:66

onStop

onStop(): Promise<void>
Called when the MeshNode stops. Override for cleanup.

Returns Promise<void>
Overrides MeshModule.onStop
- Defined in packages/core/src/runtime/modules/heartbeat-module.ts:151