RobotRaconteurConstants.h File Reference

Go to the source code of this file.

Macros
#define	RR_TIMEOUT_INFINITE   (-1)
	Disable timeout for asynchronous operations. More...
#define	RR_VALUE_LIFESPAN_INFINITE   (-1)
	Set wire values to have infinite lifespan and will not expire. More...

Enumerations
enum	RobotRaconteur::DataTypes {   RobotRaconteur::DataTypes_void_t = 0 , RobotRaconteur::DataTypes_double_t , RobotRaconteur::DataTypes_single_t , RobotRaconteur::DataTypes_int8_t ,   RobotRaconteur::DataTypes_uint8_t , RobotRaconteur::DataTypes_int16_t , RobotRaconteur::DataTypes_uint16_t , RobotRaconteur::DataTypes_int32_t ,   RobotRaconteur::DataTypes_uint32_t , RobotRaconteur::DataTypes_int64_t , RobotRaconteur::DataTypes_uint64_t , RobotRaconteur::DataTypes_string_t ,   RobotRaconteur::DataTypes_cdouble_t , RobotRaconteur::DataTypes_csingle_t , RobotRaconteur::DataTypes_bool_t , RobotRaconteur::DataTypes_structure_t = 101 ,   RobotRaconteur::DataTypes_vector_t , RobotRaconteur::DataTypes_dictionary_t , RobotRaconteur::DataTypes_object_t , RobotRaconteur::DataTypes_varvalue_t ,   RobotRaconteur::DataTypes_varobject_t , RobotRaconteur::DataTypes_list_t = 108 , RobotRaconteur::DataTypes_pod_t , RobotRaconteur::DataTypes_pod_array_t ,   RobotRaconteur::DataTypes_pod_multidimarray_t , RobotRaconteur::DataTypes_enum_t , RobotRaconteur::DataTypes_namedtype_t , RobotRaconteur::DataTypes_namedarray_t ,   RobotRaconteur::DataTypes_namedarray_array_t , RobotRaconteur::DataTypes_namedarray_multidimarray_t , RobotRaconteur::DataTypes_multidimarray_t }
	Type codes for types supported by Robot Raconteur. More...
enum	RobotRaconteur::DataTypes_ArrayTypes { RobotRaconteur::DataTypes_ArrayTypes_none = 0 , RobotRaconteur::DataTypes_ArrayTypes_array , RobotRaconteur::DataTypes_ArrayTypes_multidimarray }
	Array type enum for TypeDefinition parser class. More...
enum	RobotRaconteur::DataTypes_ContainerTypes {   RobotRaconteur::DataTypes_ContainerTypes_none = 0 , RobotRaconteur::DataTypes_ContainerTypes_list , RobotRaconteur::DataTypes_ContainerTypes_map_int32 , RobotRaconteur::DataTypes_ContainerTypes_map_string ,   RobotRaconteur::DataTypes_ContainerTypes_generator }
	Container type enum for TypeDefinition parser class. More...
