Constants

DataTypes Enum

RobotRaconteur.DataTypes_void_t = 0

void or null type

RobotRaconteur.DataTypes_double_t = 1

IEEE-754 64-bit floating point number

RobotRaconteur.DataTypes_single_t = 2

IEEE-754 32-bit floating point number

RobotRaconteur.DataTypes_int8_t = 3

8-bit signed integer

RobotRaconteur.DataTypes_uint8_t = 4

8-bit unsigned integer

RobotRaconteur.DataTypes_int16_t = 5

16-bit signed integer

RobotRaconteur.DataTypes_uint16_t = 6

16-bit unsigned integer

RobotRaconteur.DataTypes_int32_t = 7

32-bit signed integer

RobotRaconteur.DataTypes_uint32_t = 8

32-bit unsigned integer

RobotRaconteur.DataTypes_int64_t = 9

64-bit signed integer

RobotRaconteur.DataTypes_uint64_t = 10

64-bit unsigned integer

RobotRaconteur.DataTypes_string_t = 11

UTF-8 string

RobotRaconteur.DataTypes_cdouble_t = 12

128-bit complex double (real,imag)

RobotRaconteur.DataTypes_csingle_t = 13

64-bit complex float (real,imag)

RobotRaconteur.DataTypes_bool_t = 14

8-bit boolean

RobotRaconteur.DataTypes_structure_t = 101

structure (nested message type)

RobotRaconteur.DataTypes_vector_t = 102

map with int32 key (nested message type)

RobotRaconteur.DataTypes_dictionary_t = 103

map with string key (nested message type)

RobotRaconteur.DataTypes_object_t = 104

object type (not serializable)

RobotRaconteur.DataTypes_varvalue_t = 105

varvalue type (not serializable)

RobotRaconteur.DataTypes_varobject_t = 106

varobject type (not serializable)

RobotRaconteur.DataTypes_list_t = 108

list type (nested message type)

RobotRaconteur.DataTypes_pod_t = 109

pod type (nested message type)

RobotRaconteur.DataTypes_pod_array_t = 110

pod array type (nested message type)

RobotRaconteur.DataTypes_pod_multidimarray_t = 111

pod multidimarray type (nested message type)

RobotRaconteur.DataTypes_enum_t = 112

enum type (not serializable uses int32 for messages)

RobotRaconteur.DataTypes_namedtype_t = 113

namedtype definition (not serializable)

RobotRaconteur.DataTypes_namedarray_t = 114

namedarray type (not serializable)

RobotRaconteur.DataTypes_namedarray_array_t = 115

namedarray array type (nested message type)

RobotRaconteur.DataTypes_namedarray_multidimarray_t = 116

namedarray multidimarray type (nested message type)

RobotRaconteur.DataTypes_multidimarray_t = 117

multi-dimensional numeric array (nested message type)

RobotRaconteur.DataTypes_ArrayTypes_none = 0

type is not an array

RobotRaconteur.DataTypes_ArrayTypes_array = 1

type is a single dimensional array

RobotRaconteur.DataTypes_ArrayTypes_multidimarray = 2

type is a multidimensional array

RobotRaconteur.DataTypes_ContainerTypes_none = 0

type does not have a container

RobotRaconteur.DataTypes_ContainerTypes_list = 1

type has a list container

RobotRaconteur.DataTypes_ContainerTypes_map_int32 = 2

type has a map with int32 keys container

RobotRaconteur.DataTypes_ContainerTypes_map_string = 3

type has a map with string keys container

RobotRaconteur.DataTypes_ContainerTypes_generator = 4

type has a generator container. Only valid for use with function generator members

MessageEntryType Enum

RobotRaconteur.MessageEntryType_Null = 0

no-op

RobotRaconteur.MessageEntryType_StreamOp = 1

Stream operation request (transport only)

RobotRaconteur.MessageEntryType_StreamOpRet = 2

Stream operation response (transport only)

RobotRaconteur.MessageEntryType_StreamCheckCapability = 3

Stream check capability request (transport only)

RobotRaconteur.MessageEntryType_StreamCheckCapabilityRet = 4

Stream check capability response (transport only)

RobotRaconteur.MessageEntryType_GetServiceDesc = 101

Get service definition request

RobotRaconteur.MessageEntryType_GetServiceDescRet = 102

Get service definition response

RobotRaconteur.MessageEntryType_ObjectTypeName = 103

Get object qualified type name request

