aiowamp.Client

class aiowamp.Client(session)

Initialise the client.

A client is just a wrapper for a session. It takes full control over the session, so when the client closes so will the session.

Parameters:session (SessionABC) – Session to wrap.

__init__(session)

Initialise the client.

A client is just a wrapper for a session. It takes full control over the session, so when the client closes so will the session.

Parameters:session (SessionABC) – Session to wrap. Return type:None

Methods

__init__(session)	Initialise the client.
call(procedure, *args[, kwargs, …])	Call a remote procedure.
close([details, reason])	Close the client and the underlying session.
get_registration_ids(procedure)	Get the ids of the registrations for the given procedure.
get_subscription_ids(topic)	Get the ids of the subscriptions for the given topic.
publish(topic, *args[, kwargs, acknowledge, …])	Publish an event to a topic.
register(procedure, handler, *[, …])	Register a procedure.
subscribe(topic, callback, *[, …])	Subscribe to a topic.
unregister(procedure[, registration_id])	Unregister a procedure.
unsubscribe(topic[, subscription_id])	Unsubscribe from the given topic.
wait_until_done()	Wait until the client is done.

Attributes

id_gen	ID generator used to generate the client ids.
session	Session the client is attached to.

__init__(session)

Initialise the client.

A client is just a wrapper for a session. It takes full control over the session, so when the client closes so will the session.

Parameters:session (SessionABC) – Session to wrap. Return type:None

session

Session the client is attached to.

id_gen

ID generator used to generate the client ids.

__repr__()

Return repr(self).

Return type:str

__str__()

Return str(self).

Return type:str

close(details=None, *, reason=None)

Close the client and the underlying session.

Parameters:

• details (Optional[Dict[str, ForwardRef]]) – Additional details to send with the close message.
• reason (Optional[str]) – URI denoting the reason for closing. Defaults to aiowamp.uri.CLOSE_NORMAL.

Return type:

None

publish(topic, *args, kwargs=None, acknowledge=None, blackwhitelist=None, exclude_me=None, disclose_me=None, resource_key=None, options=None)

Publish an event to a topic.

Parameters:

• topic (str) – Topic uri to publish to.
• *args – Arguments for the event.
• kwargs (Optional[Dict[str, ForwardRef]]) – Keyword arguments for the event.
• acknowledge (Optional[bool]) – Whether to wait for the router to acknowledge the event.
• blackwhitelist (Optional[BlackWhiteList]) – Black- and whitelisting subscribers.
• exclude_me (Optional[bool]) – Whether the client should receive this event.
• disclose_me (Optional[bool]) – Whether the client’s identity should be disclosed to subscribers.
• resource_key (Optional[str]) – Resource key for sharded subscriptions.
• options (Optional[Dict[str, ForwardRef]]) – Additional options.
• args (Union[int, str, bool, ForwardRef, ForwardRef]) –

Return type:

None

register(procedure, handler, *, disclose_caller=None, match_policy=None, invocation_policy=None, options=None)

Register a procedure.

Parameters:

• procedure (str) – Procedure URI to register.
• handler (Callable[[ForwardRef], Union[Awaitable[ForwardRef], AsyncGenerator[ForwardRef, None]]]) – Procedure to call.
• disclose_caller (Optional[bool]) – Whether callers’ identities should be disclosed.
• match_policy (Optional[NewType()(MatchPolicy, str)]) – Match policy for the procedure uri. Can also be specified by passing an aiowamp.URI with a match policy to the procedure.
• invocation_policy (Optional[NewType()(InvocationPolicy, str)]) – Invocation policy.
• options (Optional[Dict[str, ForwardRef]]) – Additional options to pass.

Return type:

int

Returns:

The registration id of the registered procedure. Can be used to unregister the procedure.

subscribe(topic, callback, *, match_policy=None, node_key=None, options=None)

Subscribe to a topic.

Parameters:

• topic (str) – Topic uri to subscribe to.
• callback (Callable[[ForwardRef], Union[Any, Awaitable[Any]]]) – Callable to call for each event.
• match_policy (Optional[NewType()(MatchPolicy, str)]) – Match policy for the uri. Can also be specified by passing an aiowamp.URI with a match policy.
• node_key (Optional[str]) – Node key for sharded subscriptions.
• options (Optional[Dict[str, ForwardRef]]) – Additional options to pass.

Return type:

int

unregister(procedure, registration_id=None)

Unregister a procedure.

Parameters:

• procedure (str) – Procedure uri to unregister.
• registration_id (Optional[int]) – Specific registration id to unregister. If not specified, ALL registrations for the procedure will be unregistered.

Raises:

KeyError – If no registration for the procedure exists.

Return type:

None

unsubscribe(topic, subscription_id=None)

Unsubscribe from the given topic.

Parameters:

• topic (str) – Topic URI to unsubscribe from.
• subscription_id (Optional[int]) – Specific subscription id to unsubscribe. If None, unsubscribe all subscriptions to the topic.

Raises:

KeyError – If not subscribed to the topic.

Return type:

None

wait_until_done()

Wait until the client is done.

Return type:None

get_registration_ids(procedure)

Get the ids of the registrations for the given procedure.

Parameters:procedure (str) – Procedure to get registration ids for. Return type:Tuple[int, …] Returns:Tuple containing the registration ids.

call(procedure, *args, kwargs=None, receive_progress=None, call_timeout=None, cancel_mode=None, disclose_me=None, resource_key=None, options=None)

Call a remote procedure.

Parameters:

• procedure (str) – Procedure uri to call.
• *args – Arguments to pass to the call.
• kwargs (Optional[Dict[str, ForwardRef]]) – Keyword arguments to pass to the call.
• receive_progress (Optional[bool]) – Whether the callee may send progress results.
• call_timeout (Optional[float]) – Timeout in seconds for the call.
• cancel_mode (Optional[NewType()(CancelMode, str)]) – Cancel mode to use when cancelling the call. See aiowamp.Call.cancel.
• disclose_me (Optional[bool]) – Whether to disclose the client to the callee.
• resource_key (Optional[str]) – Resource key for sharded registrations.
• options (Optional[Dict[str, ForwardRef]]) – Additional options to pass.
• args (Union[int, str, bool, ForwardRef, ForwardRef]) –

Return type:

CallABC

Returns:

The call instance to interact with the call.

get_subscription_ids(topic)

Get the ids of the subscriptions for the given topic.

Parameters:topic (str) – Topic to get subscription ids for. Return type:Tuple[int, …] Returns:Tuple of subscription ids.