BoundedMailbox
Defined in: src/mailbox/BoundedMailbox.ts:28
Mailbox with a fixed upper bound on queued user messages. Policy for what happens when a message arrives on a full mailbox is configurable.
Extends
Section titled “Extends”Mailbox<T>
Type Parameters
Section titled “Type Parameters”T = unknown
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new BoundedMailbox<
T>(settings):BoundedMailbox<T>
Defined in: src/mailbox/BoundedMailbox.ts:34
Parameters
Section titled “Parameters”settings
Section titled “settings”Returns
Section titled “Returns”BoundedMailbox<T>
Overrides
Section titled “Overrides”Mailbox<T>.constructor
Properties
Section titled “Properties”droppedCount
Section titled “droppedCount”droppedCount:
number=0
Defined in: src/mailbox/BoundedMailbox.ts:32
Number of messages dropped by the overflow policy — useful for metrics.
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get size():
number
Defined in: src/internal/Mailbox.ts:65
Number of pending user messages.
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”Mailbox.size
suspended
Section titled “suspended”Get Signature
Section titled “Get Signature”get suspended():
boolean
Defined in: src/internal/Mailbox.ts:34
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”Mailbox.suspended
Methods
Section titled “Methods”dequeueSystem()
Section titled “dequeueSystem()”dequeueSystem():
Envelope<unknown> |undefined
Defined in: src/internal/Mailbox.ts:54
Returns
Section titled “Returns”Envelope<unknown> | undefined
Inherited from
Section titled “Inherited from”Mailbox.dequeueSystem
dequeueUser()
Section titled “dequeueUser()”dequeueUser():
Envelope<T> |undefined
Defined in: src/internal/Mailbox.ts:49
Returns
Section titled “Returns”Envelope<T> | undefined
Inherited from
Section titled “Inherited from”Mailbox.dequeueUser
drainSystem()
Section titled “drainSystem()”drainSystem():
Envelope<unknown>[]
Defined in: src/internal/Mailbox.ts:77
Returns
Section titled “Returns”Envelope<unknown>[]
Inherited from
Section titled “Inherited from”Mailbox.drainSystem
drainUser()
Section titled “drainUser()”drainUser():
Envelope<T>[]
Defined in: src/internal/Mailbox.ts:71
Drain all user messages; returns them so the caller can forward to dead letters.
Returns
Section titled “Returns”Envelope<T>[]
Inherited from
Section titled “Inherited from”Mailbox.drainUser
enqueue()
Section titled “enqueue()”enqueue(
env):void
Defined in: src/mailbox/BoundedMailbox.ts:41
Parameters
Section titled “Parameters”Envelope<T>
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”Mailbox.enqueue
enqueueSystem()
Section titled “enqueueSystem()”enqueueSystem(
env):void
Defined in: src/internal/Mailbox.ts:45
Parameters
Section titled “Parameters”Envelope<unknown>
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Mailbox.enqueueSystem
hasMessages()
Section titled “hasMessages()”hasMessages():
boolean
Defined in: src/internal/Mailbox.ts:58
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”Mailbox.hasMessages
hasSystemMessages()
Section titled “hasSystemMessages()”hasSystemMessages():
boolean
Defined in: src/internal/Mailbox.ts:62
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”Mailbox.hasSystemMessages
hasUserMessages()
Section titled “hasUserMessages()”hasUserMessages():
boolean
Defined in: src/internal/Mailbox.ts:61
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”Mailbox.hasUserMessages
prependUser()
Section titled “prependUser()”prependUser(
envs):void
Defined in: src/internal/Mailbox.ts:41
Put envelopes at the FRONT of the user queue, preserving their order.
Parameters
Section titled “Parameters”Envelope<T>[]
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Mailbox.prependUser
resume()
Section titled “resume()”resume():
void
Defined in: src/internal/Mailbox.ts:68
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Mailbox.resume
suspend()
Section titled “suspend()”suspend():
void
Defined in: src/internal/Mailbox.ts:67
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Mailbox.suspend