aiowamp

aiowamp is a client library for the WAMP protocol.

Functions

CancelMode(x)
InvocationPolicy(x)
MatchPolicy(x)
build_message_from_list(msg_list) Create a message from msg_list.
connect(url, *, realm[, serializer, keyring]) Connect to a router, join a realm, and create a client.
connect_raw_socket(*args, **kwargs)
rtype:RawSocketTransport
connect_transport(config) Connect a transport based on the config.
connect_web_socket(*args, **kwargs)
rtype:WebSocketTransport
error_to_exception(message)
param message:
exception_to_invocation_error(exc)
param exc:
get_message_cls(msg_type) Returns the message type registered for msg_type.
get_transport_factory(scheme) Get the registered transport factory for the scheme.
is_message_type(msg, msg_type) Checks whether msg is of type msg_type.
join_realm(transport, realm, *[, keyring, …]) Join a realm on a router.
message_as_type(msg, msg_type) Cast msg if it is of type msg_type.
register_error_response(uri, *[, match_policy])
param uri:
register_message_cls(*messages[, overwrite]) Register the messages.
register_transport_factory(*schemes[, overwrite]) Decorator for registering transport factories.
set_invocation_error(exc, err) Attach an invocation error to an exception.

Classes

AuthKeyring(*methods[, auth_id]) Initialise the keyring.
AuthKeyringABC Abstract keyring for auth methods.
AuthMethodABC Abstract auth method.
BlackWhiteList(*[, excluded_ids, …]) Data type for black- and whitelisting subscribers.
CRAuth(secret) Auth method for challenge response authentication.
Call(session, call, *, cancel_mode) Initialise the call.
CallABC Represents an ongoing call of a remote procedure.
Client(session) Initialise the client.
ClientABC WAMP Client.
CommonTransportConfig(url[, serializer, …]) Transport configuration used by transport factories.
IDGenerator() Sequential ID generator.
IDGeneratorABC Abstract WAMP ID generator type.
Invocation(session, client, msg, *, procedure) Create a new invocation instance.
InvocationABC Invocation context passed to a procedure.
InvocationProgress(*args, **kwargs) Helper class for procedures.
InvocationResult(*args, **kwargs) Helper class for procedures.
JSONSerializer(*[, decoder, encoder]) Serializer for the JSON format.
MessageABC Base class for WAMP messages.
MessagePackSerializer
RawSocketTransport(reader, writer, …) WAMP transport over raw sockets.
SerializerABC Serializer for messages.
Session(transport, session_id, realm, details, *)
param transport:
 
SessionABC Abstract session type.
SubscriptionEvent(client, msg, *, topic) Create a new SubscriptionEven instance.
SubscriptionEventABC Subscription event.
TicketAuth(ticket) Auth method for ticket-based authentication.
TransportABC Abstract transport type.
URI WAMP URI.
WebSocketTransport(ws_client, serializer, *, …) WAMP Transport over web socket.

Exceptions

AbortError(msg) Join abort error.
AuthError
BaseError Base exception for all WAMP related errors.
ClientClosed
ErrorResponse(message)
param message:
Interrupt(options)
param options:
InvalidMessage Exception for invalid messages.
InvocationError(uri, *args[, kwargs, details])
param uri:
TransportError Transport level error.
UnexpectedMessageError(received, expected) Exception raised when an unexpected message type is received.