IDatalayerSystem Interface Reference

The IDatalayerSystem interface. More...

Inheritance diagram for IDatalayerSystem:

Public Member Functions
void	Start (bool startBroker)
	Starts the DatalayerSystem.
void	Stop ()
	Stops the DatalayerSystem.

Properties
string	BfbsPath [set]
	Sets the binary Flatbuffer path, which contains *.bfbs files.
IConverter	Converter [get]
	Gets the Converter for Variant to JSON conversions.
IFactory	Factory [get]
	Gets the Factory to create Clients and Providers. Exceptions ObjectDisposedException Cannot access a disposed object. InvalidOperationException Operation not allowed.
string	IpcPath [get]
	Gets the interprocess communication path.
bool	IsStarted [get]
	Checks if the DatalayerSystem is started.
Properties inherited from INativeDisposable
bool	IsDisposed [get]
	Checks disposed.

Detailed Description

The IDatalayerSystem interface.

Definition at line 8 of file IDatalayerSystem.cs.

Member Function Documentation

Start()

void Start

(

bool

startBroker

)

Starts the DatalayerSystem.

Parameters

startBroker

Use true to start a broker. If you are a user of the ctrlX Data Layer, set to false.

Exceptions

ObjectDisposedException

Cannot access a disposed object.

Example

using var system = new DatalayerSystem();
system.Start(startBroker: false);

Implemented in DatalayerSystem.

Stop()

void Stop

(

)

Stops the DatalayerSystem.

Exceptions

ObjectDisposedException

Cannot access a disposed object.

Implemented in DatalayerSystem.

Property Documentation

BfbsPath

string BfbsPath

set

Sets the binary Flatbuffer path, which contains *.bfbs files.

Exceptions

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

Implemented in DatalayerSystem.

Definition at line 60 of file IDatalayerSystem.cs.

Converter

IConverter Converter

get

Gets the Converter for Variant to JSON conversions.

Exceptions

ObjectDisposedException

Cannot access a disposed object.

Implemented in DatalayerSystem.

Definition at line 53 of file IDatalayerSystem.cs.

Factory

IFactory Factory

get

Gets the Factory to create Clients and Providers.

Exceptions

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

Implemented in DatalayerSystem.

Definition at line 47 of file IDatalayerSystem.cs.

IpcPath

string IpcPath

get

Gets the interprocess communication path.

Exceptions

ObjectDisposedException

Cannot access a disposed object.

Implemented in DatalayerSystem.

Definition at line 14 of file IDatalayerSystem.cs.

IsStarted

bool IsStarted

get

Checks if the DatalayerSystem is started.

Exceptions

ObjectDisposedException

Cannot access a disposed object.

Implemented in DatalayerSystem.

Definition at line 20 of file IDatalayerSystem.cs.

---

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

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