The IClient interface. More...

Inheritance diagram for IClient:

Public Member Functions
DLR_RESULT IVariant value	Browse (string address)

Task< IClientAsyncResult >	BrowseAsync (string address)
	Browses a node asynchronously.

DLR_RESULT IBulkItem[] items	BulkBrowse (string[] addresses)

Task< IClientAsyncBulkResult >	BulkBrowseAsync (string[] addresses)
	Browses a list of nodes asynchronously.

DLR_RESULT IBulkItem[] items	BulkCreate (string[] addresses, IVariant[] args)

Task< IClientAsyncBulkResult >	BulkCreateAsync (string[] addresses, IVariant[] args)
	Creates a list of nodes with arguments asynchronously.

DLR_RESULT IBulkItem[] items	BulkRead (string[] addresses)

DLR_RESULT IBulkItem[] items	BulkRead (string[] addresses, IVariant[] args)

Task< IClientAsyncBulkResult >	BulkReadAsync (string[] addresses)
	Reads values from a list of nodes asynchronously.

Task< IClientAsyncBulkResult >	BulkReadAsync (string[] addresses, IVariant[] args)
	Reads values from a list of nodes with arguments asynchronously.

DLR_RESULT IBulkItem[] items	BulkReadMetadata (string[] addresses)

Task< IClientAsyncBulkResult >	BulkReadMetadataAsync (string[] addresses)
	Reads the metadata from a list of nodes asynchronously.

DLR_RESULT IBulkItem[] items	BulkRemove (string[] addresses)

Task< IClientAsyncBulkResult >	BulkRemoveAsync (string[] addresses)
	Removes a list of nodes asynchronously.

DLR_RESULT IBulkItem[] items	BulkWrite (string[] addresses, IVariant[] writeValues)

Task< IClientAsyncBulkResult >	BulkWriteAsync (string[] addresses, IVariant[] writeValues)
	Writes a list of values to a list of nodes asynchronously.

DLR_RESULT IVariant value	Create (string address, IVariant args)

Task< IClientAsyncResult >	CreateAsync (string address, IVariant args)
	Creates a node with arguments asynchronously.

DLR_RESULT ISubscription subscription	CreateSubscription (IVariant subscriptionPropertiesFlatbuffers, object userData)

DLR_RESULT ISubscription subscription	CreateSubscription (SubscriptionPropertiesT subscriptionProperties, object userData=null)

Task< ISubscriptionAsyncResult >	CreateSubscriptionAsync (IVariant subscriptionPropertiesFlatbuffers, object userData)
	Creates an subscription asynchronously.

Task< ISubscriptionAsyncResult >	CreateSubscriptionAsync (SubscriptionPropertiesT subscriptionProperties, object userData)
	Creates an subscription asynchronously.

DLR_RESULT	Ping ()
	Pings the remote.

Task< IClientAsyncResult >	PingAsync ()
	Pings the remote asynchronously.

DLR_RESULT IVariant value	Read (string address)

DLR_RESULT IVariant value	Read (string address, IVariant args)

Task< IClientAsyncResult >	ReadAsync (string address)
	Reads a node value asynchronously.

Task< IClientAsyncResult >	ReadAsync (string address, IVariant args)
	Reads a node value with arguments asynchronously.

DLR_RESULT IVariant value	ReadJson (string address, int indentStep=0)

DLR_RESULT IVariant value	ReadJson (string address, IVariant args, int indentStep=0)

Task< IClientAsyncResult >	ReadJsonAsync (string address, int indentStep=0)
	Reads a node value as JSON asynchronously.

Task< IClientAsyncResult >	ReadJsonAsync (string address, IVariant args, int indentStep=0)
	Reads a node value as JSON with arguments asynchronously.

DLR_RESULT IVariant value	ReadMetadata (string address)

Task< IClientAsyncResult >	ReadMetadataAsync (string address)
	Reads the metadata of a node asynchronously.

DLR_RESULT	Remove (string address)
	Removes a node.

Task< IClientAsyncResult >	RemoveAsync (string address)
	Removes a node asynchronously.

DLR_RESULT	SetTimeout (DLR_TIMEOUT_SETTING timeout, uint value)
	Sets the timeout of each request.

DLR_RESULT	Write (string address, IVariant writeValue)
	Writes the value to a node.

Task< IClientAsyncResult >	WriteAsync (string address, IVariant writeValue)
	Writes a value to a node asynchronously.

IVariant error	WriteJson (string address, string json)

Task< IClientAsyncResult >	WriteJsonAsync (string address, string json)
	Writes a JSON value to a node asynchronously.