enum	RobotRaconteur::MessageEntryType {   RobotRaconteur::MessageEntryType_Null = 0 , RobotRaconteur::MessageEntryType_StreamOp = 1 , RobotRaconteur::MessageEntryType_StreamOpRet , RobotRaconteur::MessageEntryType_StreamCheckCapability ,   RobotRaconteur::MessageEntryType_StreamCheckCapabilityRet , RobotRaconteur::MessageEntryType_GetServiceDesc = 101 , RobotRaconteur::MessageEntryType_GetServiceDescRet , RobotRaconteur::MessageEntryType_ObjectTypeName ,   RobotRaconteur::MessageEntryType_ObjectTypeNameRet , RobotRaconteur::MessageEntryType_ServiceClosed , RobotRaconteur::MessageEntryType_ServiceClosedRet , RobotRaconteur::MessageEntryType_ConnectClient ,   RobotRaconteur::MessageEntryType_ConnectClientRet , RobotRaconteur::MessageEntryType_DisconnectClient , RobotRaconteur::MessageEntryType_DisconnectClientRet , RobotRaconteur::MessageEntryType_ConnectionTest ,   RobotRaconteur::MessageEntryType_ConnectionTestRet , RobotRaconteur::MessageEntryType_GetNodeInfo , RobotRaconteur::MessageEntryType_GetNodeInfoRet , RobotRaconteur::MessageEntryType_ReconnectClient ,   RobotRaconteur::MessageEntryType_ReconnectClientRet , RobotRaconteur::MessageEntryType_NodeCheckCapability , RobotRaconteur::MessageEntryType_NodeCheckCapabilityRet , RobotRaconteur::MessageEntryType_GetServiceAttributes ,   RobotRaconteur::MessageEntryType_GetServiceAttributesRet , RobotRaconteur::MessageEntryType_ConnectClientCombined , RobotRaconteur::MessageEntryType_ConnectClientCombinedRet , RobotRaconteur::MessageEntryType_EndpointCheckCapability = 501 ,   RobotRaconteur::MessageEntryType_EndpointCheckCapabilityRet , RobotRaconteur::MessageEntryType_ServiceCheckCapabilityReq = 1101 , RobotRaconteur::MessageEntryType_ServiceCheckCapabilityRet , RobotRaconteur::MessageEntryType_ClientKeepAliveReq = 1105 ,   RobotRaconteur::MessageEntryType_ClientKeepAliveRet , RobotRaconteur::MessageEntryType_ClientSessionOpReq = 1107 , RobotRaconteur::MessageEntryType_ClientSessionOpRet , RobotRaconteur::MessageEntryType_ServicePathReleasedReq ,   RobotRaconteur::MessageEntryType_ServicePathReleasedRet , RobotRaconteur::MessageEntryType_PropertyGetReq = 1111 , RobotRaconteur::MessageEntryType_PropertyGetRes , RobotRaconteur::MessageEntryType_PropertySetReq ,   RobotRaconteur::MessageEntryType_PropertySetRes , RobotRaconteur::MessageEntryType_FunctionCallReq = 1121 , RobotRaconteur::MessageEntryType_FunctionCallRes , RobotRaconteur::MessageEntryType_GeneratorNextReq ,   RobotRaconteur::MessageEntryType_GeneratorNextRes , RobotRaconteur::MessageEntryType_EventReq = 1131 , RobotRaconteur::MessageEntryType_EventRes , RobotRaconteur::MessageEntryType_PipePacket = 1141 ,   RobotRaconteur::MessageEntryType_PipePacketRet , RobotRaconteur::MessageEntryType_PipeConnectReq , RobotRaconteur::MessageEntryType_PipeConnectRet , RobotRaconteur::MessageEntryType_PipeDisconnectReq ,   RobotRaconteur::MessageEntryType_PipeDisconnectRet , RobotRaconteur::MessageEntryType_PipeClosed , RobotRaconteur::MessageEntryType_PipeClosedRet , RobotRaconteur::MessageEntryType_CallbackCallReq = 1151 ,   RobotRaconteur::MessageEntryType_CallbackCallRet , RobotRaconteur::MessageEntryType_WirePacket = 1161 , RobotRaconteur::MessageEntryType_WirePacketRet , RobotRaconteur::MessageEntryType_WireConnectReq ,   RobotRaconteur::MessageEntryType_WireConnectRet , RobotRaconteur::MessageEntryType_WireDisconnectReq , RobotRaconteur::MessageEntryType_WireDisconnectRet , RobotRaconteur::MessageEntryType_WireClosed ,   RobotRaconteur::MessageEntryType_WireClosedRet , RobotRaconteur::MessageEntryType_MemoryRead = 1171 , RobotRaconteur::MessageEntryType_MemoryReadRet , RobotRaconteur::MessageEntryType_MemoryWrite ,   RobotRaconteur::MessageEntryType_MemoryWriteRet , RobotRaconteur::MessageEntryType_MemoryGetParam , RobotRaconteur::MessageEntryType_MemoryGetParamRet , RobotRaconteur::MessageEntryType_WirePeekInValueReq = 1181 ,   RobotRaconteur::MessageEntryType_WirePeekInValueRet , RobotRaconteur::MessageEntryType_WirePeekOutValueReq , RobotRaconteur::MessageEntryType_WirePeekOutValueRet , RobotRaconteur::MessageEntryType_WirePokeOutValueReq ,   RobotRaconteur::MessageEntryType_WirePokeOutValueRet , MessageEntryType_WireTransportOpReq = 11161 , MessageEntryType_WireTransportOpRet , MessageEntryType_WireTransportEvent ,   MessageEntryType_WireTransportEventRet }
	Message entry type codes. More...
