Class AgentCommunicationBus

Implementation of the Agent Communication Bus.

Features:

Point-to-point messaging between agents
Broadcast to agencies
Request-response pattern
Topic-based pub/sub
Task handoff protocol
Message persistence and history
Delivery tracking and retries

Implements

IAgentCommunicationBus

Index

Constructors

constructor

Methods

sendToAgent sendToRole broadcast broadcastToRoles requestResponse handoff subscribe unsubscribeAll createTopic publishToTopic subscribeToTopic getDeliveryStatus acknowledgeMessage retryDelivery getStatistics getMessageHistory registerAgent unregisterAgent

Constructors

constructor

new AgentCommunicationBus(config?): AgentCommunicationBus
Creates a new AgentCommunicationBus instance.
Parameters
- config: AgentCommunicationBusConfig = {}
  Bus configuration
Returns AgentCommunicationBus
- Defined in src/agents/agency/AgentCommunicationBus.ts:138

Methods

sendToAgent

sendToAgent(targetAgentId, message): Promise<DeliveryStatus>
Sends a message to a specific agent.
Parameters
- targetAgentId: string
- message: Omit<AgentMessage, "messageId" | "toAgentId" | "sentAt">
Returns Promise<DeliveryStatus>
Implementation of IAgentCommunicationBus.sendToAgent
- Defined in src/agents/agency/AgentCommunicationBus.ts:160

sendToRole

sendToRole(agencyId, targetRoleId, message): Promise<DeliveryStatus>
Sends a message to an agent by role.
Parameters
- agencyId: string
- targetRoleId: string
- message: Omit<AgentMessage, "messageId" | "sentAt" | "toRoleId">
Returns Promise<DeliveryStatus>
Implementation of IAgentCommunicationBus.sendToRole
- Defined in src/agents/agency/AgentCommunicationBus.ts:178

broadcast

broadcast(agencyId, message): Promise<DeliveryStatus[]>
Broadcasts a message to all agents in an agency.
Parameters
- agencyId: string
- message: Omit<AgentMessage, "messageId" | "toAgentId" | "sentAt">
Returns Promise<DeliveryStatus[]>
Implementation of IAgentCommunicationBus.broadcast
- Defined in src/agents/agency/AgentCommunicationBus.ts:215

broadcastToRoles

broadcastToRoles(agencyId, roleIds, message): Promise<DeliveryStatus[]>
Broadcasts to specific roles within an agency.
Parameters
- agencyId: string
- roleIds: string[]
- message: Omit<AgentMessage, "messageId" | "sentAt">
Returns Promise<DeliveryStatus[]>
Implementation of IAgentCommunicationBus.broadcastToRoles
- Defined in src/agents/agency/AgentCommunicationBus.ts:240

requestResponse

requestResponse(targetAgentId, request): Promise<AgentResponse>
Sends a request and waits for a response.
Parameters
- targetAgentId: string
- request: AgentRequest
Returns Promise<AgentResponse>
Implementation of IAgentCommunicationBus.requestResponse
- Defined in src/agents/agency/AgentCommunicationBus.ts:276

handoff

handoff(fromAgentId, toAgentId, context): Promise<HandoffResult>
Initiates a structured handoff between agents.
Parameters
- fromAgentId: string
- toAgentId: string
- context: HandoffContext
Returns Promise<HandoffResult>
Implementation of IAgentCommunicationBus.handoff
- Defined in src/agents/agency/AgentCommunicationBus.ts:344

subscribe(agentId, handler, options?): Unsubscribe
Subscribes an agent to receive messages.
Parameters
- agentId: string
- handler: MessageHandler
- options: SubscriptionOptions = {}
Returns Unsubscribe
Implementation of IAgentCommunicationBus.subscribe
- Defined in src/agents/agency/AgentCommunicationBus.ts:395

unsubscribeAll

unsubscribeAll(agentId): void
Unsubscribes an agent from all messages.
Parameters
- agentId: string
Returns void
Implementation of IAgentCommunicationBus.unsubscribeAll
- Defined in src/agents/agency/AgentCommunicationBus.ts:429

createTopic

createTopic(topic): Promise<MessageTopic>
Creates a message topic.
Parameters
- topic: Omit<MessageTopic, "topicId">
Returns Promise<MessageTopic>
Implementation of IAgentCommunicationBus.createTopic
- Defined in src/agents/agency/AgentCommunicationBus.ts:445

publishToTopic

