ctrlX Data Layer API for .NET 5  2.1.0
ISubscription.cs
1 using System;
2 using System.Threading.Tasks;
3 
4 namespace Datalayer
5 {
9  public interface ISubscription : INativeDisposable
10  {
14  IClient Client { get; }
15 
19  string Id { get; }
20 
24  object UserData { get; }
25 
31  delegate void DataChangedEventHandler(ISubscription subscription, IDataChangedEventArgs args);
32 
37 
65  DLR_RESULT Subscribe(string address);
66 
74  DLR_RESULT SubscribeMulti(string[] addresses);
75 
83  Task<ISubscriptionAsyncResult> SubscribeAsync(string address);
84 
92  Task<ISubscriptionAsyncResult> SubscribeMultiAsync(string[] addresses);
93 
101  DLR_RESULT Unsubscribe(string address);
102 
110  DLR_RESULT UnsubscribeMulti(string[] addresses);
111 
118 
126  Task<ISubscriptionAsyncResult> UnsubscribeAsync(string address);
127 
135  Task<ISubscriptionAsyncResult> UnsubscribeMultiAsync(string[] addresses);
136 
142  Task<ISubscriptionAsyncResult> UnsubscribeAllAsync();
143  }
144 }
Datalayer.ISubscription.Id
string Id
Gets the subscription id.
Definition: ISubscription.cs:19
Datalayer.ISubscription.UserData
object UserData
Gets the user data.
Definition: ISubscription.cs:24
Datalayer.ISubscription.UnsubscribeAsync
Task< ISubscriptionAsyncResult > UnsubscribeAsync(string address)
Unsubscribes to a node asynchronously.
Datalayer.ISubscription.SubscribeMulti
DLR_RESULT SubscribeMulti(string[] addresses)
Subscribes to a list of nodes
Datalayer.ISubscription.UnsubscribeMultiAsync
Task< ISubscriptionAsyncResult > UnsubscribeMultiAsync(string[] addresses)
Unsubscribes a list of nodes asynchronously.
Datalayer.IClient
The client interface.
Definition: IClient.cs:9
Datalayer.DLR_RESULT
DLR_RESULT
DLR_RESULT
Definition: Enums.cs:63
Datalayer.ISubscription.DataChangedEventHandler
delegate void DataChangedEventHandler(ISubscription subscription, IDataChangedEventArgs args)
The DataChanged event delegate of the Subscription
Datalayer.ISubscription.DataChanged
DataChangedEventHandler DataChanged
The DataChanged event of the Subscription
Definition: ISubscription.cs:36
Datalayer.ISubscription.SubscribeAsync
Task< ISubscriptionAsyncResult > SubscribeAsync(string address)
Subscribes to a node asynchronously
Datalayer.INativeDisposable
The native disposable interface
Definition: INativeDisposable.cs:8
Datalayer.ISubscription.Subscribe
DLR_RESULT Subscribe(string address)
Subscribes to a node
Datalayer.ISubscription.UnsubscribeAll
DLR_RESULT UnsubscribeAll()
Unsubscribes all subscribed nodes
Datalayer.IDataChangedEventArgs
The subscription's data changed event interface
Definition: IDataChangedEventArgs.cs:6
Datalayer
Definition: DatalayerSystem.cs:5
Datalayer.ISubscription.UnsubscribeAllAsync
Task< ISubscriptionAsyncResult > UnsubscribeAllAsync()
Unsubscribes all subscribed nodes asynchronously.
Datalayer.ISubscription.Client
IClient Client
Gets the client.
Definition: ISubscription.cs:14
Datalayer.ISubscription.SubscribeMultiAsync
Task< ISubscriptionAsyncResult > SubscribeMultiAsync(string[] addresses)
Subscribes to a list of nodes asynchronously
Datalayer.ISubscription.UnsubscribeMulti
DLR_RESULT UnsubscribeMulti(string[] addresses)
Unsubscribes to a list of nodes
Datalayer.ISubscription
The subscription interface.
Definition: ISubscription.cs:9
Datalayer.ISubscription.Unsubscribe
DLR_RESULT Unsubscribe(string address)
Unsubscribes the node