enum	RobotRaconteur::MessageErrorType {   RobotRaconteur::MessageErrorType_None = 0 , RobotRaconteur::MessageErrorType_ConnectionError = 1 , RobotRaconteur::MessageErrorType_ProtocolError , RobotRaconteur::MessageErrorType_ServiceNotFound ,   RobotRaconteur::MessageErrorType_ObjectNotFound , RobotRaconteur::MessageErrorType_InvalidEndpoint , RobotRaconteur::MessageErrorType_EndpointCommunicationFatalError , RobotRaconteur::MessageErrorType_NodeNotFound ,   RobotRaconteur::MessageErrorType_ServiceError , RobotRaconteur::MessageErrorType_MemberNotFound , RobotRaconteur::MessageErrorType_MemberFormatMismatch , RobotRaconteur::MessageErrorType_DataTypeMismatch ,   RobotRaconteur::MessageErrorType_DataTypeError , RobotRaconteur::MessageErrorType_DataSerializationError , RobotRaconteur::MessageErrorType_MessageEntryNotFound , RobotRaconteur::MessageErrorType_MessageElementNotFound ,   RobotRaconteur::MessageErrorType_UnknownError , RobotRaconteur::MessageErrorType_InvalidOperation , RobotRaconteur::MessageErrorType_InvalidArgument , RobotRaconteur::MessageErrorType_OperationFailed ,   RobotRaconteur::MessageErrorType_NullValue , RobotRaconteur::MessageErrorType_InternalError , RobotRaconteur::MessageErrorType_SystemResourcePermissionDenied , RobotRaconteur::MessageErrorType_OutOfSystemResource ,   RobotRaconteur::MessageErrorType_SystemResourceError , RobotRaconteur::MessageErrorType_ResourceNotFound , RobotRaconteur::MessageErrorType_IOError , RobotRaconteur::MessageErrorType_BufferLimitViolation ,   RobotRaconteur::MessageErrorType_ServiceDefinitionError , RobotRaconteur::MessageErrorType_OutOfRange , RobotRaconteur::MessageErrorType_KeyNotFound , RobotRaconteur::MessageErrorType_InvalidConfiguration ,   RobotRaconteur::MessageErrorType_InvalidState , RobotRaconteur::MessageErrorType_RemoteError = 100 , RobotRaconteur::MessageErrorType_RequestTimeout , RobotRaconteur::MessageErrorType_ReadOnlyMember ,   RobotRaconteur::MessageErrorType_WriteOnlyMember , RobotRaconteur::MessageErrorType_NotImplementedError , RobotRaconteur::MessageErrorType_MemberBusy , RobotRaconteur::MessageErrorType_ValueNotSet ,   RobotRaconteur::MessageErrorType_AbortOperation , RobotRaconteur::MessageErrorType_OperationAborted , RobotRaconteur::MessageErrorType_StopIteration , RobotRaconteur::MessageErrorType_OperationTimeout ,   RobotRaconteur::MessageErrorType_OperationCancelled , RobotRaconteur::MessageErrorType_AuthenticationError = 150 , RobotRaconteur::MessageErrorType_ObjectLockedError , RobotRaconteur::MessageErrorType_PermissionDenied }
	Message error type codes enum. More...
enum	RobotRaconteur::ClientServiceListenerEventType {   RobotRaconteur::ClientServiceListenerEventType_ClientClosed = 1 , RobotRaconteur::ClientServiceListenerEventType_ClientConnectionTimeout , RobotRaconteur::ClientServiceListenerEventType_TransportConnectionConnected , RobotRaconteur::ClientServiceListenerEventType_TransportConnectionClosed ,   RobotRaconteur::ClientServiceListenerEventType_ServicePathReleased }
	Enum of client listener events. More...
enum	RobotRaconteur::ServerServiceListenerEventType { RobotRaconteur::ServerServiceListenerEventType_ServiceClosed = 1 , RobotRaconteur::ServerServiceListenerEventType_ClientConnected , RobotRaconteur::ServerServiceListenerEventType_ClientDisconnected }
	Enum of service listener events. More...
enum	RobotRaconteur::MemberDefinition_Direction { RobotRaconteur::MemberDefinition_Direction_both = 0 , RobotRaconteur::MemberDefinition_Direction_readonly , RobotRaconteur::MemberDefinition_Direction_writeonly }
	Member direction enum. More...
enum	RobotRaconteur::MemberDefinition_NoLock { RobotRaconteur::MemberDefinition_NoLock_none = 0 , RobotRaconteur::MemberDefinition_NoLock_all , RobotRaconteur::MemberDefinition_NoLock_read }
	Member locking options enum. More...
enum	RobotRaconteur::RobotRaconteur_LogLevel {   RobotRaconteur::RobotRaconteur_LogLevel_Trace , RobotRaconteur::RobotRaconteur_LogLevel_Debug , RobotRaconteur::RobotRaconteur_LogLevel_Info , RobotRaconteur::RobotRaconteur_LogLevel_Warning ,   RobotRaconteur::RobotRaconteur_LogLevel_Error , RobotRaconteur::RobotRaconteur_LogLevel_Fatal , RobotRaconteur::RobotRaconteur_LogLevel_Disable = 1000 }
	Log level enum. More...
