ctrlX Data Layer .NET API  4.3.0
Loading...
Searching...
No Matches
IClient.cs
1using System;
2using System.Threading.Tasks;
3
4namespace Datalayer
5{
9 public interface IClient : INativeDisposable
10 {
15
20 bool IsConnected { get; }
21
27
34
43
50
56 Task<IClientAsyncResult> PingAsync();
57
65 (DLR_RESULT result, IVariant value) Read(string address);
66
74 Task<IClientAsyncResult> ReadAsync(string address);
75
84 Task<IClientAsyncResult> ReadAsync(string address, IVariant args);
85
94 (DLR_RESULT result, IVariant value) Read(string address, IVariant args);
95
103
104 //[Obsolete("Please use the corresponding bulk method.")]
105 (DLR_RESULT[] result, IVariant[] value) ReadMulti(string[] addresses);
106
114 (DLR_RESULT result, IBulkItem[] items) BulkRead(string[] addresses);
115
125 (DLR_RESULT result, IBulkItem[] items) BulkRead(string[] addresses, IVariant[] args);
126
134 Task<IClientAsyncBulkResult> BulkReadAsync(string[] addresses);
135
145 Task<IClientAsyncBulkResult> BulkReadAsync(string[] addresses, IVariant[] args);
146
154 //[Obsolete("Please use the corresponding bulk method.")]
155 Task<IClientAsyncResult[]> ReadMultiAsync(string[] addresses);
156
165 (DLR_RESULT result, IVariant value) ReadJson(string address, int indentStep = 0);
166
176 (DLR_RESULT result, IVariant value) ReadJson(string address, IVariant args, int indentStep = 0);
177
186 Task<IClientAsyncResult> ReadJsonAsync(string address, int indentStep = 0);
187
197 Task<IClientAsyncResult> ReadJsonAsync(string address, IVariant args, int indentStep = 0);
198
206 (DLR_RESULT result, IVariant value) ReadMetadata(string address);
207
215 Task<IClientAsyncResult> ReadMetadataAsync(string address);
216
224 (DLR_RESULT result, IBulkItem[] items) BulkReadMetadata(string[] addresses);
225
233 Task<IClientAsyncBulkResult> BulkReadMetadataAsync(string[] addresses);
234
243 DLR_RESULT Write(string address, IVariant writeValue);
244
253 Task<IClientAsyncResult> WriteAsync(string address, IVariant writeValue);
254
264 //[Obsolete("Please use the corresponding bulk method.")]
265 DLR_RESULT[] WriteMulti(string[] addresses, IVariant[] writeValues);
266
276 //[Obsolete("Please use the corresponding bulk method.")]
277 Task<IClientAsyncResult[]> WriteMultiAsync(string[] addresses, IVariant[] writeValues);
278
288 (DLR_RESULT result, IBulkItem[] items) BulkWrite(string[] addresses, IVariant[] writeValues);
289
299 Task<IClientAsyncBulkResult> BulkWriteAsync(string[] addresses, IVariant[] writeValues);
300
309 (DLR_RESULT, IVariant error) WriteJson(string address, string json);
310
319 Task<IClientAsyncResult> WriteJsonAsync(string address, string json);
320
328 (DLR_RESULT result, IVariant value) Browse(string address);
329
337 Task<IClientAsyncResult> BrowseAsync(string address);
338
346 (DLR_RESULT result, IBulkItem[] items) BulkBrowse(string[] addresses);
347
355 Task<IClientAsyncBulkResult> BulkBrowseAsync(string[] addresses);
356
365 (DLR_RESULT result, IVariant value) Create(string address, IVariant args);
366
382 Task<IClientAsyncResult> CreateAsync(string address, IVariant args);
383
392 (DLR_RESULT result, IBulkItem[] items) BulkCreate(string[] addresses, IVariant[] args);
393
402 Task<IClientAsyncBulkResult> BulkCreateAsync(string[] addresses, IVariant[] args);
403
411 DLR_RESULT Remove(string address);
412
420 Task<IClientAsyncResult> RemoveAsync(string address);
421
429 (DLR_RESULT result, IBulkItem[] items) BulkRemove(string[] addresses);
430
438 Task<IClientAsyncBulkResult> BulkRemoveAsync(string[] addresses);
439
448 (DLR_RESULT result, ISubscription subscription) CreateSubscription(IVariant subscriptionPropertiesFlatbuffers, object userData);
449
475 Task<ISubscriptionAsyncResult> CreateSubscriptionAsync(IVariant subscriptionPropertiesFlatbuffers, object userData);
476 }
477}
The IBulkItem interface.
Definition: IBulkItem.cs:9
The IClient interface.
Definition: IClient.cs:10
Task< IClientAsyncResult > ReadJsonAsync(string address, IVariant args, int indentStep=0)
Reads a node value as JSON with arguments asynchronously.
DLR_RESULT[] result
Reads values from a list of nodes.
Definition: IClient.cs:105
Task< IClientAsyncResult > CreateAsync(string address, IVariant args)
Creates a node with arguments asynchronously.
DLR_RESULT[] WriteMulti(string[] addresses, IVariant[] writeValues)
Writes a list of values to a list of nodes.
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:309
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< IClientAsyncResult[]> ReadMultiAsync(string[] addresses)
Reads values from a list of nodes 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:65
DLR_RESULT Write(string address, IVariant writeValue)
Writes the value to a node.
Task< IClientAsyncResult[]> WriteMultiAsync(string[] addresses, IVariant[] writeValues)
Writes a list of values to a list of nodes asynchronously.
IVariant AuthToken
Gets the authentication token (JWT) as string.
Definition: IClient.cs:33
Task< IClientAsyncResult > WriteJsonAsync(string address, string json)
Writes a JSON value to a node asynchronously.
bool IsConnected
Checks the connection.
Definition: IClient.cs:20
Task< IClientAsyncResult > RemoveAsync(string address)
Removes a node asynchronously.
IDatalayerSystem System
Gets the system.
Definition: IClient.cs:14
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.
DLR_RESULT ConnectionStatus
Gets the connection status.
Definition: IClient.cs:26
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