IDatalayerSystem Interface Reference

The datalayer system interface. More...

Inheritance diagram for IDatalayerSystem:

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

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

Detailed Description

The datalayer system 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 datalayer, 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.

Definition at line 73 of file IDatalayerSystem.cs.

Converter

IConverter Converter

get

Gets the Converter for Variant to JSON conversions.

Exceptions

ObjectDisposedException

Cannot access a disposed object

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

Example

using var system = new DatalayerSystem();
var isSnapped = !string.IsNullOrEmpty(Environment.GetEnvironmentVariable("SNAP"));
using var client = isSnapped
       ? system.Factory.CreateIpcClient()
       : system.Factory.CreateTcpClient(IPAddress.Loopback,
           DatalayerSystem.DefaultClientPort,
           "name",
          "name");

Definition at line 60 of file IDatalayerSystem.cs.

IpcPath

string IpcPath

get

Gets the interprocess communication path.

Exceptions

ObjectDisposedException

Cannot access a disposed object

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

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