Class StreamManagement

constructor

• new StreamManagement(
      sendRaw: (data: string) => void,
      options?: StreamManagementOptions,
  ): StreamManagement

  Parameters

  • sendRaw: (data: string) => void

    Emits a serialized nonza (or re-sent stanza) towards the server.

  • options: StreamManagementOptions = {}

  Returns StreamManagement

serverSupported

boundJid

• get boundJid(): string

  The full JID bound when the SM session was enabled.

  Returns string

enabled

• get enabled(): boolean

  Whether has been received and the SM session is active.

  Returns boolean

resumed

• get resumed(): boolean

  Whether the current session was established by resumption.

  Returns boolean

resumePending

• get resumePending(): boolean

  Whether a has been sent and not yet answered.

  Returns boolean

state

• get state(): SMState

  The live SM state. Treat as read-only outside of tests.

  Returns SMState

clearPersistedState

• clearPersistedState(): void

  Remove persisted state (clean close, logout, failed resume).

  Returns void

hasResumableState

• hasResumableState(): boolean

  Returns boolean

  true if persisted state allows attempting .

initialize

• initialize(jid: string): void

  Set the storage key (from the user's bare JID) and load any persisted resumable state. Call before deciding between resume and fresh bind.

  Parameters

  • jid: string

    The user's JID (a full JID is reduced to its bare form).

  Returns void

isTracking

• isTracking(): boolean

  Returns boolean

  true once has been sent, i.e. outbound stanzas are being tracked. Lets the caller skip building a StanzaView for trackOutbound when tracking is inactive, without reaching into the engine's state.

onEnabled

• onEnabled(): void

  Overridable event hook: an SM session was established via .

  Returns void

onFailed

• onFailed(_view?: StanzaView, _resumeFailed?: boolean): void

  Overridable event hook: or failed.

  Parameters

  • Optional_view: StanzaView

    The nonza (inspect e.g. for ).

  • Optional_resumeFailed: boolean

    true when the failure answered a (the unacked queue was salvaged for re-send on the next session), false when it answered an .

  Returns void

onGracefulClose

• onGracefulClose(): void

  Call when the stream is about to be closed cleanly: sends a final so the server doesn't redeliver stanzas that were actually received (RECOMMENDED, XEP-0198 §4), clears persisted state (a cleanly closed stream is not resumable, XEP-0198 §Stream Closure) and deactivates the engine, so nothing sent during teardown is tracked or re-persisted.

  Returns void

onInbound

• onInbound(view: StanzaView): void

  Process one inbound top-level element: count it if it is a countable stanza (when the session is enabled), otherwise handle it as an SM nonza (////). Unrecognised elements are ignored. Each host dispatches inbound elements to its own handlers independently of this call, so nothing is returned.

  Parameters

  • view: StanzaView

  Returns void

onInboundStanza

• onInboundStanza(name: string): void

  Count an inbound top-level stanza by name. Adapters call this from their dispatch loop for every inbound child element — non-countable names and inactive sessions are no-ops, so no StanzaView needs to be built for the common case.

  Parameters

  • name: string

    The element's local tag name.

  Returns void

onResumed

• onResumed(): void

  Overridable event hook: the previous session was resumed via .

  Returns void

requestAck

• requestAck(): void

  Send an unrequested ack request to the server.

  Returns void

reset

• reset(): void

  Reset the in-memory engine (e.g. from Connection.reset()). Persisted state is NOT touched — clearing storage is tied to intent (clean close, logout, failed resume), not to connection reuse.

  Returns void

sendAck

• sendAck(): void

  Send an ack with the current inbound count. Used to answer , and RECOMMENDED right before gracefully closing the stream (XEP-0198 §4) so the server doesn't redeliver stanzas that were actually received.

  Returns void

sendEnable

• sendEnable(boundJid: string): void

  Send to start a new SM session. Call after resource binding, at the point CONNECTED is emitted. At most one is sent per stream — a second attempt SHOULD get the stream killed by the server (XEP-0198 §3).

  Parameters

  • boundJid: string

    The full JID that was just bound.

  Returns void

sendResume

• sendResume(): void

  Send for the persisted previous session. Call instead of binding, once the post-SASL stream features advertise SM support.

  Returns void

trackOutbound

• trackOutbound(view: StanzaView): void

  Track an outbound top-level element. Called for every element that enters the send queue; non-countable elements are ignored here. Active from the moment is sent (not from receipt — XEP-0198 starts the outbound counter at enable-send).

  Parameters

  • view: StanzaView

  Returns void