RobotRaconteur.MessageEntryType_ObjectTypeNameRet = 104

Get object qualified type name response

RobotRaconteur.MessageEntryType_ServiceClosed = 105

Service closed notification packet

RobotRaconteur.MessageEntryType_ServiceClosedRet = 106

(reserved)

RobotRaconteur.MessageEntryType_ConnectClient = 107

Connect client request

RobotRaconteur.MessageEntryType_ConnectClientRet = 108

Connect client response

RobotRaconteur.MessageEntryType_DisconnectClient = 109

Disconnect client request

RobotRaconteur.MessageEntryType_DisconnectClientRet = 110

Disconnect client response

RobotRaconteur.MessageEntryType_ConnectionTest = 111

Ping request

RobotRaconteur.MessageEntryType_ConnectionTestRet = 112

Pong response

RobotRaconteur.MessageEntryType_GetNodeInfo = 113

Get node information request (NodeID and NodeName)

RobotRaconteur.MessageEntryType_GetNodeInfoRet = 114

Get node information response

RobotRaconteur.MessageEntryType_ReconnectClient = 115

(reserved)

RobotRaconteur.MessageEntryType_ReconnectClientRet = 116

(reserved)

RobotRaconteur.MessageEntryType_NodeCheckCapability = 117

Get node capability request

RobotRaconteur.MessageEntryType_NodeCheckCapabilityRet = 118

Get node capability response

RobotRaconteur.MessageEntryType_GetServiceAttributes = 119

Get service attributes request

RobotRaconteur.MessageEntryType_GetServiceAttributesRet = 120

Get service attributes response

RobotRaconteur.MessageEntryType_ConnectClientCombined = 121

Connect client combined operation request

RobotRaconteur.MessageEntryType_ConnectClientCombinedRet = 122

Connect client combined operation response

RobotRaconteur.MessageEntryType_EndpointCheckCapability = 501

Get endpoint capability request

RobotRaconteur.MessageEntryType_EndpointCheckCapabilityRet = 502

Get endpoint capabalitiy response

RobotRaconteur.MessageEntryType_ServiceCheckCapabilityReq = 1101

Get service capability request

RobotRaconteur.MessageEntryType_ServiceCheckCapabilityRet = 1102

Get service capability response

RobotRaconteur.MessageEntryType_ClientKeepAliveReq = 1105

Client keep alive request

RobotRaconteur.MessageEntryType_ClientKeepAliveRet = 1106

Client keep alive response

RobotRaconteur.MessageEntryType_ClientSessionOpReq = 1107

Client session management operation request

RobotRaconteur.MessageEntryType_ClientSessionOpRet = 1108

Client session management operation response

RobotRaconteur.MessageEntryType_ServicePathReleasedReq = 1109

Service path released event notification packet

RobotRaconteur.MessageEntryType_ServicePathReleasedRet = 1110

(reserved)

RobotRaconteur.MessageEntryType_PropertyGetReq = 1111

Property member get request

RobotRaconteur.MessageEntryType_PropertyGetRes = 1112

Property member get response

RobotRaconteur.MessageEntryType_PropertySetReq = 1113

Property member set request

RobotRaconteur.MessageEntryType_PropertySetRes = 1114

Property member set response

RobotRaconteur.MessageEntryType_FunctionCallReq = 1121

Function member call request

RobotRaconteur.MessageEntryType_FunctionCallRes = 1122

Function member call response

RobotRaconteur.MessageEntryType_GeneratorNextReq = 1123

Generater next call request

RobotRaconteur.MessageEntryType_GeneratorNextRes = 1124

Generater next call response

RobotRaconteur.MessageEntryType_EventReq = 1131

Event member notification

RobotRaconteur.MessageEntryType_EventRes = 1132

(reserved)

RobotRaconteur.MessageEntryType_PipePacket = 1141

Pipe member packet

RobotRaconteur.MessageEntryType_PipePacketRet = 1142

Pipe member packet ack

RobotRaconteur.MessageEntryType_PipeConnectReq = 1143

Pipe member connect request

RobotRaconteur.MessageEntryType_PipeConnectRet = 1144

Pipe member connect response

RobotRaconteur.MessageEntryType_PipeDisconnectReq = 1145

Pipe member close request

RobotRaconteur.MessageEntryType_PipeDisconnectRet = 1146

Pipe member close response

RobotRaconteur.MessageEntryType_PipeClosed = 1147

Pipe member closed event notification packet

