SubscriptionSync Class Reference

Inheritance diagram for SubscriptionSync:

Public Member Functions
def	__init__ (self, datalayer.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 19 of file subscription_sync.py.

Constructor & Destructor Documentation

__init__()

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

Parameters

[in]

client

Reference to the client

Definition at line 25 of file subscription_sync.py.

References SubscriptionSync.__client, SubscriptionAsync.__client, Provider.__closed, SubscriptionSync.__closed, SubscriptionAsync.__closed, Client.__closed, ProviderNode.__closed, SubscriptionSync.__id, SubscriptionAsync.__id, SubscriptionSync.__ptr_notify, and SubscriptionAsync.__ptr_notify.

Member Function Documentation

id()

str id

(

self

)

Subscription ID.

   @return <str> id

Reimplemented from Subscription.

Definition at line 54 of file subscription_sync.py.

References SubscriptionSync.__create_sub_callback(), SubscriptionSync.__id, SubscriptionAsync.__id, SubscriptionSync.__ptr_notify, and SubscriptionAsync.__ptr_notify.

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 130 of file subscription_sync.py.

References SubscriptionSync.__client, SubscriptionAsync.__client, and Subscription.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 153 of file subscription_sync.py.

References SubscriptionSync.__client, SubscriptionAsync.__client, and Subscription.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 141 of file subscription_sync.py.

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

unsubscribe_all()

Result unsubscribe_all

(

self

)

Removes subscription id completely.

Returns

<Result> status of function call

Definition at line 176 of file subscription_sync.py.

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

Referenced by 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 165 of file subscription_sync.py.

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