publishToTopic(topicId, message): Promise<DeliveryStatus[]>
Publishes a message to a topic.
Parameters
- topicId: string
- message: Omit<AgentMessage, "messageId" | "sentAt">
Returns Promise<DeliveryStatus[]>
Implementation of IAgentCommunicationBus.publishToTopic
- Defined in src/agents/agency/AgentCommunicationBus.ts:461

subscribeToTopic

subscribeToTopic(agentId, topicId, handler): Unsubscribe
Subscribes an agent to a topic.
Parameters
- agentId: string
- topicId: string
- handler: MessageHandler
Returns Unsubscribe
Implementation of IAgentCommunicationBus.subscribeToTopic
- Defined in src/agents/agency/AgentCommunicationBus.ts:502

getDeliveryStatus

getDeliveryStatus(messageId): Promise<null | DeliveryStatus>
Gets the delivery status of a message.
Parameters
- messageId: string
Returns Promise<null | DeliveryStatus>
Implementation of IAgentCommunicationBus.getDeliveryStatus
- Defined in src/agents/agency/AgentCommunicationBus.ts:530

acknowledgeMessage

acknowledgeMessage(messageId, agentId): Promise<void>
Acknowledges receipt of a message.
Parameters
- messageId: string
- agentId: string
Returns Promise<void>
Implementation of IAgentCommunicationBus.acknowledgeMessage
- Defined in src/agents/agency/AgentCommunicationBus.ts:537

retryDelivery

retryDelivery(messageId): Promise<DeliveryStatus>
Retries delivery of a failed message. The retry is counted on the message's status before the re-send, the status the re-send stores keeps the count, and once routingConfig.maxRetries retries have been made this throws without sending.
Parameters
- messageId: string
Returns Promise<DeliveryStatus>
Implementation of IAgentCommunicationBus.retryDelivery
- Defined in src/agents/agency/AgentCommunicationBus.ts:557

getStatistics

getStatistics(): BusStatistics
Gets message bus statistics.

Returns BusStatistics
Implementation of IAgentCommunicationBus.getStatistics
- Defined in src/agents/agency/AgentCommunicationBus.ts:597

getMessageHistory

getMessageHistory(agentId, options?): Promise<AgentMessage[]>
Gets message history for an agent.
Parameters
- agentId: string
- Optional options: {
      limit?: number;
      since?: Date;
      types?: AgentMessageType[];
      direction?: "sent" | "received" | "both";
  }
  - Optional limit?: number
  - Optional since?: Date
  - Optional types?: AgentMessageType[]
  - Optional direction?: "sent" | "received" | "both"
Returns Promise<AgentMessage[]>
Implementation of IAgentCommunicationBus.getMessageHistory
- Defined in src/agents/agency/AgentCommunicationBus.ts:604

registerAgent

registerAgent(agentId, agencyId, roleId): void
Registers an agent with an agency for routing.
Parameters
- agentId: string
- agencyId: string
- roleId: string
Returns void
- Defined in src/agents/agency/AgentCommunicationBus.ts:644

unregisterAgent

unregisterAgent(agentId): void
Unregisters an agent from routing.
Parameters
- agentId: string
Returns void
- Defined in src/agents/agency/AgentCommunicationBus.ts:665

Class AgentCommunicationBus

Implements

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns AgentCommunicationBus

Methods

sendToAgent

Parameters

Returns Promise<DeliveryStatus>

sendToRole

Parameters

Returns Promise<DeliveryStatus>

broadcast

Parameters

Returns Promise<DeliveryStatus[]>

broadcastToRoles

Parameters

Returns Promise<DeliveryStatus[]>

requestResponse

Parameters

Returns Promise<AgentResponse>

handoff

Parameters

Returns Promise<HandoffResult>

subscribe

Parameters

Returns Unsubscribe

unsubscribeAll

Parameters

Returns void

createTopic

Parameters

Returns Promise<MessageTopic>

publishToTopic

Parameters

Returns Promise<DeliveryStatus[]>

subscribeToTopic

Parameters

Returns Unsubscribe

getDeliveryStatus

Parameters

Returns Promise<null | DeliveryStatus>

acknowledgeMessage

Parameters

Returns Promise<void>

retryDelivery

Parameters

Returns Promise<DeliveryStatus>

getStatistics

Returns BusStatistics

getMessageHistory

Parameters

Optional limit?: number

Optional since?: Date

Optional types?: AgentMessageType[]

Optional direction?: "sent" | "received" | "both"

Returns Promise<AgentMessage[]>

registerAgent

Parameters

Returns void

unregisterAgent

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

`Optional` limit?: number

`Optional` since?: Date

`Optional` types?: AgentMessageType[]

`Optional` direction?: "sent" | "received" | "both"