RobotRaconteur.MessageEntryType_PipeClosedRet = 1148

(reserved)

RobotRaconteur.MessageEntryType_CallbackCallReq = 1151

Callback member call request

RobotRaconteur.MessageEntryType_CallbackCallRet = 1152

Callback member call response

RobotRaconteur.MessageEntryType_WirePacket = 1161

Wire member value packet

RobotRaconteur.MessageEntryType_WirePacketRet = 1162

(reserved)

RobotRaconteur.MessageEntryType_WireConnectReq = 1163

Wire member connect request

RobotRaconteur.MessageEntryType_WireConnectRet = 1164

Wire member connect response

RobotRaconteur.MessageEntryType_WireDisconnectReq = 1165

Wire member close request

RobotRaconteur.MessageEntryType_WireDisconnectRet = 1166

Wire member close response

RobotRaconteur.MessageEntryType_WireClosed = 1167

Wire member closed event notification packet

RobotRaconteur.MessageEntryType_WireClosedRet = 1168

(reserved)

RobotRaconteur.MessageEntryType_MemoryRead = 1171

Memory member read request

RobotRaconteur.MessageEntryType_MemoryReadRet = 1172

Memory member read response

RobotRaconteur.MessageEntryType_MemoryWrite = 1173

Memory member write request

RobotRaconteur.MessageEntryType_MemoryWriteRet = 1174

Memory member write response

RobotRaconteur.MessageEntryType_MemoryGetParam = 1175

Memory member get param request

RobotRaconteur.MessageEntryType_MemoryGetParamRet = 1176

Memory member get param response

RobotRaconteur.MessageEntryType_WirePeekInValueReq = 1181

Wire member peek InValue request

RobotRaconteur.MessageEntryType_WirePeekInValueRet = 1182

Wire member peek InValue response

RobotRaconteur.MessageEntryType_WirePeekOutValueReq = 1183

Wire member peek OutValue request

RobotRaconteur.MessageEntryType_WirePeekOutValueRet = 1184

Wire member peek OutValue response

RobotRaconteur.MessageEntryType_WirePokeOutValueReq = 1185

Wire member poke OutValue request

RobotRaconteur.MessageEntryType_WirePokeOutValueRet = 1186

Wire member poke OutValue response

MessageErrorType Enum

RobotRaconteur.MessageErrorType_None = 0

success

RobotRaconteur.MessageErrorType_ConnectionError = 1

connection error

RobotRaconteur.MessageErrorType_ProtocolError = 2

protocol error serializing messages

RobotRaconteur.MessageErrorType_ServiceNotFound = 3

specified service not found

RobotRaconteur.MessageErrorType_ObjectNotFound = 4

specified object not found

RobotRaconteur.MessageErrorType_InvalidEndpoint = 5

specified endpoint not found

RobotRaconteur.MessageErrorType_EndpointCommunicationFatalError = 6

communication with specified endpoint failed

RobotRaconteur.MessageErrorType_NodeNotFound = 7

specified node not found

RobotRaconteur.MessageErrorType_ServiceError = 8

service error

RobotRaconteur.MessageErrorType_MemberNotFound = 9

specified member not found

RobotRaconteur.MessageErrorType_MemberFormatMismatch = 10

message format incompatible with specified member

RobotRaconteur.MessageErrorType_DataTypeMismatch = 11

data type did not match expected type

RobotRaconteur.MessageErrorType_DataTypeError = 12

data type failure

RobotRaconteur.MessageErrorType_DataSerializationError = 13

failure serializing data type

RobotRaconteur.MessageErrorType_MessageEntryNotFound = 14

specified message entry not found

RobotRaconteur.MessageErrorType_MessageElementNotFound = 15

specified message element not found

RobotRaconteur.MessageErrorType_UnknownError = 16

unknown exception occurred check error name

RobotRaconteur.MessageErrorType_InvalidOperation = 17

invalid operation attempted

RobotRaconteur.MessageErrorType_InvalidArgument = 18

argument is invalid

RobotRaconteur.MessageErrorType_OperationFailed = 19

the requested operation failed

RobotRaconteur.MessageErrorType_NullValue = 20

invalid null value

RobotRaconteur.MessageErrorType_InternalError = 21

internal error

RobotRaconteur.MessageErrorType_SystemResourcePermissionDenied = 22

permission denied to a system resource

RobotRaconteur.MessageErrorType_OutOfSystemResource = 23

