Skip to content

bodhi-realtime-agent / DeadLetterQueue

Class: DeadLetterQueue ​

Defined in: src/runtime/dead-letter-queue.ts:40

Bounded dead-letter queue.

When the queue is full, the oldest entry is evicted to make room. Provides query methods for observability and diagnostics.

Constructors ​

Constructor ​

new DeadLetterQueue(config?): DeadLetterQueue

Defined in: src/runtime/dead-letter-queue.ts:45

Parameters ​

config? ​

Partial<DeadLetterQueueConfig>

Returns ​

DeadLetterQueue

Accessors ​

latest ​

Get Signature ​

get latest(): DeadLetterEntry | undefined

Defined in: src/runtime/dead-letter-queue.ts:100

Get the most recent entry.

Returns ​

DeadLetterEntry | undefined


size ​

Get Signature ​

get size(): number

Defined in: src/runtime/dead-letter-queue.ts:85

Current number of retained entries.

Returns ​

number


totalCount ​

Get Signature ​

get totalCount(): number

Defined in: src/runtime/dead-letter-queue.ts:90

Total number of dead letters ever enqueued (including evicted).

Returns ​

number

Methods ​

clear() ​

clear(): void

Defined in: src/runtime/dead-letter-queue.ts:95

Clear all entries.

Returns ​

void


enqueue() ​

enqueue(envelope, reason, error?): void

Defined in: src/runtime/dead-letter-queue.ts:50

Add a dead-letter entry.

Parameters ​

envelope ​

Envelope

reason ​

"no_actor" | "actor_stopped" | "processing_failed"

error? ​

string

Returns ​

void


getEntries() ​

getEntries(): readonly DeadLetterEntry[]

Defined in: src/runtime/dead-letter-queue.ts:70

Get all current entries.

Returns ​

readonly DeadLetterEntry[]


getEntriesByType() ​

getEntriesByType(messageType): DeadLetterEntry[]

Defined in: src/runtime/dead-letter-queue.ts:80

Get entries filtered by message type.

Parameters ​

messageType ​

string

Returns ​

DeadLetterEntry[]


getEntriesForActor() ​

getEntriesForActor(actorId): DeadLetterEntry[]

Defined in: src/runtime/dead-letter-queue.ts:75

Get entries filtered by target actor.

Parameters ​

actorId ​

string

Returns ​

DeadLetterEntry[]

Built with VitePress