stream_xsos — Non-stanza stream-level XSOs

This module contains XSO models for stream-level elements which are not stanzas.

General XSOs

class aioxmpp.stream_xsos.StreamError

XSO representing a stream error.

text

The text content of the stream error.

condition

The RFC 6120 stream error condition.

class aioxmpp.stream_xsos.StreamFeatures

XSO for collecting the supported stream features the remote advertises.

To register a stream feature, use register_child() with the features descriptor. A more fancy way to do the same thing is to use the as_feature_class() classmethod as decorator for your feature XSO class.

Adding new feature classes:

classmethod as_feature_class(other_cls)

Querying features:

stream_features[FeatureClass]

Obtain the first feature XSO which matches the FeatureClass. If no such XSO is contained in the StreamFeatures instance stream_features, KeyError is raised.

stream_features[FeatureClass] = feature

Replace the stream features belonging to the given FeatureClass with the feature XSO.

If the FeatureClass does not match the type of the feature XSO, a TypeError is raised.

It is legal to leave the FeatureClass out by specifying ... instead. In that case, the class is auto-detected from the feature object assigned.

del stream_features[FeatureClass]

If any feature of the given FeatureClass type is in the stream_features, they are all removed.

Otherwise, KeyError is raised, to stay consistent with other mapping-like types.

get_feature(feature_cls, default=None)

If a feature of the given feature_cls type is contained in the current stream features set, the first such instance is returned.

Otherwise, default is returned.

has_feature(feature_cls)

Return True if the stream features contain a feature of the given feature_cls type. False is returned otherwise.

Stream management related XSOs

class aioxmpp.stream_xsos.SMXSO

Base class for stream-management related XSOs.

This base class merely defines the namespaces to declare when serializing the data.

class aioxmpp.stream_xsos.SMRequest

A request for an SM acknowledgement (see SMAcknowledgement).

class aioxmpp.stream_xsos.SMAcknowledgement

Response to a SMRequest.

counter

The counter as received by the remote side.

class aioxmpp.stream_xsos.SMEnable

Request to enable stream management.

resume

Set this to True to request the capability of resuming the stream later.

class aioxmpp.stream_xsos.SMEnabled

Response to a SMEnable request.

resume

If True, the peer allows resumption of the stream.

id_

The SM-ID of the stream. This is required to resume later.

location

A hostname-port pair which defines to which host the client shall connect to resume the stream.

class aioxmpp.stream_xsos.SMResume

Request resumption of a previously interrupted SM stream.

counter

Set this to the value of the local incoming stanza counter.

previd

Set this to the SM-ID, as received in SMEnabled.

class aioxmpp.stream_xsos.SMResumed

Notification that SM resumption was successful, in response to SMResume.

counter

The stanza counter of the remote side.

previd

The SM-ID of the stream.