IProvider Interface Reference

The IProvider interface. More...

Inheritance diagram for IProvider:

Public Member Functions
DLR_RESULT	PublishEvent (IVariant data, IVariant eventInfo)
	Publishes an event.
IVariant	RegisteredNodePaths ()
IVariant	RegisteredType (string address)
IProviderNode	RegisterNode (string address, IProviderNodeHandler handler)
DLR_RESULT	RegisterType (string address, string bfbsPath)
	Registers the type to the ctrlX Data Layer.
DLR_RESULT	RegisterTypeVariant (string address, IVariant flatbuffers)
	Registers the type to the ctrlX Data Layer.
IVariant	RejectedNodePaths ()
DLR_RESULT	Start ()
	Starts the provider.
DLR_RESULT	Stop ()
	Stops the provider.
DLR_RESULT	UnregisterNode (string address)
	Unregisters the node from the ctrlX Data Layer.
DLR_RESULT	UnregisterType (string address)
	Unregisters the type from the ctrlX Data Layer.

Public Attributes
	DLR_RESULT
	Registers the node to the ctrlX Data Layer.

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

Detailed Description

The IProvider interface.

Definition at line 8 of file IProvider.cs.

Member Function Documentation

PublishEvent()

DLR_RESULT PublishEvent	(	IVariant	data,
		IVariant	eventInfo
	)

Publishes an event.

Parameters

data	The event data.
eventInfo	The Event info (flatbuffers). Set timestamp/sequenceNumber property to Zero for automatic creation/increment.

Returns

Result of the method call.

Exceptions

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

RegisterType()

DLR_RESULT RegisterType	(	string	address,
		string	bfbsPath
	)

Registers the type to the ctrlX Data Layer.

Parameters

address	Address of the node.
bfbsPath	Path to flatbuffers type binary bfbs file.

Returns

Result of the method call.

Exceptions

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

RegisterTypeVariant()

DLR_RESULT RegisterTypeVariant	(	string	address,
		IVariant	flatbuffers
	)

Registers the type to the ctrlX Data Layer.

Parameters

address	Address of the node.
flatbuffers	Variant with flatbuffers type.

Returns

Result of the method call.

Exceptions

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

Start()

DLR_RESULT Start

(

)

Starts the provider.

Returns

Result of the 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 ctrlX Data Layer.

Parameters

address

Address of the node.

Returns

Result of the 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 ctrlX Data Layer.

Parameters

address

Address of the node.

Returns

Result of the 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 ctrlX Data Layer.

Gets the current rejected node paths.

Get the variant of a registered type (flatbuffers).

Gets the current registered node paths.

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.

Returns

Result of the method call.

Exceptions

ObjectDisposedException

Cannot access a disposed object.

Exceptions

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

Definition at line 75 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