ctrlX Data Layer API for .NET 5  2.1.0
Datalayer Namespace Reference

Classes

class  DatalayerSystem
 
interface  IClient
 The client interface. More...
 
interface  IClientAsyncResult
 The result of the asynchronous client request. More...
 
interface  IConverter
 The converter interface. More...
 
interface  IDataChangedEventArgs
 The subscription's data changed event interface More...
 
interface  IDatalayerSystem
 The datalayer system interface. More...
 
interface  IFactory
 The factory interface. More...
 
interface  INativeDisposable
 The native disposable interface More...
 
interface  INotifyItem
 The notify item interface More...
 
interface  IProvider
 The provider interface More...
 
interface  IProviderNode
 The provider node interface. More...
 
interface  IProviderNodeHandler
 The provider node handler interface. More...
 
interface  IProviderNodeResult
 The provider node result interface. More...
 
interface  ISubscription
 The subscription interface. More...
 
interface  ISubscriptionAsyncResult
 The result of the asynchronous subscription request. More...
 
interface  IVariant
 The variant interface. More...
 
class  ResultExtensions
 Exension methods of the DLR_RESULT enum More...
 
class  Variant
 Variant class More...
 

Enumerations

enum  DLR_RESULT {
  DL_OK = 0, DL_FAILED = unchecked((int)(0x80000001)), DL_INVALID_ADDRESS = unchecked((int)(0x80010001)), DL_UNSUPPORTED = unchecked((int)(0x80010002)),
  DL_OUT_OF_MEMORY = unchecked((int)(0x80010003)), DL_LIMIT_MIN = unchecked((int)(0x80010004)), DL_LIMIT_MAX = unchecked((int)(0x80010005)), DL_TYPE_MISMATCH = unchecked((int)(0x80010006)),
  DL_SIZE_MISMATCH = unchecked((int)(0x80010007)), DL_INVALID_FLOATINGPOINT = unchecked((int)(0x80010009)), DL_INVALID_HANDLE = unchecked((int)(0x8001000A)), DL_INVALID_OPERATION_MODE = unchecked((int)(0x8001000B)),
  DL_INVALID_CONFIGURATION = unchecked((int)(0x8001000C)), DL_INVALID_VALUE = unchecked((int)(0x8001000D)), DL_SUBMODULE_FAILURE = unchecked((int)(0x8001000E)), DL_TIMEOUT = unchecked((int)(0x8001000F)),
  DL_ALREADY_EXISTS = unchecked((int)(0x80010010)), DL_CREATION_FAILED = unchecked((int)(0x80010011)), DL_VERSION_MISMATCH = unchecked((int)(0x80010012)), DL_DEPRECATED = unchecked((int)(0x80010013)),
  DL_PERMISSION_DENIED = unchecked((int)(0x80010014)), DL_NOT_INITIALIZED = unchecked((int)(0x80010015)), DL_COMM_PROTOCOL_ERROR = unchecked((int)(0x80020001)), DL_COMM_INVALID_HEADER = unchecked((int)(0x80020002)),
  DL_CLIENT_NOT_CONNECTED = unchecked((int)(0x80030001)), DL_RT_NOTOPEN = unchecked((int)(0x80060001)), DL_RT_INVALIDOBJECT = unchecked((int)(0x80060002)), DL_RT_WRONGREVISON = unchecked((int)(0x80060003)),
  DL_RT_NOVALIDDATA = unchecked((int)(0x80060004)), DL_RT_MEMORYLOCKED = unchecked((int)(0x80060005)), DL_RT_INVALIDMEMORYMAP = unchecked((int)(0x80060006)), DL_RT_INVALID_RETAIN = unchecked((int)(0x80060007)),
  DL_RT_INTERNAL_ERROR = unchecked((int)(0x80060008)), DL_SEC_NOTOKEN = unchecked((int)(0x80070001)), DL_SEC_INVALIDSESSION = unchecked((int)(0x80070002)), DL_SEC_INVALIDTOKENCONTENT = unchecked((int)(0x80070003)),
  DL_SEC_UNAUTHORIZED = unchecked((int)(0x80070004))
}
 DLR_RESULT More...
 
