IProvider Interface Reference

The provider interface More...

Inheritance diagram for IProvider:

Public Member Functions
IProviderNode	RegisterNode (string address, IProviderNodeHandler handler)
DLR_RESULT	RegisterType (string address, string bfbsPath)
	Registers the type to the datalayer. More...
DLR_RESULT	Start ()
	Starts the provider. More...
DLR_RESULT	Stop ()
	Stops the provider. More...
DLR_RESULT	UnregisterNode (string address)
	Unregisters the node from the datalayer. More...
DLR_RESULT	UnregisterType (string address)
	Unregisters the type from the datalayer. More...

Public Attributes
	DLR_RESULT
	Registers the node to the datalayer. More...

Properties
IVariant	AuthToken [get]
	Gets the authentication token (JWT) as flatbuffers 'Token' while processing requests. More...
bool	IsConnected [get]
	Checks the connection. More...
IDatalayerSystem	System [get]
	Gets the system. More...
Properties inherited from INativeDisposable
bool	IsDisposed [get]
	Checks disposed More...

Detailed Description

The provider interface

Definition at line 8 of file IProvider.cs.

Member Function Documentation

RegisterType()

DLR_RESULT RegisterType	(	string	address,
		string	bfbsPath
	)

Registers the type to the datalayer.

Parameters

address	Address of the node
bfbsPath	Path to flatbuffer bfbs

Returns

Result of method call

Exceptions

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

Start()

DLR_RESULT Start

(

)

Starts the provider.

Returns

Result of method call

Exceptions

ObjectDisposedException

Cannot access a disposed object

Stop()

DLR_RESULT Stop

(

)

Stops the provider.

Returns

Result of method call</returns

Exceptions

ObjectDisposedException

Cannot access a disposed object

UnregisterNode()

DLR_RESULT UnregisterNode

(

string

address

)

Unregisters the node from the datalayer.

Parameters

address

Address of the node

Returns

Result of method call

Exceptions

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

UnregisterType()

DLR_RESULT UnregisterType

(

string

address

)

Unregisters the type from the datalayer.

Parameters

address

Address of the node

Returns

Result of method call

Exceptions

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

Member Data Documentation

DLR_RESULT

DLR_RESULT

Registers the node to the datalayer.

Parameters

address	Address of the node
handler	Reference to the node handler

Returns

The corresponding provider node

Exceptions

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

Example

using var provider =system.Factory.CreateIpcProvider();
var myNodeHandler = new MyNodeHandler();
var result = provider.RegisterNode("dotnet/myInt", myNodeHandler);

Definition at line 63 of file IProvider.cs.

Property Documentation

AuthToken

IVariant AuthToken

get

Gets the authentication token (JWT) as flatbuffers 'Token' while processing requests.

Exceptions

ObjectDisposedException	Cannot access a disposed object
InvalidOperationException	Operation not allowed

Definition at line 20 of file IProvider.cs.

IsConnected

bool IsConnected

get

Checks the connection.

Exceptions

ObjectDisposedException

Cannot access a disposed object

Definition at line 26 of file IProvider.cs.

System

IDatalayerSystem System

get

Gets the system.

Definition at line 13 of file IProvider.cs.

---

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

• D:/Jenkins/workspace/sdk.datalayer.csharp/datalayer/IProvider.cs