enum	RobotRaconteur::RobotRaconteur_LogComponent {   RobotRaconteur::RobotRaconteur_LogComponent_Default , RobotRaconteur::RobotRaconteur_LogComponent_Node , RobotRaconteur::RobotRaconteur_LogComponent_Transport , RobotRaconteur::RobotRaconteur_LogComponent_Message ,   RobotRaconteur::RobotRaconteur_LogComponent_Client , RobotRaconteur::RobotRaconteur_LogComponent_Service , RobotRaconteur::RobotRaconteur_LogComponent_Member , RobotRaconteur::RobotRaconteur_LogComponent_Pack ,   RobotRaconteur::RobotRaconteur_LogComponent_Unpack , RobotRaconteur::RobotRaconteur_LogComponent_ServiceDefinition , RobotRaconteur::RobotRaconteur_LogComponent_Discovery , RobotRaconteur::RobotRaconteur_LogComponent_Subscription ,   RobotRaconteur::RobotRaconteur_LogComponent_NodeSetup , RobotRaconteur::RobotRaconteur_LogComponent_Utility , RobotRaconteur::RobotRaconteur_LogComponent_RobDefLib , RobotRaconteur::RobotRaconteur_LogComponent_User ,   RobotRaconteur::RobotRaconteur_LogComponent_UserClient , RobotRaconteur::RobotRaconteur_LogComponent_UserService , RobotRaconteur::RobotRaconteur_LogComponent_ThirdParty }
	Log component enum. More...

Variables
const uint8_t	RobotRaconteur::MessageFlags_ROUTING_INFO = 0x01
	Message contains ROUTING_INFO section.
const uint8_t	RobotRaconteur::MessageFlags_ENDPOINT_INFO = 0x02
	Message contains ENDPOINT_INFO section.
const uint8_t	RobotRaconteur::MessageFlags_PRIORITY = 0x04
	Message contains PRIORITY section.
const uint8_t	RobotRaconteur::MessageFlags_UNRELIABLE = 0x08
	Message is unreliable and may be dropped.
const uint8_t	RobotRaconteur::MessageFlags_META_INFO = 0x10
	Message contains META_INFO section.
const uint8_t	RobotRaconteur::MessageFlags_STRING_TABLE = 0x20
	Message contains STRING_TABLE section.
const uint8_t	RobotRaconteur::MessageFlags_MULTIPLE_ENTRIES = 0x40
	Message contains MULTIPLE_ENTRIES section. If unset, message contains one entry.
const uint8_t	RobotRaconteur::MessageFlags_EXTENDED = 0x80
	Message contains EXTENDED section.
const uint8_t	RobotRaconteur::MessageFlags_Version2Compat
	Message flags for compatibility with Message Format Version 2.
const uint8_t	RobotRaconteur::MessageEntryFlags_SERVICE_PATH_STR = 0x01
	MessageEntry contains SERVICE_PATH_STR section.
const uint8_t	RobotRaconteur::MessageEntryFlags_SERVICE_PATH_CODE = 0x02
	MessageEntry contains SERVICE_PATH_CODE section.
const uint8_t	RobotRaconteur::MessageEntryFlags_MEMBER_NAME_STR = 0x04
	MessageEntry contains MEMBER_NAME_STR section.
const uint8_t	RobotRaconteur::MessageEntryFlags_MEMBER_NAME_CODE = 0x08
	MessageEntry contains MEMBER_NAME_CODE section.
const uint8_t	RobotRaconteur::MessageEntryFlags_REQUEST_ID = 0x10
	MessageEntry contains REQUEST_ID section.
const uint8_t	RobotRaconteur::MessageEntryFlags_ERROR = 0x20
	MessageEntry contains ERROR section.
const uint8_t	RobotRaconteur::MessageEntryFlags_META_INFO = 0x40
	MessageEntry contains META_INFO section.
const uint8_t	RobotRaconteur::MessageEntryFlags_EXTENDED = 0x80
	MessageEntry contains EXTENDED section.
const uint8_t	RobotRaconteur::MessageEntryFlags_Version2Compat
	MessageEntry flags for compatibility with Message Format Version 2.
const uint8_t	RobotRaconteur::MessageElementFlags_ELEMENT_NAME_STR = 0x01
	MessageElement contains ELEMENT_NAME_STR section.
const uint8_t	RobotRaconteur::MessageElementFlags_ELEMENT_NAME_CODE = 0x02
	MessageElement contains ELEMENT_NAME_CODE section.
const uint8_t	RobotRaconteur::MessageElementFlags_ELEMENT_NUMBER = 0x04
	MessageElement contains ELEMENT_NUMBER section.
const uint8_t	RobotRaconteur::MessageElementFlags_ELEMENT_TYPE_NAME_STR = 0x08
	MessageElement contains ELEMENT_TYPE_NAME_STR section.
