ctrlX Data Layer .NET API  6.0.1
Loading...
Searching...
No Matches
IClient.cs
1using comm.datalayer;
2using System;
3using System.Threading.Tasks;
4
5namespace Datalayer
6{
10 public interface IClient : INativeDisposable
11 {
16
21 bool IsConnected { get; }
22
28
35
44
51
57 Task<IClientAsyncResult> PingAsync();
58
66 (DLR_RESULT result, IVariant value) Read(string address);
67
75 Task<IClientAsyncResult> ReadAsync(string address);
76
85 Task<IClientAsyncResult> ReadAsync(string address, IVariant args);
86
95 (DLR_RESULT result, IVariant value) Read(string address, IVariant args);
96
104 (DLR_RESULT result, IBulkItem[] items) BulkRead(string[] addresses);
105
115 (DLR_RESULT result, IBulkItem[] items) BulkRead(string[] addresses, IVariant[] args);
116
124 Task<IClientAsyncBulkResult> BulkReadAsync(string[] addresses);
125
135 Task<IClientAsyncBulkResult> BulkReadAsync(string[] addresses, IVariant[] args);
136
145 (DLR_RESULT result, IVariant value) ReadJson(string address, int indentStep = 0);
146
156 (DLR_RESULT result, IVariant value) ReadJson(string address, IVariant args, int indentStep = 0);
157
166 Task<IClientAsyncResult> ReadJsonAsync(string address, int indentStep = 0);
167
177 Task<IClientAsyncResult> ReadJsonAsync(string address, IVariant args, int indentStep = 0);
178
186 (DLR_RESULT result, IVariant value) ReadMetadata(string address);
187
195 Task<IClientAsyncResult> ReadMetadataAsync(string address);
196
204 (DLR_RESULT result, IBulkItem[] items) BulkReadMetadata(string[] addresses);
205
213 Task<IClientAsyncBulkResult> BulkReadMetadataAsync(string[] addresses);
214
223 DLR_RESULT Write(string address, IVariant writeValue);
224
233 Task<IClientAsyncResult> WriteAsync(string address, IVariant writeValue);
234
244 (DLR_RESULT result, IBulkItem[] items) BulkWrite(string[] addresses, IVariant[] writeValues);
245
255 Task<IClientAsyncBulkResult> BulkWriteAsync(string[] addresses, IVariant[] writeValues);
256
265 (DLR_RESULT, IVariant error) WriteJson(string address, string json);
266
275 Task<IClientAsyncResult> WriteJsonAsync(string address, string json);
276
284 (DLR_RESULT result, IVariant value) Browse(string address);
285
293 Task<IClientAsyncResult> BrowseAsync(string address);
294
302 (DLR_RESULT result, IBulkItem[] items) BulkBrowse(string[] addresses);
303
311 Task<IClientAsyncBulkResult> BulkBrowseAsync(string[] addresses);
312
321 (DLR_RESULT result, IVariant value) Create(string address, IVariant args);
322
338 Task<IClientAsyncResult> CreateAsync(string address, IVariant args);
339
348 (DLR_RESULT result, IBulkItem[] items) BulkCreate(string[] addresses, IVariant[] args);
349
358 Task<IClientAsyncBulkResult> BulkCreateAsync(string[] addresses, IVariant[] args);
359
367 DLR_RESULT Remove(string address);
368
376 Task<IClientAsyncResult> RemoveAsync(string address);
377
385 (DLR_RESULT result, IBulkItem[] items) BulkRemove(string[] addresses);
386
394 Task<IClientAsyncBulkResult> BulkRemoveAsync(string[] addresses);
395
415 (DLR_RESULT result, ISubscription subscription) CreateSubscription(SubscriptionPropertiesT subscriptionProperties, object userData = null);
416
439 (DLR_RESULT result, ISubscription subscription) CreateSubscription(IVariant subscriptionPropertiesFlatbuffers, object userData);
440
463 Task<ISubscriptionAsyncResult> CreateSubscriptionAsync(SubscriptionPropertiesT subscriptionProperties, object userData);
464
490 Task<ISubscriptionAsyncResult> CreateSubscriptionAsync(IVariant subscriptionPropertiesFlatbuffers, object userData);
491 }
492}
The IBulkItem interface.
Definition: IBulkItem.cs:9
The IClient interface.
Definition: IClient.cs:11
Task< IClientAsyncResult > ReadJsonAsync(string address, IVariant args, int indentStep=0)
Reads a node value as JSON with arguments asynchronously.
Task< IClientAsyncResult > CreateAsync(string address, IVariant args)
Creates a node with arguments asynchronously.
Task< IClientAsyncBulkResult > BulkReadAsync(string[] addresses)
Reads values from a list of nodes asynchronously.
DLR_RESULT
Writes a JSON value to a node.
Definition: IClient.cs:265
Task< IClientAsyncResult > ReadJsonAsync(string address, int indentStep=0)
Reads a node value as JSON asynchronously.
DLR_RESULT Remove(string address)
Removes a node.
Task< IClientAsyncBulkResult > BulkBrowseAsync(string[] addresses)
Browses a list of nodes asynchronously.
Task< IClientAsyncBulkResult > BulkRemoveAsync(string[] addresses)
Removes a list of nodes asynchronously.
Task< IClientAsyncBulkResult > BulkReadMetadataAsync(string[] addresses)
Reads the metadata from a list of nodes asynchronously.
Task< IClientAsyncResult > PingAsync()
Pings the remote asynchronously.
DLR_RESULT Ping()
Pings the remote.
Task< IClientAsyncBulkResult > BulkWriteAsync(string[] addresses, IVariant[] writeValues)
Writes a list of values to a list of nodes asynchronously.
Task< IClientAsyncBulkResult > BulkCreateAsync(string[] addresses, IVariant[] args)
Creates a list of nodes with arguments asynchronously.
Task< ISubscriptionAsyncResult > CreateSubscriptionAsync(IVariant subscriptionPropertiesFlatbuffers, object userData)
Creates an subscription asynchronously.
Task< IClientAsyncBulkResult > BulkReadAsync(string[] addresses, IVariant[] args)
Reads values from a list of nodes with arguments asynchronously.
Task< IClientAsyncResult > WriteAsync(string address, IVariant writeValue)
Writes a value to a node asynchronously.
DLR_RESULT result
Reads a node value.
Definition: IClient.cs:66
DLR_RESULT Write(string address, IVariant writeValue)
Writes the value to a node.
IVariant AuthToken
Gets the authentication token (JWT) as string.
Definition: IClient.cs:34
Task< IClientAsyncResult > WriteJsonAsync(string address, string json)
Writes a JSON value to a node asynchronously.
bool IsConnected
Checks the connection.
Definition: IClient.cs:21
Task< IClientAsyncResult > RemoveAsync(string address)
Removes a node asynchronously.
IDatalayerSystem System
Gets the system.
Definition: IClient.cs:15
Task< IClientAsyncResult > BrowseAsync(string address)
Browses a node asynchronously.
DLR_RESULT SetTimeout(DLR_TIMEOUT_SETTING timeout, uint value)
Sets the timeout of each request.
Task< IClientAsyncResult > ReadAsync(string address, IVariant args)
Reads a node value with arguments asynchronously.
Task< ISubscriptionAsyncResult > CreateSubscriptionAsync(SubscriptionPropertiesT subscriptionProperties, object userData)
Creates an subscription asynchronously.
DLR_RESULT ConnectionStatus
Gets the connection status.
Definition: IClient.cs:27
Task< IClientAsyncResult > ReadAsync(string address)
Reads a node value asynchronously.
Task< IClientAsyncResult > ReadMetadataAsync(string address)
Reads the metadata of a node asynchronously.
The IDatalayerSystem interface.
The INativeDisposable interface.
The ISubscription interface.
The IVariant interface.
Definition: IVariant.cs:10
DLR_RESULT
The result.
Definition: Enums.cs:153
DLR_TIMEOUT_SETTING
The timeout setting.
Definition: Enums.cs:117