enum  DLR_SCHEMA {
  DLR_SCHEMA_METADATA = 0, DLR_SCHEMA_REFLECTION = 1, DLR_SCHEMA_MEMORY = 2, DLR_SCHEMA_MEMORY_MAP = 3,
  DLR_SCHEMA_TOKEN = 4, DLR_SCHEMA_PROBLEM = 5, DLR_SCHEMA_DIAGNOSIS = 6
}
 DLR_SCHEMA More...
 
enum  DLR_TIMEOUT_SETTING { Idle, Ping, Reconnect }
 DLR_TIMEOUT_SETTING More...
 
enum  DLR_VARIANT_TYPE {
  DLR_VARIANT_TYPE_UNKNOWN, DLR_VARIANT_TYPE_BOOL8, DLR_VARIANT_TYPE_INT8, DLR_VARIANT_TYPE_UINT8,
  DLR_VARIANT_TYPE_INT16, DLR_VARIANT_TYPE_UINT16, DLR_VARIANT_TYPE_INT32, DLR_VARIANT_TYPE_UINT32,
  DLR_VARIANT_TYPE_INT64, DLR_VARIANT_TYPE_UINT64, DLR_VARIANT_TYPE_FLOAT32, DLR_VARIANT_TYPE_FLOAT64,
  DLR_VARIANT_TYPE_STRING, DLR_VARIANT_TYPE_ARRAY_OF_BOOL8, DLR_VARIANT_TYPE_ARRAY_OF_INT8, DLR_VARIANT_TYPE_ARRAY_OF_UINT8,
  DLR_VARIANT_TYPE_ARRAY_OF_INT16, DLR_VARIANT_TYPE_ARRAY_OF_UINT16, DLR_VARIANT_TYPE_ARRAY_OF_INT32, DLR_VARIANT_TYPE_ARRAY_OF_UINT32,
  DLR_VARIANT_TYPE_ARRAY_OF_INT64, DLR_VARIANT_TYPE_ARRAY_OF_UINT64, DLR_VARIANT_TYPE_ARRAY_OF_FLOAT32, DLR_VARIANT_TYPE_ARRAY_OF_FLOAT64,
  DLR_VARIANT_TYPE_ARRAY_OF_STRING, DLR_VARIANT_TYPE_RAW, DLR_VARIANT_TYPE_FLATBUFFERS
}
 DLR_VARIANT_TYPE More...
 

Enumeration Type Documentation

◆ DLR_RESULT

enum DLR_RESULT
strong

DLR_RESULT

Enumerator
DL_OK 

Function call succeeded

DL_FAILED 

Function call failed

DL_INVALID_ADDRESS 

Address not found, address invalid (browse of this node not possible, write -> address not valid)

DL_UNSUPPORTED 

Function not implemented

DL_OUT_OF_MEMORY 

Out of memory or resources (RAM, sockets, handles, disk space ...).

DL_LIMIT_MIN 

The minimum of a limitation is exceeded.

DL_LIMIT_MAX 

The maximum of a limitation is exceeded.

DL_TYPE_MISMATCH 

Wrong flatbuffer type, wrong data type

DL_SIZE_MISMATCH 

Size mismatch, present size doesn't match requested size.

DL_INVALID_FLOATINGPOINT 

Invalid floating point number.

DL_INVALID_HANDLE 

Invalid handle argument or NULL pointer argument.

DL_INVALID_OPERATION_MODE 

Not accessible due to invalid operation mode (write not possible)

DL_INVALID_CONFIGURATION 

Mismatch of this value with other configured values

DL_INVALID_VALUE 

Invalid value

DL_SUBMODULE_FAILURE 

Error in submodule

DL_TIMEOUT 

Request timeout

DL_ALREADY_EXISTS 

Create: resource already exists

DL_CREATION_FAILED 

Error during creation

DL_VERSION_MISMATCH 

Version conflict

DL_DEPRECATED 

Deprecated - function not longer supported

DL_PERMISSION_DENIED 

Request declined due to missing permission rights

DL_NOT_INITIALIZED 

Object not initialized yet