Public Attributes
	DLR_RESULT
	Writes a JSON value to a node.

DLR_RESULT	result
	Reads a node value.

Properties
IVariant	AuthToken `[get]`
	Gets the authentication token (JWT) as string.

DLR_RESULT	ConnectionStatus `[get]`
	Gets the connection status.

bool	IsConnected `[get]`
	Checks the connection.

IDatalayerSystem	System `[get]`
	Gets the system.

Properties inherited from INativeDisposable
bool	IsDisposed `[get]`
	Checks disposed.

Detailed Description

The IClient interface.

Definition at line 10 of file IClient.cs.

Member Function Documentation

◆ BrowseAsync()

Task< IClientAsyncResult > BrowseAsync ( string address )

Browses a node asynchronously.

Parameters

address Address of the node.

Returns: The task.

Exceptions

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

◆ BulkBrowseAsync()

Task< IClientAsyncBulkResult > BulkBrowseAsync ( string[] addresses )

Browses a list of nodes asynchronously.

Parameters

addresses Address of the nodes.

Returns: The task.

Exceptions

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

◆ BulkCreateAsync()

Task< IClientAsyncBulkResult > BulkCreateAsync	(	string[]	addresses,
		IVariant[]	args
	)

Creates a list of nodes with arguments asynchronously.

Parameters

addresses	Addresses of the nodes.
args	Request arguments.

Returns: The task.

Exceptions

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

◆ BulkReadAsync() [1/2]

Task< IClientAsyncBulkResult > BulkReadAsync ( string[] addresses )

Reads values from a list of nodes asynchronously.

Parameters

addresses Addresses of the nodes.

Returns: The task.

Exceptions

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

◆ BulkReadAsync() [2/2]

Task< IClientAsyncBulkResult > BulkReadAsync	(	string[]	addresses,
		IVariant[]	args
	)

Reads values from a list of nodes with arguments asynchronously.

Parameters

addresses	Addresses of the nodes.
args	Request arguments.

Returns: The task.

Exceptions

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

◆ BulkReadMetadataAsync()

Task< IClientAsyncBulkResult > BulkReadMetadataAsync ( string[] addresses )

Reads the metadata from a list of nodes asynchronously.

Parameters

addresses Addresses of the nodes.

Returns: The task.

Exceptions

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

◆ BulkRemoveAsync()

Task< IClientAsyncBulkResult > BulkRemoveAsync ( string[] addresses )

Removes a list of nodes asynchronously.

Parameters

addresses Addresses of the nodes.

Returns: The task.

Exceptions

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

◆ BulkWriteAsync()

Task< IClientAsyncBulkResult > BulkWriteAsync	(	string[]	addresses,
		IVariant[]	writeValues
	)

Writes a list of values to a list of nodes asynchronously.

Parameters

addresses	Addresses of the nodes.
writeValues	Values to write.

Returns: The task.

Exceptions

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

◆ CreateAsync()

Task< IClientAsyncResult > CreateAsync	(	string	address,
		IVariant	args
	)

Creates a node with arguments asynchronously.

Parameters

address	Address of the node.
args	Request arguments.

Returns: The task.

Exceptions

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

Example

var userData = new Variant(42);

var task = client.CreateAsync(string, userData);

Datalayer.Variant

Provides the implementation for IVariant.

Definition: Variant.cs:19

◆ CreateSubscriptionAsync() [1/2]

Task< ISubscriptionAsyncResult > CreateSubscriptionAsync	(	IVariant	subscriptionPropertiesFlatbuffers,
		object	userData
	)

Creates an subscription asynchronously.

Parameters

subscriptionPropertiesFlatbuffers	Properties of the subscription as flatbuffers.
userData	Optional user data can be provided, which is available in the subscription data changed event context.

Returns: The task.

Exceptions

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

Example

var userData = new Variant(42);
var builder = new FlatBufferBuilder(Variant.DefaultFlatbuffersInitialSize);
var properties = SubscriptionProperties.CreateSubscriptionProperties(
   builder: builder,
   idOffset: builder.CreateString("mySubscription"),
   keepaliveInterval: KeepLiveIntervalMillis,
   publishInterval: PublishIntervalMillis,
   rulesOffset: default,
   errorInterval: ErrorIntervalMillis);
builder.Finish(properties.Value);
var propertiesFlatbuffers = new Variant(builder);
var task = client.CreateSubscriptionAsync(propertiesFlatbuffers, userData);

◆ CreateSubscriptionAsync() [2/2]