const uint8_t	RobotRaconteur::MessageElementFlags_ELEMENT_TYPE_NAME_CODE = 0x10
	MessageElement contains ELEMENT_TYPE_NAME_CODE section.
const uint8_t	RobotRaconteur::MessageElementFlags_META_INFO = 0x20
	MessageElement contains META_INFO section.
const uint8_t	RobotRaconteur::MessageElementFlags_EXTENDED = 0x80
	MessageElement contains EXTENDED section.
const uint8_t	RobotRaconteur::MessageElementFlags_Version2Compat
	MessageElement flags for compatibility with Message Format Version 2.
const uint32_t	RobotRaconteur::TranspartCapabilityCode_PAGE_MASK = 0xFFF00000
	Page mask for transport capability code.
const uint32_t	RobotRaconteur::TransportCapabilityCode_MESSAGE2_BASIC_PAGE = 0x02000000
	Message Version 2 transport capability page code.
const uint32_t	RobotRaconteur::TransportCapabilityCode_MESSAGE2_BASIC_ENABLE = 0x00000001
	Enable Message Version 2 transport capability flag.
const uint32_t	RobotRaconteur::TransportCapabilityCode_MESSAGE2_BASIC_CONNECTCOMBINED = 0x00000002
	Enable Message Version 2 connect combined transport capability flag.
const uint32_t	RobotRaconteur::TransportCapabilityCode_MESSAGE4_BASIC_PAGE = 0x04000000
	Message Version 4 transport capability page code.
const uint32_t	RobotRaconteur::TransportCapabilityCode_MESSAGE4_BASIC_ENABLE = 0x00000001
	Enable Message Version 4 transport capability flag.
const uint32_t	RobotRaconteur::TransportCapabilityCode_MESSAGE4_BASIC_CONNECTCOMBINED = 0x00000002
	Enable Message Version 4 connect combine transport capability flag.
const uint32_t	RobotRaconteur::TransportCapabilityCode_MESSAGE4_STRINGTABLE_PAGE = 0x04100000
	Message Version 4 String Table capability page code.
const uint32_t	RobotRaconteur::TransportCapabilityCode_MESSAGE4_STRINGTABLE_ENABLE = 0x00000001
	Enable Message Version 4 String Table transport capability code.
const uint32_t	RobotRaconteur::TransportCapabilityCode_MESSAGE4_STRINGTABLE_MESSAGE_LOCAL = 0x00000002
	Enable Message Version 4 local String Table capability code.
const uint32_t	RobotRaconteur::TransportCapabilityCode_MESSAGE4_STRINGTABLE_STANDARD_TABLE = 0x00000004
	Enable Message Version 4 standard String Table capability code.

Detailed Description

Author

John Wason, PhD

Copyright

Copyright 2011-2020 Wason Technology, LLC

License

Software License Agreement (Apache License)

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Macro Definition Documentation

RR_TIMEOUT_INFINITE

#define RR_TIMEOUT_INFINITE   (-1)

Disable timeout for asynchronous operations.

Pass RR_TIMEOUT_INFINITE for the timeout parameter in asynchronous operations to disable timeout for that operation.

RR_VALUE_LIFESPAN_INFINITE

#define RR_VALUE_LIFESPAN_INFINITE   (-1)

Set wire values to have infinite lifespan and will not expire.

Wire values may optionally expire after a given period in milliseconds. Set RR_TIMEOUT_INFINITE to disable value expiration.

Enumeration Type Documentation

ClientServiceListenerEventType

enum RobotRaconteur::ClientServiceListenerEventType

Enum of client listener events.

Enumerator
ClientServiceListenerEventType_ClientClosed	client has been closed
ClientServiceListenerEventType_ClientConnectionTimeout	client connection has timed out
ClientServiceListenerEventType_TransportConnectionConnected	client transport has been connected
ClientServiceListenerEventType_TransportConnectionClosed	client transport connection has been closed or lost
ClientServiceListenerEventType_ServicePathReleased	client has received notification that service path was released

DataTypes

enum RobotRaconteur::DataTypes

Type codes for types supported by Robot Raconteur.

Data type codes are used in messages and service definition parsers.

Data is always stored as little-endian, except for UUID which are big endian

