BoundedMailbox
Esta página aún no está disponible en tu idioma.
Defined in: src/mailbox/BoundedMailbox.ts:21
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
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new BoundedMailbox<
T>(options):BoundedMailbox<T>
Defined in: src/mailbox/BoundedMailbox.ts:36
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”BoundedMailbox<T>
Overrides
Section titled “Overrides”Properties
Section titled “Properties”droppedCount
Section titled “droppedCount”droppedCount:
number=0
Defined in: src/mailbox/BoundedMailbox.ts:34
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:145
Number of pending user messages.
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”suspended
Section titled “suspended”Get Signature
Section titled “Get Signature”get suspended():
boolean
Defined in: src/internal/Mailbox.ts:97
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”dequeueSystem()
Section titled “dequeueSystem()”dequeueSystem():
Envelope<unknown> |undefined
Defined in: src/internal/Mailbox.ts:134
Returns
Section titled “Returns”Envelope<unknown> | undefined
Inherited from
Section titled “Inherited from”dequeueUser()
Section titled “dequeueUser()”dequeueUser():
Envelope<T> |undefined
Defined in: src/internal/Mailbox.ts:112
Returns
Section titled “Returns”Envelope<T> | undefined
Inherited from
Section titled “Inherited from”drainSystem()
Section titled “drainSystem()”drainSystem():
Envelope<unknown>[]
Defined in: src/internal/Mailbox.ts:157
Returns
Section titled “Returns”Envelope<unknown>[]
Inherited from
Section titled “Inherited from”drainUser()
Section titled “drainUser()”drainUser():
Envelope<T>[]
Defined in: src/internal/Mailbox.ts:151
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”enqueue()
Section titled “enqueue()”enqueue(
env):void
Defined in: src/mailbox/BoundedMailbox.ts:63
Parameters
Section titled “Parameters”Envelope<T>
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”enqueueSystem()
Section titled “enqueueSystem()”enqueueSystem(
env):void
Defined in: src/internal/Mailbox.ts:108
Parameters
Section titled “Parameters”Envelope<unknown>
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”hasMessages()
Section titled “hasMessages()”hasMessages():
boolean
Defined in: src/internal/Mailbox.ts:138
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”hasSystemMessages()
Section titled “hasSystemMessages()”hasSystemMessages():
boolean
Defined in: src/internal/Mailbox.ts:142
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”hasUserMessages()
Section titled “hasUserMessages()”hasUserMessages():
boolean
Defined in: src/internal/Mailbox.ts:141
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”observeDrops()
Section titled “observeDrops()”observeDrops(
observer):void
Defined in: src/mailbox/BoundedMailbox.ts:46
See DropReportingMailbox.observeDrops — additive.
Parameters
Section titled “Parameters”observer
Section titled “observer”(reason) => void
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”DropReportingMailbox.observeDrops
prependUser()
Section titled “prependUser()”prependUser(
envs):void
Defined in: src/internal/Mailbox.ts:104
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”resume()
Section titled “resume()”resume():
void
Defined in: src/internal/Mailbox.ts:148
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”suspend()
Section titled “suspend()”suspend():
void
Defined in: src/internal/Mailbox.ts:147
Returns
Section titled “Returns”void