DL_COMM_PROTOCOL_ERROR 

Internal protocol error

DL_COMM_INVALID_HEADER 

Internal header mismatch

DL_CLIENT_NOT_CONNECTED 

Client not connected

DL_RT_NOTOPEN 

RT not open

DL_RT_INVALIDOBJECT 

RT invalid object

DL_RT_WRONGREVISON 

RT wrong memory revision

DL_RT_NOVALIDDATA 

RT no valid data

DL_RT_MEMORYLOCKED 

RT memory already locked

DL_RT_INVALIDMEMORYMAP 

RT invalid memory map

DL_RT_INVALID_RETAIN 

RT invalid retain

DL_RT_INTERNAL_ERROR 

RT internal error

DL_SEC_NOTOKEN 

No token found

DL_SEC_INVALIDSESSION 

Token not valid (session not found)

DL_SEC_INVALIDTOKENCONTENT 

Token has wrong content

DL_SEC_UNAUTHORIZED 

Unauthorized

Definition at line 63 of file Enums.cs.

◆ DLR_SCHEMA

enum DLR_SCHEMA
strong

DLR_SCHEMA

Enumerator
DLR_SCHEMA_METADATA 

METADATA

DLR_SCHEMA_REFLECTION 

REFLECTION

DLR_SCHEMA_MEMORY 

MEMORY

DLR_SCHEMA_MEMORY_MAP 

MEMORY_MAP

DLR_SCHEMA_TOKEN 

TOKEN

DLR_SCHEMA_PROBLEM 

PROBLEM

DLR_SCHEMA_DIAGNOSIS 

DIAGNOSIS

Definition at line 6 of file Enums.cs.

◆ DLR_TIMEOUT_SETTING

enum DLR_TIMEOUT_SETTING
strong

DLR_TIMEOUT_SETTING

Enumerator
Idle 

Timeout to check whether the broker is still active when client is idle. Default: 30000 ms

Ping 

Timeout to wait for a response of a request. If timeout is exceeded, the request will be aborted with DL_TIMEOUT. Default: 3000 ms

Reconnect 

Timeout a reconnect attempt will be done if client looses connection to broker. Default: 1000 ms

Definition at line 41 of file Enums.cs.

◆ DLR_VARIANT_TYPE

enum DLR_VARIANT_TYPE
strong

DLR_VARIANT_TYPE

Enumerator
DLR_VARIANT_TYPE_UNKNOWN 
DLR_VARIANT_TYPE_BOOL8 
DLR_VARIANT_TYPE_INT8 
DLR_VARIANT_TYPE_UINT8 
DLR_VARIANT_TYPE_INT16 
DLR_VARIANT_TYPE_UINT16 
DLR_VARIANT_TYPE_INT32 
DLR_VARIANT_TYPE_UINT32 
DLR_VARIANT_TYPE_INT64 
DLR_VARIANT_TYPE_UINT64 
DLR_VARIANT_TYPE_FLOAT32 
DLR_VARIANT_TYPE_FLOAT64 
DLR_VARIANT_TYPE_STRING 
DLR_VARIANT_TYPE_ARRAY_OF_BOOL8 
DLR_VARIANT_TYPE_ARRAY_OF_INT8 
DLR_VARIANT_TYPE_ARRAY_OF_UINT8 
DLR_VARIANT_TYPE_ARRAY_OF_INT16 
DLR_VARIANT_TYPE_ARRAY_OF_UINT16 
DLR_VARIANT_TYPE_ARRAY_OF_INT32 
DLR_VARIANT_TYPE_ARRAY_OF_UINT32 
DLR_VARIANT_TYPE_ARRAY_OF_INT64 
DLR_VARIANT_TYPE_ARRAY_OF_UINT64 
DLR_VARIANT_TYPE_ARRAY_OF_FLOAT32 
DLR_VARIANT_TYPE_ARRAY_OF_FLOAT64 
DLR_VARIANT_TYPE_ARRAY_OF_STRING 
DLR_VARIANT_TYPE_RAW 
DLR_VARIANT_TYPE_FLATBUFFERS 

Definition at line 218 of file Enums.cs.