ctrlX Data Layer .NET API  4.3.0
Loading...
Searching...
No Matches
Datalayer Namespace Reference

Classes

class  DatalayerSystem
 Provides the implementation for IDatalayerSystem. More...
 
interface  IBulk
 The IBulk interface. More...
 
interface  IBulkItem
 The IBulkItem interface. More...
 
interface  IClient
 The IClient interface. More...
 
interface  IClientAsyncBulkResult
 The IClientAsyncBulkResult interface. More...
 
interface  IClientAsyncResult
 The IClientAsyncResult interface. More...
 
interface  IConverter
 The IConverter interface. More...
 
interface  IDataChangedEventArgs
 The IDataChangedEventArgs interface. More...
 
interface  IDatalayerSystem
 The IDatalayerSystem interface. More...
 
interface  IFactory
 The IFactory interface. More...
 
interface  INativeDisposable
 The INativeDisposable interface. More...
 
interface  INotifyItem
 The INotifyItem interface. More...
 
interface  IProvider
 The IProvider interface. More...
 
interface  IProviderNode
 The IProvider interface. More...
 
interface  IProviderNodeHandler
 The IProviderNodeHandler interface. More...
 
interface  IProviderNodeResult
 The IProviderNodeResult interface. More...
 
interface  ISubscription
 The ISubscription interface. More...
 
interface  ISubscriptionAsyncResult
 The ISubscriptionAsyncResult interface. More...
 
interface  IVariant
 The IVariant interface. More...
 
class  MetadataBuilder
 Provides a convenient way to to build up a Metadata flatbuffers. More...
 
class  ReferenceType
 Represents a type of reference. More...
 
class  Remote
 Provides a container for a TCP remote connection string. More...
 
class  ResultExtensions
 Provides extension methods for DLR_RESULT. More...
 
class  SubscriptionPropertiesBuilder
 Provides a convenient way to build a SubscriptionProperties flatbuffers. More...
 
class  Variant
 Provides the implementation for IVariant. More...
 

Enumerations

enum  AllowedOperationFlags {
  None = 0 , Read = 1 << 0 , Write = 1 << 1 , Create = 1 << 2 ,
  Delete = 1 << 3 , Browse = 1 << 4 , All = ~(~0 << 5)
}
 The AllowedOperationFlags enumeration flags. More...
 
enum  DLR_MEMORYTYPE {
  MemoryType_Unknown = 0 , MemoryType_Input = 1 , MemoryType_Output = 2 , MemoryType_SharedRetain = 3 ,
  MemoryType_Shared = 4
}
 The memory type. More...
 
enum  DLR_RESULT {
  DL_OK = 0 , DL_OK_NO_CONTENT = 1 , 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_MISSING_ARGUMENT = unchecked((int)0x80010016) ,
  DL_TOO_MANY_ARGUMENTS = unchecked((int)0x80010017) , DL_RESOURCE_UNAVAILABLE = unchecked((int)0x80010018) , DL_COMMUNICATION_ERROR = unchecked((int)0x80010019) , DL_TOO_MANY_OPERATIONS = unchecked((int)0x8001001A) ,
  DL_WOULD_BLOCK = unchecked((int)0x8001001B) , DL_COMM_PROTOCOL_ERROR = unchecked((int)0x80020001) , DL_COMM_INVALID_HEADER = unchecked((int)0x80020002) , DL_CLIENT_NOT_CONNECTED = unchecked((int)0x80030001) ,
  DL_PROVIDER_RESET_TIMEOUT = unchecked((int)0x80040001) , DL_PROVIDER_UPDATE_TIMEOUT = unchecked((int)0x80040002) , DL_PROVIDER_SUB_HANDLING = unchecked((int)0x80040003) , 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_RT_MALLOC_FAILED = unchecked((int)0x80060009) ,
  DL_RT_WOULD_BLOCK = unchecked((int)0x8006000A) , DL_SEC_NOTOKEN = unchecked((int)0x80070001) , DL_SEC_INVALIDSESSION = unchecked((int)0x80070002) , DL_SEC_INVALIDTOKENCONTENT = unchecked((int)0x80070003) ,
  DL_SEC_UNAUTHORIZED = unchecked((int)0x80070004) , DL_SEC_PAYMENT_REQUIRED = unchecked((int)0x80070005)
}
 The 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
}
 The schema. More...
 
enum  DLR_TIMEOUT_SETTING {
  Idle , Ping , Reconnect , ZmqHWMSnd ,
  ZmqHWMRcv
}
 The 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_TIMESTAMP ,
  DLR_VARIANT_TYPE_ARRAY_OF_TIMESTAMP
}
 DLR_VARIANT_TYPE. More...
 
enum  ProtocolScheme { AUTO , IPC , TCP }
 

Enumeration Type Documentation

◆ AllowedOperationFlags

The AllowedOperationFlags enumeration flags.

Enumerator
None 

None.

Read 

Read.

Write 

Write.

Create 

Create.

Delete 

Delete.

Browse 

Browse.

All 

All.

Definition at line 9 of file Enums.cs.

◆ DLR_MEMORYTYPE

The memory type.

Enumerator
MemoryType_Unknown 

Unknown memory type.

MemoryType_Input 

Input memory type.

MemoryType_Output 

Output memory type.

MemoryType_SharedRetain 

Shared retain memory type.

MemoryType_Shared 

Shared memory type.

Definition at line 44 of file Enums.cs.

◆ DLR_RESULT

enum DLR_RESULT

The result.

Enumerator
DL_OK 

Function call succeeded.

