XRCE Client Requests

Data Structures
struct	NANO_XRCE_ClientRequestToken
	TODO. More...
struct	NANO_XRCE_CreateArgs
	TODO. More...
struct	NANO_XRCE_DataDeliveryControl
	TODO. More...
struct	NANO_XRCE_ReadArgs
	TODO. More...
struct	NANO_XRCE_ReadSpecification
	TODO. More...
struct	NANO_XRCE_RequestArgs
	TODO. More...
struct	NANO_XRCE_RequestId
	TODO. More...
struct	NANO_XRCE_ResultStatus
	A data type to convey the outcome of an XRCE operation. More...
struct	NANO_XRCE_WriteArgs
	TODO. More...

Macros
#define	NANO_XRCE_CLIENTREQUESTTOKEN_INITIALIZER
	TODO.
#define	NANO_XRCE_CREATEARGS_INITIALIZER
	TODO.
#define	NANO_XRCE_FORMAT_DATA   ((NANO_XRCE_DataFormat)0x00)
	Constant to indicate data format DATA.
#define	NANO_XRCE_FORMAT_DATA_SEQ   ((NANO_XRCE_DataFormat)0x08)
	Constant to indicate data format DATA_SEQ.
#define	NANO_XRCE_FORMAT_INVALID   ((NANO_XRCE_DataFormat)0xFF)
	TODO.
#define	NANO_XRCE_FORMAT_PACKED_SAMPLES   ((NANO_XRCE_DataFormat)0x0E)
	Constant to indicate data format PACKED_SAMPLE.
#define	NANO_XRCE_FORMAT_SAMPLE   ((NANO_XRCE_DataFormat)0x02)
	Constant to indicate data format SAMPLE.
#define	NANO_XRCE_FORMAT_SAMPLE_SEQ   ((NANO_XRCE_DataFormat)0x0A)
	Constant to indicate data format SAMPLE_SEQ.
#define	NANO_XRCE_READARGS_INITIALIZER
	TODO.
#define	NANO_XRCE_REQUESTARGS_INITIALIZER
	TODO.
#define	NANO_XRCE_REQUESTFLAGS_CONFIRM   (0x01 << 3)
	TODO.
#define	NANO_XRCE_REQUESTFLAGS_CREATE_REPLACE   (0x01 << 2)
	TODO.
#define	NANO_XRCE_REQUESTFLAGS_CREATE_REUSE   (0x01 << 1)
	TODO.
#define	NANO_XRCE_REQUESTFLAGS_CUSTOM_ENDIANNESS   (0x01 << 9)
	TODO.
#define	NANO_XRCE_REQUESTFLAGS_DEFAULT   0
	TODO.
#define	NANO_XRCE_REQUESTFLAGS_LITTLE_ENDIAN   (0x01 << 0)
	TODO.
#define	NANO_XRCE_REQUESTFLAGS_SYNC   (0x01 << 4)
	TODO.
#define	NANO_XRCE_REQUESTID_INVALID   { { 0x00, 0x00 }}
	TODO.
#define	NANO_XRCE_REQUESTID_VALUE_LEN   2
	TODO.
#define	NANO_XRCE_STATUS_ERR_ALREADY_EXISTS   ((NANO_XRCE_StatusValue)0x82)
	Return status for operations which failed because the requested resource already exists.
#define	NANO_XRCE_STATUS_ERR_DDS_ERROR   ((NANO_XRCE_StatusValue)0x80)
	Return status for operations which failed because of an error in a related DDS operation.
#define	NANO_XRCE_STATUS_ERR_DENIED   ((NANO_XRCE_StatusValue)0x83)
	Return status for operations which failed because of an authorization issue.
#define	NANO_XRCE_STATUS_ERR_INCOMPATIBLE   ((NANO_XRCE_StatusValue)0x86)
	Return status for operations which are not supported or deemed invalid in any other way.
#define	NANO_XRCE_STATUS_ERR_INVALID_DATA   ((NANO_XRCE_StatusValue)0x85)
	Return status for operations which failed because of a malformed request.
#define	NANO_XRCE_STATUS_ERR_MISMATCH   ((NANO_XRCE_StatusValue)0x81)
	Return status for operations which failed because the request does not match existing resources..
#define	NANO_XRCE_STATUS_ERR_RESOURCES   ((NANO_XRCE_StatusValue)0x87)
	Return status for operations which failed because of lack of resources.
#define	NANO_XRCE_STATUS_ERR_UNKNOWN_REFERENCE   ((NANO_XRCE_StatusValue)0x84)
	Return status for operations which failed because of a reference to an unknown XRCE Object.
#define	NANO_XRCE_STATUS_INVALID   ((NANO_XRCE_StatusValue)0xFF)
	An invalid return status that should never be returned. More...
#define	NANO_XRCE_STATUS_OK   ((NANO_XRCE_StatusValue)0x00)
	Return status for operations that are carried out successfully.
#define	NANO_XRCE_STATUS_OK_MATCHES   ((NANO_XRCE_StatusValue)0x01)
	Return status for operations that are carried out successfully, and which matched existing resources.
#define	NANO_XRCE_WRITEARGS_INITIALIZER
	TODO.

Typedefs
typedef NANO_u8	NANO_XRCE_DataFormat
	Identifier for the type of formatting of user data.
typedef NANO_u16	NANO_XRCE_RequestFlags
	TODO.
typedef NANO_u8	NANO_XRCE_StatusValue
	An enumeration of return codes for XRCE operations.

Functions
void	NANO_XRCE_RequestId_from_u16 (NANO_XRCE_RequestId *const self, NANO_u16 val)
NANO_u16	NANO_XRCE_RequestId_to_u16 (const NANO_XRCE_RequestId *const self)
NANO_bool	NANO_XRCE_ResultStatus_success (NANO_XRCE_ResultStatus *const self)
	TODO. More...

Detailed Description

Macro Definition Documentation

NANO_XRCE_STATUS_INVALID

#define NANO_XRCE_STATUS_INVALID   ((NANO_XRCE_StatusValue)0xFF)

An invalid return status that should never be returned.

This value is non-standard.

Function Documentation

NANO_XRCE_RequestId_from_u16()

void NANO_XRCE_RequestId_from_u16	(	NANO_XRCE_RequestId *const	self,
		NANO_u16	val
	)

Parameters

self
val

NANO_XRCE_RequestId_to_u16()

NANO_u16 NANO_XRCE_RequestId_to_u16

(

const NANO_XRCE_RequestId *const

self

)

Parameters

self

Returns

NANO_u16

NANO_XRCE_ResultStatus_success()

NANO_bool NANO_XRCE_ResultStatus_success

(

NANO_XRCE_ResultStatus *const

self

)

TODO.

Parameters

self

Returns

NANO_bool