Task< ISubscriptionAsyncResult > CreateSubscriptionAsync	(	SubscriptionPropertiesT	subscriptionProperties,
		object	userData
	)

Creates an subscription asynchronously.

Parameters

subscriptionProperties	Properties of the subscription
userData	Optional user data can be provided, which is available in the subscription data changed event context.

Returns: The task.

Exceptions

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

Example

var userData = new Variant(42);
var props = new SubscriptionPropertiesT()
{
    Id = "mySubscription",
    PublishInterval = ISubscription.DefaultPublishIntervalMillis,
    KeepaliveInterval = ISubscription.DefaultKeepaliveIntervalMillis,
    ErrorInterval = ISubscription.DefaultErrorIntervalMillis,
};
var task = client.CreateSubscriptionAsync(propertiesFlatbuffers, userData);

◆ Ping()

DLR_RESULT Ping ( )

Pings the remote.

Returns: The result.

Exceptions

ObjectDisposedException Cannot access a disposed object.

◆ PingAsync()

Task< IClientAsyncResult > PingAsync ( )

Pings the remote asynchronously.

Returns: The task.

Exceptions

ObjectDisposedException Cannot access a disposed object.

◆ ReadAsync() [1/2]

Task< IClientAsyncResult > ReadAsync ( string address )

Reads a node value asynchronously.

Parameters

address Address of the node.

Returns: The task.

Exceptions

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

◆ ReadAsync() [2/2]

Task< IClientAsyncResult > ReadAsync	(	string	address,
		IVariant	args
	)

Reads a node value with arguments asynchronously.

Parameters

address	Address of the node.
args	Request arguments.

Returns: The task.

Exceptions

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

◆ ReadJsonAsync() [1/2]

Task< IClientAsyncResult > ReadJsonAsync	(	string	address,
		int	indentStep = `0`
	)

Reads a node value as JSON asynchronously.

Parameters

address	Address of the node.
indentStep	Indentation length for json string.

Returns: The task.

Exceptions

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

◆ ReadJsonAsync() [2/2]

Task< IClientAsyncResult > ReadJsonAsync	(	string	address,
		IVariant	args,
		int	indentStep = `0`
	)

Reads a node value as JSON with arguments asynchronously.

Parameters

address	Address of the node.
args	Request arguments (JSON).
indentStep	Indentation length for json string.

Returns: The task.

Exceptions

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

◆ ReadMetadataAsync()

Task< IClientAsyncResult > ReadMetadataAsync ( string address )

Reads the metadata of a node asynchronously.

Parameters

address Address of the node.

Returns: The task.

Exceptions

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

◆ Remove()

DLR_RESULT Remove ( string address )

Removes a node.

Parameters

address Address of the node.

Returns: The result.

Exceptions

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

◆ RemoveAsync()

Task< IClientAsyncResult > RemoveAsync ( string address )

Removes a node asynchronously.

Parameters

address Address of the node.

Returns: The task.

Exceptions

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

◆ SetTimeout()

DLR_RESULT SetTimeout	(	DLR_TIMEOUT_SETTING	timeout,
		uint	value
	)

Sets the timeout of each request.

Parameters

timeout	Timeout to set.
value	Value to set.

Returns: The result.

Exceptions

ObjectDisposedException Cannot access a disposed object.

◆ Write()

DLR_RESULT Write	(	string	address,
		IVariant	writeValue
	)

Writes the value to a node.

Parameters

address	Address of the node.
writeValue	Value to write.

Returns: The result.

Exceptions

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

◆ WriteAsync()

Task< IClientAsyncResult > WriteAsync	(	string	address,
		IVariant	writeValue
	)

Writes a value to a node asynchronously.

Parameters

address	Address of the node.
writeValue	Value to set.

Returns: The task.

Exceptions

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

◆ WriteJsonAsync()

Task< IClientAsyncResult > WriteJsonAsync	(	string	address,
		string	json
	)

Writes a JSON value to a node asynchronously.

Parameters

address	Address of the node.
json	JSON value to write.

Returns: The task.

Exceptions

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

Member Data Documentation

◆ DLR_RESULT

DLR_RESULT

Writes a JSON value to a node.

Parameters

address	Address of the node.
json	JSON value to write.

Returns: The result.

Exceptions

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

Definition at line 265 of file IClient.cs.

◆ result

DLR_RESULT result

Reads a node value.

Creates a subscription.

Removes a list of nodes.

Creates a list of nodes with arguments.

Creates a node with arguments.

Browses a list of nodes.

Browses a node.

Writes a list of values to a list of nodes.

Reads the metadata from a list of nodes.

Reads the metadata of a node.