Enumerator
DataTypes_void_t	void or null type
DataTypes_double_t	IEEE-754 64-bit floating point number.
DataTypes_single_t	IEEE-754 32-bit floating point number.
DataTypes_int8_t	8-bit signed integer
DataTypes_uint8_t	8-bit unsigned integer
DataTypes_int16_t	16-bit signed integer
DataTypes_uint16_t	16-bit unsigned integer
DataTypes_int32_t	32-bit signed integer
DataTypes_uint32_t	32-bit unsigned integer
DataTypes_int64_t	64-bit signed integer
DataTypes_uint64_t	64-bit unsigned integer
DataTypes_string_t	UTF-8 string.
DataTypes_cdouble_t	128-bit complex double (real,imag)
DataTypes_csingle_t	64-bit complex float (real,imag)
DataTypes_bool_t	8-bit boolean
DataTypes_structure_t	structure (nested message type)
DataTypes_vector_t	map with int32 key (nested message type)
DataTypes_dictionary_t	map with string key (nested message type)
DataTypes_object_t	object type (not serializable)
DataTypes_varvalue_t	varvalue type (not serializable)
DataTypes_varobject_t	varobject type (not serializable)
DataTypes_list_t	list type (nested message type)
DataTypes_pod_t	pod type (nested message type)
DataTypes_pod_array_t	pod array type (nested message type)
DataTypes_pod_multidimarray_t	pod multidimarray type (nested message type)
DataTypes_enum_t	enum type (not serializable, uses int32 for messages)
DataTypes_namedtype_t	namedtype definition (not serializable)
DataTypes_namedarray_t	namedarray type (not serializable)
DataTypes_namedarray_array_t	namedarray array type (nested message type)
DataTypes_namedarray_multidimarray_t	namedarray multidimarray type (nested message type)
DataTypes_multidimarray_t	multi-dimensional numeric array (nested message type)

DataTypes_ArrayTypes

enum RobotRaconteur::DataTypes_ArrayTypes

Array type enum for TypeDefinition parser class.

Enumerator
DataTypes_ArrayTypes_none	type is not an array
DataTypes_ArrayTypes_array	type is a single dimensional array
DataTypes_ArrayTypes_multidimarray	type is a multidimensional array

DataTypes_ContainerTypes

enum RobotRaconteur::DataTypes_ContainerTypes

Container type enum for TypeDefinition parser class.

Enumerator
DataTypes_ContainerTypes_none	type does not have a container
DataTypes_ContainerTypes_list	type has a list container
DataTypes_ContainerTypes_map_int32	type has a map with int32 keys container
DataTypes_ContainerTypes_map_string	type has a map with string keys container
DataTypes_ContainerTypes_generator	type has a generator container Only valid for use with function generator members

MemberDefinition_Direction

enum RobotRaconteur::MemberDefinition_Direction

Member direction enum.

Use member modifiers to declare member direction (readonly,writeonly)

Enumerator
MemberDefinition_Direction_both	member supports read and write
MemberDefinition_Direction_readonly	member is readonly
MemberDefinition_Direction_writeonly	member is writeonly

MemberDefinition_NoLock

enum RobotRaconteur::MemberDefinition_NoLock

Member locking options enum.

Use member modifiers to declare lock options

Enumerator
MemberDefinition_NoLock_none	member cannot be accessed by other users/sessions when object is locked
MemberDefinition_NoLock_all	member can be accessed by other users/sessions when object is locked
MemberDefinition_NoLock_read	member can be read by other users/sessions when object is locked

MessageEntryType

enum RobotRaconteur::MessageEntryType

Message entry type codes.

Message entries are sent between nodes stored in messages, and represent requests, responses, or packets. The type of the entry is specified through the message entry type code. These type codes are similar to op-codes. This enum contains the defined entry type codes.

Odd codes represent requests or packets, even codes represent responses.

Entry types less than 500 are considered "special requests" that can be used before a session is established.

