Class DiscoveryModule

Hierarchy (View Summary)

MeshModule
- DiscoveryModule

Index

Constructors

Properties

name node portnum

Methods

getAgentCard getDiscoveredAgents handlePacket isKnown onAttach onDiscovery onStart onStop

Constructors

constructor

new DiscoveryModule(
    config?: DiscoveryConfig,
    topology?: TopologyMap,
    storeAndForward?: StoreAndForward,
): DiscoveryModule
Parameters
- Optionalconfig: DiscoveryConfig
- Optionaltopology: TopologyMap
- OptionalstoreAndForward: StoreAndForward
Returns DiscoveryModule
Overrides MeshModule.constructor
- Defined in packages/core/src/runtime/modules/discovery-module.ts:53

Properties

`Readonly`name

name: "discovery" = 'discovery'

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: 2 = PortNum.DISCOVERY

The port number this module handles.

Methods

getAgentCard

getAgentCard(agentId: string): AgentCard | undefined
Get a specific agent's card.
Parameters
- agentId: string
Returns AgentCard | undefined
- Defined in packages/core/src/runtime/modules/discovery-module.ts:76

getDiscoveredAgents

getDiscoveredAgents(): DiscoveredAgent[]
Get all discovered agents.

Returns DiscoveredAgent[]
- Defined in packages/core/src/runtime/modules/discovery-module.ts:71

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/discovery-module.ts:95

isKnown

isKnown(agentId: string): boolean
Check if an agent has been discovered.
Parameters
- agentId: string
Returns boolean
- Defined in packages/core/src/runtime/modules/discovery-module.ts:81

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

onDiscovery

onDiscovery(listener: (card: AgentCard) => void): () => void
Register a listener for newly discovered agents.
Parameters
- listener: (card: AgentCard) => void
Returns () => void
- Defined in packages/core/src/runtime/modules/discovery-module.ts:62

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/discovery-module.ts:144

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/discovery-module.ts:156