agentEventQueue

@codebolt/codeboltjs

---

Variable: agentEventQueue

const agentEventQueue: {
  _acknowledgeEvent: (eventId: string, success: boolean, errorMessage?: string) => Promise<AgentEventQueueResponse<any>>;
  _fetchPendingFromBackend: (params: GetPendingEventsInput) => Promise<AgentEventMessage[]>;
  acknowledgeEvent: (eventId: string, success: boolean, errorMessage?: string) => Promise<AgentEventQueueResponse<any>>;
  addEvent: (params: AddEventInput) => Promise<AgentEventQueueResponse<AddEventResponseData>>;
  checkForPendingExternalEvent: () => UnifiedExternalEvent | null;
  clearLocalCache: () => void;
  clearQueue: (agentId?: string) => Promise<AgentEventQueueResponse<any>>;
  getLocalCacheSize: () => number;
  getPendingExternalEventCount: () => number;
  getPendingExternalEvents: () => UnifiedExternalEvent[];
  getPendingQueueEvents: (maxDepth?: number) => Promise<AgentEventMessage[]>;
  getQueueStats: () => Promise<AgentEventQueueResponse<QueueStatsResponseData>>;
  onQueueEvent: (handler: QueueEventHandler) => () => void;
  peekLocalCache: () => AgentEventMessage[];
  sendAgentMessage: (params: SendAgentMessageInput) => Promise<AgentEventQueueResponse<AddEventResponseData>>;
  waitForAnyExternalEvent: () => Promise<UnifiedExternalEvent>;
  waitForNextQueueEvent: (maxDepth: number) => Promise<
     | AgentEventMessage
    | AgentEventMessage[]>;
};

Defined in: packages/codeboltjs/src/modules/agentEventQueue.ts:143

Type Declaration

Name	Type	Description	Defined in
_acknowledgeEvent()	(eventId: string, success: boolean, errorMessage?: string) => Promise<AgentEventQueueResponse<any>>	Acknowledge an event at the backend	packages/codeboltjs/src/modules/agentEventQueue.ts:225
_fetchPendingFromBackend()	(params: GetPendingEventsInput) => Promise<AgentEventMessage[]>	Fetch pending events from backend	packages/codeboltjs/src/modules/agentEventQueue.ts:245
acknowledgeEvent()	(eventId: string, success: boolean, errorMessage?: string) => Promise<AgentEventQueueResponse<any>>	Manually acknowledge an event. Use this when handling events via onQueueEvent.	packages/codeboltjs/src/modules/agentEventQueue.ts:425
addEvent()	(params: AddEventInput) => Promise<AgentEventQueueResponse<AddEventResponseData>>	Add an event to a target agent's queue	packages/codeboltjs/src/modules/agentEventQueue.ts:153
checkForPendingExternalEvent()	() => UnifiedExternalEvent | null	Check for any pending external events without waiting. Returns the first pending event or null if none available.	packages/codeboltjs/src/modules/agentEventQueue.ts:471
clearLocalCache()	() => void	Clear the local event cache (does not affect backend)	packages/codeboltjs/src/modules/agentEventQueue.ts:457
clearQueue()	(agentId?: string) => Promise<AgentEventQueueResponse<any>>	Clear the queue for an agent	packages/codeboltjs/src/modules/agentEventQueue.ts:203
getLocalCacheSize()	() => number	Get the number of events in the local cache	packages/codeboltjs/src/modules/agentEventQueue.ts:442
getPendingExternalEventCount()	() => number	Get the count of pending external events.	packages/codeboltjs/src/modules/agentEventQueue.ts:495
getPendingExternalEvents()	() => UnifiedExternalEvent[]	Get all pending external events. Returns all pending events and clears the cache.	packages/codeboltjs/src/modules/agentEventQueue.ts:484
getPendingQueueEvents()	(maxDepth?: number) => Promise<AgentEventMessage[]>	Get pending events from local cache. Sends acknowledgement for each event and removes from local cache. If no local events, fetches from backend.	packages/codeboltjs/src/modules/agentEventQueue.ts:296
getQueueStats()	() => Promise<AgentEventQueueResponse<QueueStatsResponseData>>	Get queue statistics	packages/codeboltjs/src/modules/agentEventQueue.ts:186
onQueueEvent()	(handler: QueueEventHandler) => () => void	Register an event handler that will be called when events are received. The handler receives events as they arrive via WebSocket. Note: This does NOT automatically acknowledge events.	packages/codeboltjs/src/modules/agentEventQueue.ts:409
peekLocalCache()	() => AgentEventMessage[]	Get all events currently in the local cache without removing them	packages/codeboltjs/src/modules/agentEventQueue.ts:450
sendAgentMessage()	(params: SendAgentMessageInput) => Promise<AgentEventQueueResponse<AddEventResponseData>>	Send an inter-agent message (convenience wrapper)	packages/codeboltjs/src/modules/agentEventQueue.ts:170
waitForAnyExternalEvent()	() => Promise<UnifiedExternalEvent>	Waits for any external event from multiple sources: - Agent queue events (from local cache or WebSocket) - Background agent completions - Grouped agent completions Returns the first event that occurs from any source.	packages/codeboltjs/src/modules/agentEventQueue.ts:509
waitForNextQueueEvent()	(maxDepth: number) => Promise< | AgentEventMessage | AgentEventMessage[]>	Wait for the next event(s) from the queue. First checks local cache, then waits for WebSocket events. Sends acknowledgement and removes from cache before resolving.	packages/codeboltjs/src/modules/agentEventQueue.ts:366