Reads a node value as JSON with arguments.

Reads a node value as JSON.

Reads values from a list of nodes with arguments.

Reads values from a list of nodes.

Reads a node value with arguments.

Parameters

address Address of the node.

Returns: The result.

Exceptions

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

Parameters

address	Address of the node.
args	Request arguments.

Returns: The result.

Exceptions

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

Parameters

addresses Addresses of the nodes.

Returns: The result.

Exceptions

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

Parameters

addresses	Addresses of the nodes.
args	Request arguments.

Returns: The result.

Exceptions

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

Parameters

address	Address of the node.
indentStep	Indentation length for json string.

Returns: The result.

Exceptions

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

Parameters

address	Address of the node.
args	Request arguments (JSON).
indentStep	Indentation length for json string.

Returns: The result.

Exceptions

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

Parameters

addresses	Addresses of the nodes.
writeValues	Values to write.

Returns: The result.

Exceptions

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

Parameters

addresses Address of the nodes.

Returns: The result.

Exceptions

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

Parameters

addresses	Addresses of the nodes.
args	Request arguments.

Returns: The result.

Exceptions

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

Parameters

subscriptionProperties	Properties of the subscription.
userData	Optional user data can be provided, which is available in the subscription data changed event context.

Returns: The result.

Exceptions

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

var userData = new Variant(42); var props = new SubscriptionPropertiesT() { Id = "mySubscription", PublishInterval = ISubscription.DefaultPublishIntervalMillis, KeepaliveInterval = ISubscription.DefaultKeepaliveIntervalMillis, ErrorInterval = ISubscription.DefaultErrorIntervalMillis, }; var (result, subscription) = client.CreateSubscription(propertiesFlatbuffers, userData);

Parameters

subscriptionPropertiesFlatbuffers	Properties of the subscription as flatbuffers.
userData	Optional user data can be provided, which is available in the subscription data changed event context.

Returns: The result.

Exceptions

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

var userData = new Variant(42); var builder = new FlatBufferBuilder(Variant.DefaultFlatbuffersInitialSize); var properties = SubscriptionProperties.CreateSubscriptionProperties( builder: builder, idOffset: builder.CreateString("mySubscription"), keepaliveInterval: KeepLiveIntervalMillis, publishInterval: PublishIntervalMillis, rulesOffset: default, errorInterval: ErrorIntervalMillis); builder.Finish(properties.Value); var propertiesFlatbuffers = new Variant(builder); var (result, subscription) = client.CreateSubscription(propertiesFlatbuffers, userData);

Definition at line 66 of file IClient.cs.

Property Documentation

◆ AuthToken

IVariant AuthToken

get

Gets the authentication token (JWT) as string.

Exceptions

ObjectDisposedException	Cannot access a disposed object.
InvalidOperationException	Operation not allowed.

Definition at line 34 of file IClient.cs.

◆ ConnectionStatus

DLR_RESULT ConnectionStatus

get

Gets the connection status.

Exceptions

ObjectDisposedException Cannot access a disposed object.

Definition at line 27 of file IClient.cs.

◆ IsConnected

bool IsConnected

get

Checks the connection.

Exceptions

ObjectDisposedException Cannot access a disposed object.

Definition at line 21 of file IClient.cs.

◆ System

IDatalayerSystem System

get

Gets the system.

Definition at line 15 of file IClient.cs.

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

D:/Jenkins/workspace/sdk.datalayer.csharp/datalayer/IClient.cs

Public Member Functions

Public Attributes

Properties

Detailed Description

Member Function Documentation

◆ BrowseAsync()

◆ BulkBrowseAsync()

◆ BulkCreateAsync()

◆ BulkReadAsync() [1/2]

◆ BulkReadAsync() [2/2]

◆ BulkReadMetadataAsync()

◆ BulkRemoveAsync()

◆ BulkWriteAsync()

◆ CreateAsync()

◆ CreateSubscriptionAsync() [1/2]

◆ CreateSubscriptionAsync() [2/2]

◆ Ping()

◆ PingAsync()

◆ ReadAsync() [1/2]

◆ ReadAsync() [2/2]

◆ ReadJsonAsync() [1/2]

◆ ReadJsonAsync() [2/2]

◆ ReadMetadataAsync()

◆ Remove()

◆ RemoveAsync()

◆ SetTimeout()

◆ Write()

◆ WriteAsync()

◆ WriteJsonAsync()

Member Data Documentation

◆ DLR_RESULT

◆ result

Property Documentation

◆ AuthToken

◆ ConnectionStatus

◆ IsConnected

◆ System