DL_OK_NO_CONTENT 

Function call succeeded with no content.

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_MISSING_ARGUMENT 

Missing argument (eg. missing argument in fbs).

DL_TOO_MANY_ARGUMENTS 

To many arguments.

DL_RESOURCE_UNAVAILABLE 

Resource unavailable.

DL_COMMUNICATION_ERROR 

Low level communication error occurred.

DL_TOO_MANY_OPERATIONS 

Request can't be handled due to too many operations.

DL_WOULD_BLOCK 

Request would block, you have called a synchronous function in a callback from a asynchronous function.

DL_COMM_PROTOCOL_ERROR 

Internal protocol error.

DL_COMM_INVALID_HEADER 

Internal header mismatch.

DL_CLIENT_NOT_CONNECTED 

Client not connected.

DL_PROVIDER_RESET_TIMEOUT 

Provider reset timeout.

DL_PROVIDER_UPDATE_TIMEOUT 

Provider update timeout.

DL_PROVIDER_SUB_HANDLING 

Provider default subscription handling.

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_RT_MALLOC_FAILED 

Allocation of shared memory failed - datalayer-shm connected?

DL_RT_WOULD_BLOCK 

BeginAccess would block because there are no data.

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.

DL_SEC_PAYMENT_REQUIRED 

Payment required.

Definition at line 152 of file Enums.cs.

◆ DLR_SCHEMA

enum DLR_SCHEMA

The schema.

Enumerator
DLR_SCHEMA_METADATA 

Metadata schema.

DLR_SCHEMA_REFLECTION 

Reflection schema.

DLR_SCHEMA_MEMORY 

Memory schema.

DLR_SCHEMA_MEMORY_MAP 

Map schema.

DLR_SCHEMA_TOKEN 

Token schema.

DLR_SCHEMA_PROBLEM 

Problem schema.

DLR_SCHEMA_DIAGNOSIS 

Diagnosis schema.

Definition at line 75 of file Enums.cs.

◆ DLR_TIMEOUT_SETTING

The 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.

ZmqHWMSnd 

High water mark of ZMQ (Send). Default: 1000.

ZmqHWMRcv 

High water mark of ZMQ (Receive). Default: 1000.

Definition at line 116 of file Enums.cs.

◆ DLR_VARIANT_TYPE

DLR_VARIANT_TYPE.

Enumerator
DLR_VARIANT_TYPE_UNKNOWN 

Unknown datatype.

DLR_VARIANT_TYPE_BOOL8 

Bool 8 bit.

DLR_VARIANT_TYPE_INT8 

Signed int 8 bit.

DLR_VARIANT_TYPE_UINT8 

Unsigned int 8 bit.

DLR_VARIANT_TYPE_INT16 

Signed int 16 bit.

DLR_VARIANT_TYPE_UINT16 

Unsigned int 16 bit.

DLR_VARIANT_TYPE_INT32 

Signed int 32 bit.

DLR_VARIANT_TYPE_UINT32 

Unsigned int 32 bit.

DLR_VARIANT_TYPE_INT64 

Signed int 64 bit.

DLR_VARIANT_TYPE_UINT64 

Unsigned int 64 bit.

DLR_VARIANT_TYPE_FLOAT32 

Float 32 bit.

DLR_VARIANT_TYPE_FLOAT64 

Float 64 bit.

DLR_VARIANT_TYPE_STRING 

String (UTF-8)

DLR_VARIANT_TYPE_ARRAY_OF_BOOL8 

Array of bool 8 bit.

DLR_VARIANT_TYPE_ARRAY_OF_INT8 

Array of Signed int 8 bit.

DLR_VARIANT_TYPE_ARRAY_OF_UINT8 

Array of Unsigned int 8 bit.

DLR_VARIANT_TYPE_ARRAY_OF_INT16 

Array of Signed int 16 bit.

DLR_VARIANT_TYPE_ARRAY_OF_UINT16 

Array of Unsigned int 16 bit.

DLR_VARIANT_TYPE_ARRAY_OF_INT32 

Array of Signed int 32 bit.

DLR_VARIANT_TYPE_ARRAY_OF_UINT32 

Array of Unsigned int 32 bit.

DLR_VARIANT_TYPE_ARRAY_OF_INT64 

Array of Signed int 64 bit.

DLR_VARIANT_TYPE_ARRAY_OF_UINT64 

Array of Unsigned int 64 bit.

DLR_VARIANT_TYPE_ARRAY_OF_FLOAT32 

Array of float 32 bit.

DLR_VARIANT_TYPE_ARRAY_OF_FLOAT64 

Array of float 64 bit.

DLR_VARIANT_TYPE_ARRAY_OF_STRING 

Array of string (UTF-8)

DLR_VARIANT_TYPE_RAW 

Raw bytes.

DLR_VARIANT_TYPE_FLATBUFFERS 

Bytes as a complex data type encoded as a flatbuffer.

DLR_VARIANT_TYPE_TIMESTAMP 

Timestamp (FILETIME) 64 bit 100ns since 1.1.1601 (UTC)

DLR_VARIANT_TYPE_ARRAY_OF_TIMESTAMP 

Array of Timestamp (FILETIME) 64 bit 100ns since 1.1.1601 (UTC)

Definition at line 408 of file Enums.cs.

◆ ProtocolScheme

Enumerator
AUTO 

Autodect the protocol IPC (Inter Process Communication) if running inside SNAP otherwise TCP (Transmission Control Protocol).

IPC 

IPC (Inter Process Communication)

TCP 

Definition at line 3 of file ProtocolScheme.cs.