Enumerator
MessageEntryType_Null	no-op
MessageEntryType_StreamOp	Stream operation request (transport only)
MessageEntryType_StreamOpRet	Stream operation response (transport only)
MessageEntryType_StreamCheckCapability	Stream check capability request (transport only)
MessageEntryType_StreamCheckCapabilityRet	Stream check capability response (transport only)
MessageEntryType_GetServiceDesc	Get service definition request.
MessageEntryType_GetServiceDescRet	Get service definition response.
MessageEntryType_ObjectTypeName	Get object qualified type name request.
MessageEntryType_ObjectTypeNameRet	Get object qualified type name response.
MessageEntryType_ServiceClosed	Service closed notification packet.
MessageEntryType_ServiceClosedRet	(reserved)
MessageEntryType_ConnectClient	Connect client request.
MessageEntryType_ConnectClientRet	Connect client response.
MessageEntryType_DisconnectClient	Disconnect client request.
MessageEntryType_DisconnectClientRet	Disconnect client response.
MessageEntryType_ConnectionTest	Ping request.
MessageEntryType_ConnectionTestRet	Pong response.
MessageEntryType_GetNodeInfo	Get node information request (NodeID and NodeName)
MessageEntryType_GetNodeInfoRet	Get node information response.
MessageEntryType_ReconnectClient	(reserved)
MessageEntryType_ReconnectClientRet	(reserved)
MessageEntryType_NodeCheckCapability	Get node capability request.
MessageEntryType_NodeCheckCapabilityRet	Get node capability response.
MessageEntryType_GetServiceAttributes	Get service attributes request.
MessageEntryType_GetServiceAttributesRet	Get service attributes response.
MessageEntryType_ConnectClientCombined	Connect client combined operation request.
MessageEntryType_ConnectClientCombinedRet	Connect client combined operation response.
MessageEntryType_EndpointCheckCapability	Get endpoint capability request.
MessageEntryType_EndpointCheckCapabilityRet	Get endpoint capabalitiy response.
MessageEntryType_ServiceCheckCapabilityReq	Get service capability request.
MessageEntryType_ServiceCheckCapabilityRet	Get service capability response.
MessageEntryType_ClientKeepAliveReq	Client keep alive request.
MessageEntryType_ClientKeepAliveRet	Client keep alive response.
MessageEntryType_ClientSessionOpReq	Client session management operation request.
MessageEntryType_ClientSessionOpRet	Client session management operation response.
MessageEntryType_ServicePathReleasedReq	Service path released event notification packet.
MessageEntryType_ServicePathReleasedRet	(reserved)
MessageEntryType_PropertyGetReq	Property member get request.
MessageEntryType_PropertyGetRes	Property member get response.
MessageEntryType_PropertySetReq	Property member set request.
MessageEntryType_PropertySetRes	Property member set response.
MessageEntryType_FunctionCallReq	Function member call request.
MessageEntryType_FunctionCallRes	Function member call response.
MessageEntryType_GeneratorNextReq	Generater next call request.
MessageEntryType_GeneratorNextRes	Generater next call response.
MessageEntryType_EventReq	Event member notification.
MessageEntryType_EventRes	(reserved)
MessageEntryType_PipePacket	Pipe member packet.
MessageEntryType_PipePacketRet	Pipe member packet ack.
MessageEntryType_PipeConnectReq	Pipe member connect request.
MessageEntryType_PipeConnectRet	Pipe member connect response.
MessageEntryType_PipeDisconnectReq	Pipe member close request.
MessageEntryType_PipeDisconnectRet	Pipe member close response.
MessageEntryType_PipeClosed	Pipe member closed event notification packet.
MessageEntryType_PipeClosedRet	(reserved)
MessageEntryType_CallbackCallReq	Callback member call request.
MessageEntryType_CallbackCallRet	Callback member call response.
MessageEntryType_WirePacket	Wire member value packet.
MessageEntryType_WirePacketRet	(reserved)
MessageEntryType_WireConnectReq	Wire member connect request.
MessageEntryType_WireConnectRet	Wire member connect response.
MessageEntryType_WireDisconnectReq	Wire member close request.
MessageEntryType_WireDisconnectRet	Wire member close response.
MessageEntryType_WireClosed	Wire member closed event notification packet.
MessageEntryType_WireClosedRet	(reserved)
MessageEntryType_MemoryRead	Memory member read request.
MessageEntryType_MemoryReadRet	Memory member read response.
MessageEntryType_MemoryWrite	Memory member write request.
MessageEntryType_MemoryWriteRet	Memory member write response.
MessageEntryType_MemoryGetParam	Memory member get param request.
MessageEntryType_MemoryGetParamRet	Memory member get param response.
MessageEntryType_WirePeekInValueReq	Wire member peek InValue request.
MessageEntryType_WirePeekInValueRet	Wire member peek InValue response.
MessageEntryType_WirePeekOutValueReq	Wire member peek OutValue request.
MessageEntryType_WirePeekOutValueRet	Wire member peek OutValue response.
MessageEntryType_WirePokeOutValueReq	Wire member poke OutValue request.
MessageEntryType_WirePokeOutValueRet	Wire member poke OutValue response.

MessageErrorType

enum RobotRaconteur::MessageErrorType

Message error type codes enum.

