Module stanzastream

Resilient stanza stream

This module provides the StanzaStream, which is the next level up from the low-level XmlStream.

The stanza stream knows about XMPP and it most importantly knows how to fix a broken connection with a reconnect and how to do this smoothly using XEP-0198 (Stream Management). XEP-0198 is only used if the peer supports it. If the peer does not support XEP-0198, automatic reconnects are still done, but with more undetectable data loss.

The main API entrypoint for the stanza stream is, unsurprisingly, StanzaStream.

Structs

Connection

Underlying connection for a StanzaStream.

StanzaStream

Frontend interface to a reliable, always-online stanza stream.

StanzaToken

Track stanza transmission through the StanzaStream up to the peer.

Enums

Event

Event emitted by the StanzaStream.

StanzaStage

The five stages of stanza transmission.

StanzaState

State of a stanza in transit to the peer.

StreamEvent

Event informing about the change of the StanzaStream’s status.

Type Aliases

XmppStream

Convenience alias for XmlStreams which may be used with StanzaStream.