system resource has been exhausted

RobotRaconteur.MessageErrorType_SystemResourceError = 24

system resource error

RobotRaconteur.MessageErrorType_ResourceNotFound = 25

a required resource was not found

RobotRaconteur.MessageErrorType_IOError = 26

input/output error

RobotRaconteur.MessageErrorType_BufferLimitViolation = 27

a buffer underrun/overrun has occurred

RobotRaconteur.MessageErrorType_ServiceDefinitionError = 28

service definition parse or validation error

RobotRaconteur.MessageErrorType_OutOfRange = 29

attempt to access an out of range element

RobotRaconteur.MessageErrorType_KeyNotFound = 30

key not found

RobotRaconteur.MessageErrorType_InvalidConfiguration = 31

invalid configuration specified

RobotRaconteur.MessageErrorType_InvalidState = 32

invalid state

RobotRaconteur.MessageErrorType_RemoteError = 100

error occurred on remote node

RobotRaconteur.MessageErrorType_RequestTimeout = 101

request timed out

RobotRaconteur.MessageErrorType_ReadOnlyMember = 102

attempt to write to a read only member

RobotRaconteur.MessageErrorType_WriteOnlyMember = 103

attempt to read a write only member

RobotRaconteur.MessageErrorType_NotImplementedError = 104

member not implemented

RobotRaconteur.MessageErrorType_MemberBusy = 105

member is busy try again

RobotRaconteur.MessageErrorType_ValueNotSet = 106

value has not been set

RobotRaconteur.MessageErrorType_AbortOperation = 107

abort operation (generator only)

RobotRaconteur.MessageErrorType_OperationAborted = 108

the operation has been aborted

RobotRaconteur.MessageErrorType_StopIteration = 109

stop generator iteration (generator only)

RobotRaconteur.MessageErrorType_OperationTimeout = 110

the operation has timed out

RobotRaconteur.MessageErrorType_OperationCancelled = 111

the operation has been cancelled

RobotRaconteur.MessageErrorType_AuthenticationError = 150

authentication has failed

RobotRaconteur.MessageErrorType_ObjectLockedError = 151

the object is locked by another user or session

RobotRaconteur.MessageErrorType_PermissionDenied = 152

permission to service object or resource denied

ClientServiceListenerEventType Enum

RobotRaconteur.ClientServiceListenerEventType_ClientClosed = 1

client has been closed

RobotRaconteur.ClientServiceListenerEventType_ClientConnectionTimeout = 2

client connection has timed out

RobotRaconteur.ClientServiceListenerEventType_TransportConnectionConnected = 3

client transport has been connected

RobotRaconteur.ClientServiceListenerEventType_TransportConnectionClosed = 4

client transport connection has been closed or lost

RobotRaconteur.ClientServiceListenerEventType_ServicePathReleased   :value: 5

client has received notification that service path was released

ServerServiceListenerEventType Enum

RobotRaconteur.ServerServiceListenerEventType_ServiceClosed = 1

service has been closed

RobotRaconteur.ServerServiceListenerEventType_ClientConnected = 2

client has connected

RobotRaconteur.ServerServiceListenerEventType_ClientDisconnected = 3

client has disconnected

MemberDefinition Enum

RobotRaconteur.MemberDefinition_Direction_both = 0

member supports read and write

RobotRaconteur.MemberDefinition_Direction_readonly = 1

member is readonly

RobotRaconteur.MemberDefinition_Direction_writeonly = 2

member is writeonly

RobotRaconteur.MemberDefinition_NoLock_none = 0

member cannot be accessed by other users/sessions when object is locked

RobotRaconteur.MemberDefinition_NoLock_all = 1

member can be accessed by other users/sessions when object is locked

RobotRaconteur.MemberDefinition_NoLock_read = 2

member can be read by other users/sessions when object is locked

Misc Constants

RobotRaconteur.RR_TIMEOUT_INFINITE = -1

Disable timeout for asynchronous operations

RobotRaconteur.RR_VALUE_LIFESPAN_INFINITE = -1

Set wire values to have infinite lifespan and will not expire

RobotRaconteurObjectLockFlags Enum

RobotRaconteur.RobotRaconteurObjectLockFlags_USER_LOCK = 0

User level lock

The object will be accesible for all client connections authenticated by the current user

RobotRaconteur.RobotRaconteurObjectLockFlags_CLIENT_LOCK = 1

Client level lock

Only the current client connection will have access to the locked object