StreamManagementManager class

Inheritance

Constructors

StreamManagementManager({Duration ackTimeout = const Duration(seconds: 30)})

Properties

ackTimeout Duration
The time in which the response to an ack is still valid. Counts as a timeout otherwise
final
hashCode int
The hash code for this object.
no setterinherited
id String
Return the Id (akin to xmlns) of this manager.
finalinherited
initialized bool
Flag indicating that the post registration callback has been called once.
getter/setter pairinherited
logger Logger
Return the logger for this manager.
no setterinherited
name String
The name of the manager.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
state StreamManagementState
no setter
streamResumed bool
no setter

Methods

commitState() Future<void>
May be overwritten by a subclass. Should save state so that it can be loaded again with this.loadState.
getAttributes() XmppManagerAttributes
Returns the attributes that are registered with the manager. Must only be called after register has been called on it.
inherited
getDiscoFeatures() List<String>
Return a list of features that should be included in a disco response.
inherited
getDiscoIdentities() List<Identity>
Return a list of identities that should be included in a disco response.
inherited
getIncomingPreStanzaHandlers() List<StanzaHandler>
Return the StanzaHandlers associated with this manager that deal with stanza handlers that have to run before the main ones run. This is useful, for example, for OMEMO as we have to decrypt the stanza before we do anything else. The higher the value of the handler's priority, the earlier it is run.
override
getIncomingStanzaHandlers() List<StanzaHandler>
Return the StanzaHandlers associated with this manager that deal with stanzas we receive. The higher the value of the handler's priority, the earlier it is run.
inherited
getNonzaHandlers() List<NonzaHandler>
Return the NonzaHandlers associated with this manager. The higher the value of the handler's priority, the earlier it is run.
override
getOutgoingPostStanzaHandlers() List<StanzaHandler>
Return the StanzaHandlers associated with this manager that deal with stanzas we send. These are run after the stanza is sent. The higher the value of the handler's priority, the earlier it is run.
override
getOutgoingPreStanzaHandlers() List<StanzaHandler>
Return the StanzaHandlers associated with this manager that deal with stanzas we send. These are run before the stanza is sent. The higher the value of the handler's priority, the earlier it is run.
inherited
getPendingAcks() Future<int>
getUnackedStanzaCount() int
Returns the amount of stanzas waiting to get acked
getUnackedStanzas() Map<int, SMQueueEntry>
Functions for testing
handleAckTimeout() Future<void>
isFeatureSupported(String xmlns) Future<bool>
Resolves to true when the server supports the disco feature xmlns. Resolves to false when either the disco request fails or the server does not support xmlns. Note that this function requires a registered DiscoManager.
inherited
isNewStream() Future<bool>
Returns true, if the current stream negotiations resulted in a new stream. Useful for plugins to reset their cache in case of a new stream. The value only makes sense after receiving a StreamNegotiationsDoneEvent.
inherited
isStreamManagementEnabled() bool
Returns whether XEP-0198 stream management is enabled
isSupported() Future<bool>
Returns true if the XEP is supported on the server. If not, returns false
override
loadState() Future<void>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onData() Future<void>
Whenever the socket receives data, this method is called, if it is non-null.
override
onStreamResumed(int h) Future<void>
To be called when the stream has been resumed
onXmppEvent(XmppEvent event) Future<void>
Called when XmppConnection triggers an event
override
postRegisterCallback() Future<void>
Called after the registration of all managers against the XmppConnection is done. This method is only called once during the entire lifetime of it.
inherited
register(XmppManagerAttributes attributes) → void
Registers the callbacks from XmppConnection with the manager
inherited
reply(StanzaHandlerData data, String type, List<XMLNode> children) Future<void>
Sends a reply of the stanza in data with type. Replaces the original stanza's children with children.
inherited
resetState() Future<void>
Resets the state such that a resumption is no longer possible without creating a new session. Primarily useful for clearing the state after disconnecting
runNonzaHandlers(XMLNode nonza) Future<bool>
Runs all NonzaHandlers of this Manager which match the nonza. Resolves to true if the nonza has been handled by one of the handlers. Resolves to false otherwise.
inherited
sendAckRequestPing() → void
Pings the connection open by send an ack request
setState(StreamManagementState state) Future<void>
shouldTriggerAckedEvent(Stanza stanza) bool
Called when a stanza has been acked to decide whether we should trigger a StanzaAckedEvent.
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited