DatalayerSystem Class Reference

More...

Inheritance diagram for DatalayerSystem:

Public Member Functions
	DatalayerSystem (string ipcPath="")
	Creates a new DatalayerSystem More...
void	Dispose ()
void	Start (bool startBroker=false)
	Starts the DatalayerSystem More...
void	Stop ()
	Stops the DatalayerSystem More...

Public Attributes
bool	IsDisposed => _disposedValue

Static Public Attributes
static readonly int	DefaultClientPort = 2069
	Gets the default Client port More...
static readonly int	DefaultProviderPort = 2070
	Gets the default Provider port More...
static readonly string	ProtocolSchemeIpc = "ipc://"
	Gets the protocol scheme for IPC communication. Recommended to connect to a DatalayerSystem running on localhost. More...
static readonly string	ProtocolSchemeTcp = "tcp://"
	Gets the protocol scheme for TCP communication. Recommended to connect to a DatalayerSystem not running on localhost. More...

Protected Member Functions
virtual void	Dispose (bool disposing)

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 More...
string	IpcPath [get]
	Gets the path for interprocess communication. More...
bool	IsStarted [get]
	Indicates whether the DatalayerSystem is started More...
Properties inherited from IDatalayerSystem
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

Definition at line 10 of file DatalayerSystem.cs.

Constructor & Destructor Documentation

DatalayerSystem()

DatalayerSystem ( string  ipcPath = "" )

inline

Creates a new DatalayerSystem

Parameters

ipcPath

Path for interprocess communication. Leave empty for automatic detection

Exceptions

ArgumentNullException

Argument cannot be null.

Definition at line 30 of file DatalayerSystem.cs.

References DatalayerSystem.IpcPath.

Member Function Documentation

Dispose() [1/2]

void Dispose ( )

inline

Definition at line 96 of file DatalayerSystem.cs.

Dispose() [2/2]

virtual void Dispose ( bool  disposing )

inlineprotectedvirtual

Parameters

disposing

Definition at line 67 of file DatalayerSystem.cs.

Start()

void Start ( bool  startBroker = false )

inline

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);

Implements IDatalayerSystem.

Definition at line 253 of file DatalayerSystem.cs.

References DatalayerSystem.IsDisposed.

Stop()

void Stop ( )

inline

Stops the DatalayerSystem

Exceptions

ObjectDisposedException

Cannot access a disposed object

Implements IDatalayerSystem.

Definition at line 271 of file DatalayerSystem.cs.

References DatalayerSystem.IsDisposed.

Member Data Documentation

DefaultClientPort

readonly int DefaultClientPort = 2069

static

Gets the default Client port

Definition at line 154 of file DatalayerSystem.cs.

DefaultProviderPort

readonly int DefaultProviderPort = 2070

static

Gets the default Provider port

Definition at line 159 of file DatalayerSystem.cs.

IsDisposed

bool IsDisposed => _disposedValue

Definition at line 61 of file DatalayerSystem.cs.

Referenced by DatalayerSystem.Start(), and DatalayerSystem.Stop().

ProtocolSchemeIpc

readonly string ProtocolSchemeIpc = "ipc://"

static

Gets the protocol scheme for IPC communication. Recommended to connect to a DatalayerSystem running on localhost.

Definition at line 171 of file DatalayerSystem.cs.

ProtocolSchemeTcp

readonly string ProtocolSchemeTcp = "tcp://"

static

Gets the protocol scheme for TCP communication. Recommended to connect to a DatalayerSystem not running on localhost.

Definition at line 165 of file DatalayerSystem.cs.

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 217 of file DatalayerSystem.cs.

Converter

IConverter Converter

get

Gets the Converter for Variant to JSON conversions

Exceptions

ObjectDisposedException

Cannot access a disposed object

Definition at line 325 of file DatalayerSystem.cs.

Factory

IFactory Factory

get

Gets the Factory to create Clients and Providers

Exceptions

ObjectDisposedException	Cannot access a disposed object
InvalidOperationException	Operation not allowed

Definition at line 294 of file DatalayerSystem.cs.

IpcPath

string IpcPath

get

Gets the path for interprocess communication.

Exceptions

ObjectDisposedException

Cannot access a disposed object

Definition at line 182 of file DatalayerSystem.cs.

Referenced by DatalayerSystem.DatalayerSystem().

IsStarted

bool IsStarted

get

Indicates whether the DatalayerSystem is started

Exceptions

ObjectDisposedException

Cannot access a disposed object

Definition at line 199 of file DatalayerSystem.cs.

---

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

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