ctrlX Data Layer API for .NET 5  2.1.0
IClient.cs
1 using System;
2 using System.Threading.Tasks;
3 
4 namespace Datalayer
5 {
9  public interface IClient : INativeDisposable
10  {
15 
20  bool IsConnected { get; }
21 
28 
36  DLR_RESULT SetTimeout(DLR_TIMEOUT_SETTING timeout, uint value);
37 
43  DLR_RESULT Ping();
44 
52  (DLR_RESULT result, IVariant value) Browse(string address);
53 
62  DLR_RESULT Write(string address, IVariant writeValue);
63 
72  (DLR_RESULT, IVariant error) WriteJson(string address, string json);
73 
81  (DLR_RESULT result, IVariant value) Read(string address);
82 
91  (DLR_RESULT result, IVariant value) Read(string address, IVariant args);
92 
101  (DLR_RESULT result, IVariant value) ReadJson(string address, int indentStep = 0);
102 
110  (DLR_RESULT result, IVariant value) ReadMetadata(string address);
111 
120  DLR_RESULT Create(string address, IVariant args);
121 
129  DLR_RESULT Remove(string address);
130 
136  Task<IClientAsyncResult> PingAsync();
137 
153  Task<IClientAsyncResult> CreateAsync(string address, IVariant args);
154 
162  Task<IClientAsyncResult> RemoveAsync(string address);
163 
171  Task<IClientAsyncResult> BrowseAsync(string address);
172 
180  Task<IClientAsyncResult> ReadAsync(string address);
181 
190  Task<IClientAsyncResult> ReadAsync(string address, IVariant args);
191 
200  Task<IClientAsyncResult> WriteAsync(string address, IVariant writeValue);
201 
209  Task<IClientAsyncResult> ReadMetadataAsync(string address);
210 
219  (DLR_RESULT result, ISubscription subscription) CreateSubscription(IVariant subscriptionPropertiesFlatbuffers, object userData);
220 
246  Task<ISubscriptionAsyncResult> CreateSubscriptionAsync(IVariant subscriptionPropertiesFlatbuffers, object userData);
247  }
248 }
Datalayer.IClient.AuthToken
IVariant AuthToken
Gets the authentication token (JWT) as string.
Definition: IClient.cs:27
Datalayer.IClient.Ping
DLR_RESULT Ping()
Pings the remote.
Datalayer.IDatalayerSystem
The datalayer system interface.
Definition: IDatalayerSystem.cs:8
Datalayer.IClient.Write
DLR_RESULT Write(string address, IVariant writeValue)
Writes the value to a node.
Datalayer.IClient.CreateSubscriptionAsync
Task< ISubscriptionAsyncResult > CreateSubscriptionAsync(IVariant subscriptionPropertiesFlatbuffers, object userData)
Creates an asynchronously subscription.
Datalayer.IClient.Remove
DLR_RESULT Remove(string address)
Removes a node.
Datalayer.IClient.ReadMetadataAsync
Task< IClientAsyncResult > ReadMetadataAsync(string address)
Reads the metadata of a node asynchronously.
Datalayer.IClient.System
IDatalayerSystem System
Gets the system.
Definition: IClient.cs:14
Datalayer.DLR_TIMEOUT_SETTING
DLR_TIMEOUT_SETTING
DLR_TIMEOUT_SETTING
Definition: Enums.cs:41
Datalayer.IClient
The client interface.
Definition: IClient.cs:9
Datalayer.DLR_RESULT
DLR_RESULT
DLR_RESULT
Definition: Enums.cs:63
Datalayer.IClient.Create
DLR_RESULT Create(string address, IVariant args)
Creates a node with arguments.
Datalayer.IClient.ReadAsync
Task< IClientAsyncResult > ReadAsync(string address)
Reads a node value asynchronously.
Datalayer.INativeDisposable
The native disposable interface
Definition: INativeDisposable.cs:8
Datalayer.IClient.BrowseAsync
Task< IClientAsyncResult > BrowseAsync(string address)
Browses a node asynchronously.
Datalayer.IClient.IsConnected
bool IsConnected
Checks the connection.
Definition: IClient.cs:20
Datalayer.IClient.WriteAsync
Task< IClientAsyncResult > WriteAsync(string address, IVariant writeValue)
Writes a value to a node asynchronously.
Datalayer
Definition: DatalayerSystem.cs:5
Datalayer.IClient.DLR_RESULT
DLR_RESULT
Writes a JSON value to a node.
Definition: IClient.cs:72
Datalayer.ISubscription
The subscription interface.
Definition: ISubscription.cs:9
Datalayer.IClient.SetTimeout
DLR_RESULT SetTimeout(DLR_TIMEOUT_SETTING timeout, uint value)
Sets the timeout of each request.
Datalayer.IClient.PingAsync
Task< IClientAsyncResult > PingAsync()
Pings the remote asynchronously.
Datalayer.IClient.CreateAsync
Task< IClientAsyncResult > CreateAsync(string address, IVariant args)
Creates a node asynchronously with arguments.
Datalayer.IVariant
The variant interface.
Definition: IVariant.cs:9
Datalayer.IClient.RemoveAsync
Task< IClientAsyncResult > RemoveAsync(string address)
Removes a node asynchronously.
Datalayer.IClient.result
DLR_RESULT result
Browses a node.
Definition: IClient.cs:52