Main classes

This section of the API covers the classes which are directly instantiated or used to communicate with an XMPP server.

• node — XMPP network nodes (clients, mostly)
  • Using XMPP
  • Connecting streams low-level
• stream — Stanza stream
  • Low-level stanza tracking
  • Filters
• stanza — XSOs for dealing with stanzas
  • Top-level classes
  • Payload classes
  • Exceptions
• security_layer — Implementations to negotiate stream security
  • Certificate verifiers
  • Partial security providers
  • Abstract base classes

Protocol part and XEP implementations

This section contains services (cf. aioxmpp.service) which can be summoned (cf. aioxmpp.node.AbstractClient.summon()) into a client, to extend its functionality or provide backwards compatibility.

• disco — Service discovery support (XEP-0030)
  • Service
  • disco.xso — IQ payloads
• entitycaps — Entity Capabilities support (XEP-0115)
  • Service
  • entitycaps.xso — Presence payload
• muc — Multi-User-Chat support (XEP-0045)
  • Using Multi-User-Chats
  • XSOs
• presence — Peer presence bookkeeping
• roster — RFC 6121 roster implementation
  • roster.xso — IQ payloads and stream feature
• rfc6120 – Stanza payloads for RFC 6120 implementation
• rfc3921 — XSOs for legacy protocol parts

Less common and helper classes

The modules in this section implement some of the tools which are used to provide the functionality of the main classes (such as aioxmpp.callbacks). In addition, classes and modules which are rarely used directly by basic clients (such as the aioxmpp.sasl module) are sorted into this section.

• structs — Simple data holders for common data types
  • Jabber IDs
  • Presence
  • Languages
• tracking — Interfaces for high-level message tracking
  • Interfaces
• nonza — Non-stanza stream-level XSOs (Nonzas)
  • General XSOs
  • StartTLS related XSOs
  • SASL related XSOs
  • Stream management related XSOs
• sasl – SASL helpers
• errors — Exception classes
  • Exception classes mapping to XMPP stream errors
  • Exception classes mapping to XMPP stanza errors
  • Stream negotiation exceptions
  • I18N exceptions
  • Other exceptions
• i18n – Helper functions for localizing text
  • Shorthand functions
• callbacks – Synchronous and asynchronous callbacks
  • Descriptor vs. ad-hoc
  • Class overview

APIs mainly relevant for extension developers

These APIs are used by many of the other modules, but detailed knowledge is usually required (for users of aioxmpp) only if extensions are to be developed.

• service — Utilities for implementing AbstractClient services
• xso — Working with XML stream contents
  • Terminology
  • General functions
  • Object declaration with aioxmpp.xso.model
  • Types and validators from types
  • Predefined XSO base classes