echox library

Serves as the foundation for establishing and managing XMPP (Extensible Messaging and Presence Protocol) connections.

Classes

EchoBuilder

This class represents a builder for creating XML elements using Echotils helper methods. It provides methods for constructing the XML tree and manipulating the current node.

Echotils

A utility class for various EchoX-related operations.

EchoX

Serves as the foundation for establishing and managing XMPP (Extensible Messaging and Presence Protocol) connections. It extends the EventEmitter class, allowing to interact with and respond to various events that occur during the XMPP communication lifecycle.

Extension

Abstract base class for XMPP server plugins to work in the associate of EchoX package.

Handler

Private helper class for managing stanza handlers.

JabberID

Represents a Jabber ID, which consists of a local part, a domain part, and an optional resource part. Provides methods to manipulate Jabber IDs and manage their components.

SASLAnonymous

This class extends the SASL and implements test method to check if authentication mechanism is able to run. This class implements SASL ANONYMOUS mechanism, which does not require any authentication credentials from the client.

SASLExternal

The EXTERNAL mechanism allows a client to request the server to use credentials established by means external to the mechanism to authenticate the cient. The EXTERNAL means may be, for instance, TSL services.

SASLOAuthBearer

This class represents the implementation of the SASL OAuthBearer authentication mechanism. It extend sthe SASL class and overrides its test and onChallenge methods.

SASLPlain

Implements the PLAIN SASL authentication mechanism.

SASLSHA1

The SASLSHA1 class is a concrete implementation of the SASL abstract class, which provides a framework for implementing different SASL mechanisms. This class specifically implements the SCRAM-SHA-1 mechanism, which is a SASL authentication mechanism that uses the Secure Hash Algorithm 1 (SHA-1) to provide message authentication.

SASLSHA256

The SASLSHA256 class is a concrete implementation of the SASL abstract class, which provides a framework for implementing different SASL mechanisms. This class specifically implements the SCRAM-SHA-256 mechanism, which is a SASL authentication mechanism that uses the Secure Hash Algorithm 256 (SHA-256) to provide message authentication.

SASLSHA384

The SASLSHA384 class is a concrete implementation of the SASL abstract class, which provides a framework for implementing different SASL mechanisms. This class specifically implements the SCRAM-SHA-384 mechanism, which is a SASL authentication mechanism that uses the Secure Hash Algorithm 384 (SHA-384) to provide message authentication.

SASLSHA512

This class is a sub-class of the SASL class and provides a Secure Challenge Response Authentication Mechanism (SCRAM) implementation for the SHA-512 hash algorithm.

SASLXOAuth2

Provides authentication using an OAuth2 token.

Scram

Scram is a singleton class used for the SCRAM (Saited Challenge Response Authentication Mechanism) authentication in the XMPP protocol. It has a private constructor and a factory method that returns the constant instance of the class.

StatusEmitter

Helps to emit status information.

WebSocketProtocol

WebSocket connection handler class.

Enums

EchoStatus

All possible statuses enumerated, for further information please refer to status constant.

Functions

debug(EchoX echox, {bool enableInfo = true, bool enableStatus = true, bool enableError = false}) → void

Sets up debugging for EchoX instance.

Exceptions / Errors

ArgumentMishap

An exception representing a mishap related to function arguments.

EchoException

The given given class is a custom written Exception class for EchoX.

EstablishSessionMishap

An exception representing session establishment mishaps.

ResourceBindingMishap

An exception representing resource binding mishaps.

SessionResultMishap

An exception representing session creation mishaps.

TransportException

A custom Exception class to indicate that there is no protocol defined for the given service or URL.

WebSocketMishap

An exception representing WebSocket-related mishaps.