ISubscription Interface Reference

The subscription interface. More...

Inheritance diagram for ISubscription:

Public Member Functions
delegate void	DataChangedEventHandler (ISubscription subscription, IDataChangedEventArgs args)
	The DataChanged event delegate of the Subscription More...
DLR_RESULT	Subscribe (string address)
	Subscribes to a node More...
Task< ISubscriptionAsyncResult >	SubscribeAsync (string address)
	Subscribes to a node asynchronously More...
DLR_RESULT	SubscribeMulti (string[] addresses)
	Subscribes to a list of nodes More...
Task< ISubscriptionAsyncResult >	SubscribeMultiAsync (string[] addresses)
	Subscribes to a list of nodes asynchronously More...
DLR_RESULT	Unsubscribe (string address)
	Unsubscribes the node More...
DLR_RESULT	UnsubscribeAll ()
	Unsubscribes all subscribed nodes More...
Task< ISubscriptionAsyncResult >	UnsubscribeAllAsync ()
	Unsubscribes all subscribed nodes asynchronously. More...
Task< ISubscriptionAsyncResult >	UnsubscribeAsync (string address)
	Unsubscribes to a node asynchronously. More...
DLR_RESULT	UnsubscribeMulti (string[] addresses)
	Unsubscribes to a list of nodes More...
Task< ISubscriptionAsyncResult >	UnsubscribeMultiAsync (string[] addresses)
	Unsubscribes a list of nodes asynchronously. More...

Properties
IClient	Client [get]
	Gets the client. More...
string	Id [get]
	Gets the subscription id. More...
object	UserData [get]
	Gets the user data. More...
Properties inherited from INativeDisposable
bool	IsDisposed [get]
	Checks disposed More...

Events
DataChangedEventHandler	DataChanged
	The DataChanged event of the Subscription More...

Detailed Description

The subscription interface.

Definition at line 9 of file ISubscription.cs.

Member Function Documentation

DataChangedEventHandler()

delegate void DataChangedEventHandler	(	ISubscription	subscription,
		IDataChangedEventArgs	args
	)

The DataChanged event delegate of the Subscription

Parameters

subscription	The source subscription, which raises the event.
args	The data changed event arguments

Subscribe()

DLR_RESULT Subscribe

(

string

address

)

Subscribes to a node

Parameters

address

Address of the subscription

Returns

Result of the method call

Exceptions

ObjectDisposedException	Cannot access a disposed object
ArgumentNullException	Argument cannot be null.

Example

var builder = new FlatBuffers.FlatBufferBuilder(Variant.DefaultFlatbuffersInitialSize);
var properties = comm.datalayer.SubscriptionProperties.CreateSubscriptionProperties(
   builder: builder,
   idOffset: builder.CreateString("mySubscription"),
   keepaliveInterval: 10000,
   publishInterval: 1000,
   errorInterval: 10000);
builder.Finish(properties.Value);
var propertiesFlatbuffers = new Variant(builder);
 
// Create the Subscription
var(createResult, subscription) = client.CreateSubscription(propertiesFlatbuffers, userData: null); 
 
const string cpuLoad = "framework/metrics/system/cpu-utilisation-percent";
var subscribeResult = subscription.Subscribe(address: cpuLoad);

SubscribeAsync()

Task<ISubscriptionAsyncResult> SubscribeAsync

(

string

address

)

Subscribes to a node asynchronously

Parameters

address

Address of the subscription

Returns

Task

Exceptions

ObjectDisposedException	Cannot access a disposed object
ArgumentNullException	Argument cannot be null.

SubscribeMulti()

DLR_RESULT SubscribeMulti

(

string[]

addresses

)

Subscribes to a list of nodes

Parameters

addresses

An array of the addresses

Returns

Result of the method call

Exceptions

ObjectDisposedException	Cannot access a disposed object
ArgumentNullException	Argument cannot be null.

SubscribeMultiAsync()

Task<ISubscriptionAsyncResult> SubscribeMultiAsync

(

string[]

addresses

)

Subscribes to a list of nodes asynchronously

Parameters

addresses

An array of the addresses

Returns

Task

Exceptions

ObjectDisposedException	Cannot access a disposed object
ArgumentNullException	Argument cannot be null.

Unsubscribe()

DLR_RESULT Unsubscribe

(

string

address

)

Unsubscribes the node

Parameters

address

Address of the subscription

Returns

Result of the method call

Exceptions

ObjectDisposedException	Cannot access a disposed object
ArgumentNullException	Argument cannot be null.

UnsubscribeAll()

DLR_RESULT UnsubscribeAll

(

)

Unsubscribes all subscribed nodes

Returns

Result of the method call

Exceptions

ObjectDisposedException

Cannot access a disposed object

UnsubscribeAllAsync()

Task<ISubscriptionAsyncResult> UnsubscribeAllAsync

(

)

Unsubscribes all subscribed nodes asynchronously.

Returns

Task

Exceptions

ObjectDisposedException

Cannot access a disposed object

UnsubscribeAsync()

Task<ISubscriptionAsyncResult> UnsubscribeAsync

(

string

address

)

Unsubscribes to a node asynchronously.

Parameters

address

Address of the subscription

Returns

Result of the method call

Exceptions

ObjectDisposedException	Cannot access a disposed object
ArgumentNullException	Argument cannot be null.

UnsubscribeMulti()

DLR_RESULT UnsubscribeMulti

(

string[]

addresses

)

Unsubscribes to a list of nodes

Parameters

addresses

An array of the addresses

Returns

Result of the method call

Exceptions

ObjectDisposedException	Cannot access a disposed object
ArgumentNullException	Argument cannot be null.

UnsubscribeMultiAsync()

Task<ISubscriptionAsyncResult> UnsubscribeMultiAsync

(

string[]

addresses

)

Unsubscribes a list of nodes asynchronously.

Parameters

addresses

An array of the addresses

Returns

Task

Exceptions

ObjectDisposedException	Cannot access a disposed object
ArgumentNullException	Argument cannot be null.

Property Documentation

Client

IClient Client

get

Gets the client.

Definition at line 14 of file ISubscription.cs.

Id

string Id

get

Gets the subscription id.

Definition at line 19 of file ISubscription.cs.

UserData

object UserData

get

Gets the user data.

Definition at line 24 of file ISubscription.cs.

Event Documentation

DataChanged

DataChangedEventHandler DataChanged

The DataChanged event of the Subscription

Definition at line 36 of file ISubscription.cs.

---

The documentation for this interface was generated from the following file:

• D:/Jenkins/workspace/sdk.datalayer.csharp/datalayer/ISubscription.cs