SubscriptionSync Class Reference

Inheritance diagram for SubscriptionSync:

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)
Result	subscribe_multi (self, typing.List[str] address)
Result	unsubscribe (self, str address)
Result	unsubscribe_all (self)
Result	unsubscribe_multi (self, typing.List[str] address)

Detailed Description

SubscriptionSync.

Definition at line 20 of file subscription_sync.py.

Constructor & Destructor Documentation

__init__()

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

Parameters

[in]

client

Reference to the client

Definition at line 26 of file subscription_sync.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, SubscriptionSync.__mock, SubscriptionAsync.__ptr_notify, and SubscriptionSync.__ptr_notify.

Member Function Documentation

id()

str id

(

self

)

Subscription ID.

   @return <str> id

Reimplemented from Subscription.

Definition at line 56 of file subscription_sync.py.

References SubscriptionSync.__create_sub_callback(), ProviderSubscription.__id, SubscriptionAsync.__id, SubscriptionPropertiesBuilder.__id, SubscriptionSync.__id, SubscriptionSync.__mock, SubscriptionAsync.__ptr_notify, and SubscriptionSync.__ptr_notify.

Referenced by SubscriptionSync.subscribe(), SubscriptionAsync.subscribe(), SubscriptionSync.subscribe_multi(), SubscriptionAsync.subscribe_multi(), SubscriptionSync.unsubscribe(), SubscriptionAsync.unsubscribe(), SubscriptionSync.unsubscribe_all(), SubscriptionAsync.unsubscribe_all(), SubscriptionSync.unsubscribe_multi(), and SubscriptionAsync.unsubscribe_multi().

subscribe()

Result subscribe	(		self,
		str	address
	)

Adds a node to a subscription id.

Parameters

[in]

address

Address of a node, that should be added to the given subscription.

Returns

<Result> status of function call

Definition at line 135 of file subscription_sync.py.

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

subscribe_multi()

Result subscribe_multi	(		self,
		typing.List[str]	address
	)

Adds a list of nodes to a subscription id.

Parameters

[in]	address	List of Addresses of a node, that should be added to the given subscription.
[in]	count	Count of addresses.

Returns

<Result> status of function call

Definition at line 158 of file subscription_sync.py.

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

unsubscribe()

Result unsubscribe	(		self,
		str	address
	)

Removes a node from a subscription id.

Parameters

[in]

address

Address of a node, that should be removed to the given subscription.

Returns

<Result> status of function call

Definition at line 146 of file subscription_sync.py.

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

unsubscribe_all()

Result unsubscribe_all

(

self

)

Removes subscription id completely.

Returns

<Result> status of function call

Definition at line 181 of file subscription_sync.py.

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

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

unsubscribe_multi()

Result unsubscribe_multi	(		self,
		typing.List[str]	address
	)

Removes a set of nodes from a subscription id.

Parameters

[in]

address

Set of addresses of nodes, that should be removed to the given subscription.

Returns

<Result> status of function call

Definition at line 170 of file subscription_sync.py.

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