Class StreamManagementMirror

constructor

• new StreamManagementMirror(): StreamManagementMirror

  Returns StreamManagementMirror

serverSupported

boundJid

• get boundJid(): string

  The full JID bound when the session was enabled.

  Returns string

enabled

• get enabled(): boolean

  Whether has been received and the 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 session state (fields are mutable; the reference is not reassigned).

  Returns SMState

_onEnabled

• _onEnabled(id: string, max: number, boundJid: string): void

  Parameters

  • id: string

    The SM-ID of the fresh session.

  • max: number

    The server's preferred maximum resumption time.

  • boundJid: string

    The JID that was bound when the session was enabled.

  Returns void

_onFailed

• _onFailed(): void

  Returns void

_onResumed

• _onResumed(boundJid: string, id?: string, max?: number): void

  Parameters

  • boundJid: string

    The worker's boundJid for the resumed session.

  • Optionalid: string

    The SM-ID of the resumed session.

  • Optionalmax: number

    The server's preferred maximum resumption time.

  Returns void

hasResumableState

• hasResumableState(): boolean

  Whether persisted state allows attempting .

  Returns boolean

initialize

• initialize(_jid: string): void

  Load persisted resumable state for the given (bare) JID.

  Parameters

  • _jid: string

  Returns void

isTracking

• isTracking(): boolean

  Whether outbound stanzas are currently being tracked (i.e. was sent).

  Returns boolean

onEnabled

• onEnabled(): void

  Overridable event hook: a session was established via .

  Returns void

onFailed

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

  Overridable event hook: or failed.

  Parameters

  • Optional_view: StanzaView
  • Optional_resumeFailed: boolean

  Returns void

onGracefulClose

• onGracefulClose(): void

  End the session cleanly: final and clear persisted state.

  Returns void

onInbound

• onInbound(_view: StanzaView): void

  Process an inbound top-level element (count a stanza or handle a nonza).

  Parameters

  • _view: StanzaView

  Returns void

onInboundStanza

• onInboundStanza(_name: string): void

  Count an inbound top-level stanza by name.

  Parameters

  • _name: string

  Returns void

onResumed

• onResumed(): void

  Overridable event hook: the previous session was resumed via .

  Returns void

reset

• reset(): void

  Reset the in-memory session state.

  Returns void

sendEnable

• sendEnable(_boundJid: string): void

  Send to start a new session.

  Parameters

  • _boundJid: string

  Returns void

sendResume

• sendResume(): void

  Send for the persisted previous session.

  Returns void

trackOutbound

• trackOutbound(_view: StanzaView): void

  Track an outbound top-level element.

  Parameters

  • _view: StanzaView

  Returns void