Enumerator
MessageErrorType_None	success
MessageErrorType_ConnectionError	connection error
MessageErrorType_ProtocolError	protocol error serializing messages
MessageErrorType_ServiceNotFound	specified service not found
MessageErrorType_ObjectNotFound	specified object not found
MessageErrorType_InvalidEndpoint	specified endpoint not found
MessageErrorType_EndpointCommunicationFatalError	communication with specified endpoint failed
MessageErrorType_NodeNotFound	specified node not found
MessageErrorType_ServiceError	service error
MessageErrorType_MemberNotFound	specified member not found
MessageErrorType_MemberFormatMismatch	message format incompatible with specified member
MessageErrorType_DataTypeMismatch	data type did not match expected type
MessageErrorType_DataTypeError	data type failure
MessageErrorType_DataSerializationError	failure serializing data type
MessageErrorType_MessageEntryNotFound	specified message entry not found
MessageErrorType_MessageElementNotFound	specified message element not found
MessageErrorType_UnknownError	unknown exception occurred, check error name
MessageErrorType_InvalidOperation	invalid operation attempted
MessageErrorType_InvalidArgument	argument is invalid
MessageErrorType_OperationFailed	the requested operation failed
MessageErrorType_NullValue	invalid null value
MessageErrorType_InternalError	internal error
MessageErrorType_SystemResourcePermissionDenied	permission denied to a system resource
MessageErrorType_OutOfSystemResource	system resource has been exhausted
MessageErrorType_SystemResourceError	system resource error
MessageErrorType_ResourceNotFound	a required resource was not found
MessageErrorType_IOError	input/output error
MessageErrorType_BufferLimitViolation	a buffer underrun/overrun has occurred
MessageErrorType_ServiceDefinitionError	service definition parse or validation error
MessageErrorType_OutOfRange	attempt to access an out of range element
MessageErrorType_KeyNotFound	key not found
MessageErrorType_InvalidConfiguration	invalid configuration specified
MessageErrorType_InvalidState	invalid state
MessageErrorType_RemoteError	error occurred on remote node
MessageErrorType_RequestTimeout	request timed out
MessageErrorType_ReadOnlyMember	attempt to write to a read only member
MessageErrorType_WriteOnlyMember	attempt to read a write only member
MessageErrorType_NotImplementedError	member not implemented
MessageErrorType_MemberBusy	member is busy, try again
MessageErrorType_ValueNotSet	value has not been set
MessageErrorType_AbortOperation	abort operation (generator only)
MessageErrorType_OperationAborted	the operation has been aborted
MessageErrorType_StopIteration	stop generator iteration (generator only)
MessageErrorType_OperationTimeout	the operation has timed out
MessageErrorType_OperationCancelled	the operation has been cancelled
MessageErrorType_AuthenticationError	authentication has failed
MessageErrorType_ObjectLockedError	the object is locked by another user or session
MessageErrorType_PermissionDenied	permission to service object or resource denied

RobotRaconteur_LogComponent

enum RobotRaconteur::RobotRaconteur_LogComponent

Log component enum.

Log records contain the code of the component where the log record was generated

Enumerator
RobotRaconteur_LogComponent_Default	default component
RobotRaconteur_LogComponent_Node	Robot Raconteur Node component.
RobotRaconteur_LogComponent_Transport	tranport component
RobotRaconteur_LogComponent_Message	message or message serialization component
RobotRaconteur_LogComponent_Client	client component
RobotRaconteur_LogComponent_Service	service component
RobotRaconteur_LogComponent_Member	member component
RobotRaconteur_LogComponent_Pack	data message packing component
RobotRaconteur_LogComponent_Unpack	data message unpacknig component
RobotRaconteur_LogComponent_ServiceDefinition	service definition parser component
RobotRaconteur_LogComponent_Discovery	node/service discovery component
RobotRaconteur_LogComponent_Subscription	subscription component
RobotRaconteur_LogComponent_NodeSetup	node setup component
RobotRaconteur_LogComponent_Utility	utility component
RobotRaconteur_LogComponent_RobDefLib	service definition standard library component (external)
RobotRaconteur_LogComponent_User	user component (external)
RobotRaconteur_LogComponent_UserClient	user client component (external)
RobotRaconteur_LogComponent_UserService	user service component (external)
RobotRaconteur_LogComponent_ThirdParty	third party library component (external)

RobotRaconteur_LogLevel

enum RobotRaconteur::RobotRaconteur_LogLevel

Log level enum.

Enum of possible log levels. Set log level using RobotRaconteurNode::SetLogLevel(), ROBOTRACONTEUR_LOG_LEVEL environmental variable, or --robotraconteur-log-level node setup command line option.

Enumerator
RobotRaconteur_LogLevel_Trace	trace log level
RobotRaconteur_LogLevel_Debug	debug log level
RobotRaconteur_LogLevel_Info	info log level
RobotRaconteur_LogLevel_Warning	warning log level
RobotRaconteur_LogLevel_Error	error log level
RobotRaconteur_LogLevel_Fatal	fatal log level
RobotRaconteur_LogLevel_Disable	disabled log level

ServerServiceListenerEventType

enum RobotRaconteur::ServerServiceListenerEventType

Enum of service listener events.

Enumerator
ServerServiceListenerEventType_ServiceClosed	service has been closed
ServerServiceListenerEventType_ClientConnected	client has connected
ServerServiceListenerEventType_ClientDisconnected	client has disconnected