SubscriptionAsync Class Reference

Inheritance diagram for SubscriptionAsync:

Public Member Functions
def	__init__ (self, ctrlxdatalayer.client.Client client)
def	__enter__ (self)
def	__exit__ (self, exc_type, exc_val, exc_tb)
def	close (self)
str	id (self)
def	on_close (self)
Result	subscribe (self, str address, ctrlxdatalayer.client.ResponseCallback cb, userData_c_void_p userdata=None)
Result	subscribe_multi (self, typing.List[str] address, ctrlxdatalayer.client.ResponseCallback cb, userData_c_void_p userdata=None)
Result	unsubscribe (self, str address, ctrlxdatalayer.client.ResponseCallback cb, userData_c_void_p userdata=None)
Result	unsubscribe_all (self, ctrlxdatalayer.client.ResponseCallback cb, userData_c_void_p userdata=None)
Result	unsubscribe_multi (self, typing.List[str] address, ctrlxdatalayer.client.ResponseCallback cb, userData_c_void_p userdata=None)
bool	wait_on_response_cb (self, int wait=5)

Detailed Description

SubscriptionAsync.

Definition at line 21 of file subscription_async.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
		ctrlxdatalayer.client.Client	client
	)

Parameters

[in]

client

Reference to the client

Definition at line 28 of file subscription_async.py.

References SubscriptionAsync.__client, SubscriptionSync.__client, Client.__closed, Provider.__closed, ProviderNode.__closed, SubscriptionAsync.__closed, SubscriptionSync.__closed, System.__closed, Variant.__closed, ProviderSubscription.__id, SubscriptionAsync.__id, SubscriptionPropertiesBuilder.__id, SubscriptionSync.__id, Bulk.__on_cb, SubscriptionAsync.__on_cb, SubscriptionAsync.__ptr_notify, SubscriptionSync.__ptr_notify, Bulk.__ptr_resp, and SubscriptionAsync.__ptr_resp.

Member Function Documentation

subscribe()

Result subscribe	(		self,
		str	address,
		ctrlxdatalayer.client.ResponseCallback	cb,
		userData_c_void_p	userdata = None
	)

Set up a subscription to a node.

Parameters

[in]	address	Address of the node to add a subscription to
[in]	callback	Callback to called when data is subscribed
[in]	userdata	User data - will be returned in callback as userdata. You can use this userdata to identify your request

Returns

<Result> status of function call

Definition at line 186 of file subscription_async.py.

References SubscriptionAsync.__client, SubscriptionSync.__client, SubscriptionAsync.__create_response_callback(), Bulk.__create_response_callback(), Subscription.id(), SubscriptionAsync.id(), and SubscriptionSync.id().

subscribe_multi()

Result subscribe_multi	(		self,
		typing.List[str]	address,
		ctrlxdatalayer.client.ResponseCallback	cb,
		userData_c_void_p	userdata = None
	)

Set up a subscription to multiple nodes.

Parameters

[in]	address	Set of addresses of nodes, that should be removed to the given subscription.
[in]	count	Count of addresses.
[in]	callback	Callback to called when data is subscribed
[in]	userdata	User data - will be returned in callback as userdata. You can use this userdata to identify your request

Returns

<Result> status of function call

Definition at line 221 of file subscription_async.py.

References SubscriptionAsync.__client, SubscriptionSync.__client, SubscriptionAsync.__create_response_callback(), Bulk.__create_response_callback(), Subscription.id(), SubscriptionAsync.id(), and SubscriptionSync.id().

unsubscribe()

Result unsubscribe	(		self,
		str	address,
		ctrlxdatalayer.client.ResponseCallback	cb,
		userData_c_void_p	userdata = None
	)

Removes a node from a subscription id.

Parameters

[in]	address	Address of a node, that should be removed to the given subscription.
[in]	callback	Callback to called when data is subscribed
[in]	userdata	User data - will be returned in callback as userdata. You can use this userdata to identify your request

Returns

<Result> status of function call

Definition at line 203 of file subscription_async.py.

References SubscriptionAsync.__client, SubscriptionSync.__client, SubscriptionAsync.__create_response_callback(), Bulk.__create_response_callback(), Subscription.id(), SubscriptionAsync.id(), and SubscriptionSync.id().

unsubscribe_all()

Result unsubscribe_all	(		self,
		ctrlxdatalayer.client.ResponseCallback	cb,
		userData_c_void_p	userdata = None
	)

Removes all subscriptions from a subscription id.

Parameters

[in]	callback	Callback to called when data is subscribed
[in]	userdata	User data - will be returned in callback as userdata. You can use this userdata to identify your request

Returns

<Result> status of function call

Definition at line 258 of file subscription_async.py.

References SubscriptionAsync.__client, SubscriptionSync.__client, SubscriptionAsync.__create_response_callback(), Bulk.__create_response_callback(), Subscription.id(), SubscriptionAsync.id(), and SubscriptionSync.id().

Referenced by SubscriptionAsync.close(), and SubscriptionSync.close().

unsubscribe_multi()

Result unsubscribe_multi	(		self,
		typing.List[str]	address,
		ctrlxdatalayer.client.ResponseCallback	cb,
		userData_c_void_p	userdata = None
	)

Removes a set of nodes from a subscription id.

Parameters

[in]	address	Address of a node, that should be removed to the given subscription.
[in]	callback	Callback to called when data is subscribed
[in]	userdata	User data - will be returned in callback as userdata. You can use this userdata to identify your request

Returns

<Result> status of function call

Definition at line 240 of file subscription_async.py.

References SubscriptionAsync.__client, SubscriptionSync.__client, SubscriptionAsync.__create_response_callback(), Bulk.__create_response_callback(), Subscription.id(), SubscriptionAsync.id(), and SubscriptionSync.id().