GUID Support

<<extension>> GUID type and defines. More...

Classes
struct	DDS_RTPS_EntityId_t
	From the DDS-RTPS specification: type used to hold the suffix part of the globally-unique RTPS-entity identifiers. More...
struct	DDS_RTPS_GUID_t
	From the DDS-RTPS specification: type used to hold a globally-unique RTPS-entity identifier. More...
struct	DDS_GUID_t
	Type for GUID (Global Unique Identifier) representation. More...

Typedefs
typedef DDS_Octet	DDS_RTPS_GuidPrefix_t[DDS_RTPS_GUID_PREFIX_LENGTH]
	From the DDS-RTPS specification: type used to hold the prefix of the globally-unique RTPS-entity identifiers. More...
typedef struct DDS_RTPS_EntityId_t	DDS_RTPS_EntityId_t
	From the DDS-RTPS specification: type used to hold the suffix part of the globally-unique RTPS-entity identifiers. More...
typedef struct DDS_RTPS_GUID_t	DDS_RTPS_GUID_t
	From the DDS-RTPS specification: type used to hold a globally-unique RTPS-entity identifier. More...
typedef struct DDS_GUID_t	DDS_GUID_t
	Type for GUID (Global Unique Identifier) representation. More...

Functions
DDS_Boolean	DDS_GUID_equals (const struct DDS_GUID_t *self, const struct DDS_GUID_t *other)
	Compares this GUID with another GUID for equality. More...
int	DDS_GUID_compare (const struct DDS_GUID_t *self, const struct DDS_GUID_t *other)
	Compares two GUIDs. More...
void	DDS_GUID_copy (struct DDS_GUID_t *self, const struct DDS_GUID_t *other)
	Copies another GUID into this GUID. More...

Variables
const struct DDS_GUID_t	DDS_GUID_AUTO
	Indicates that RTI Connext should choose an appropriate virtual GUID. More...
const struct DDS_GUID_t	DDS_GUID_UNKNOWN
	Unknown GUID. More...
const struct DDS_GUID_t	DDS_GUID_ZERO
	Zero GUID. More...

Detailed Description

<<extension>> GUID type and defines.

Typedef Documentation

DDS_RTPS_GuidPrefix_t

typedef DDS_Octet DDS_RTPS_GuidPrefix_t[DDS_RTPS_GUID_PREFIX_LENGTH]

From the DDS-RTPS specification: type used to hold the prefix of the globally-unique RTPS-entity identifiers.

From DDS-RTPS Specification, clauses 8.4.2.1 and 9.3.1.

DDS_RTPS_EntityId_t

typedef struct DDS_RTPS_EntityId_t DDS_RTPS_EntityId_t

From the DDS-RTPS specification: type used to hold the suffix part of the globally-unique RTPS-entity identifiers.

From DDS-RTPS Specification, clauses 8.4.2.1 and 9.3.1.

DDS_RTPS_GUID_t

typedef struct DDS_RTPS_GUID_t DDS_RTPS_GUID_t

From the DDS-RTPS specification: type used to hold a globally-unique RTPS-entity identifier.

From DDS-RTPS Specification, clauses 8.4.2.1 and 9.3.1.

DDS_GUID_t

typedef struct DDS_GUID_t DDS_GUID_t

Type for GUID (Global Unique Identifier) representation.

Represents a 128 bit GUID.

Alternative representation of DDS_RTPS_GUID_t. Memory and wire representation for this type is the same as the one for DDS_RTPS_GUID_t.

Function Documentation

DDS_GUID_equals()

DDS_Boolean DDS_GUID_equals	(	const struct DDS_GUID_t *	self,
		const struct DDS_GUID_t *	other
	)

Compares this GUID with another GUID for equality.

Parameters

self	<<in>> This GUID. Cannot be NULL.
other	<<in>> The other GUID to be compared with this GUID. Cannot be NULL.

Returns

DDS_BOOLEAN_TRUE if the two GUIDs have equal values, or DDS_BOOLEAN_FALSE otherwise.

DDS_GUID_compare()

int DDS_GUID_compare	(	const struct DDS_GUID_t *	self,
		const struct DDS_GUID_t *	other
	)

Compares two GUIDs.

Parameters

self	<<in>> GUID to compare. Cannot be NULL.
other	<<in>> GUID to compare. Cannot be NULL.

Returns

If the two GUIDs are equal, the function returns 0. If self is greater than other the function returns a positive number; otherwise, it returns a negative number.

DDS_GUID_copy()

void DDS_GUID_copy	(	struct DDS_GUID_t *	self,
		const struct DDS_GUID_t *	other
	)

Copies another GUID into this GUID.

Parameters

self	<<in>> This GUID. Cannot be NULL.
other	<<in>> The other GUID to be copied.

Variable Documentation

DDS_GUID_AUTO

const struct DDS_GUID_t DDS_GUID_AUTO

Indicates that RTI Connext should choose an appropriate virtual GUID.

If this special value is assigned to DDS_DataWriterProtocolQosPolicy::virtual_guid or DDS_DataReaderProtocolQosPolicy::virtual_guid, RTI Connext will assign the virtual GUID automatically based on the RTPS or physical GUID.

DDS_GUID_UNKNOWN

const struct DDS_GUID_t DDS_GUID_UNKNOWN

Unknown GUID.

DDS_GUID_ZERO

const struct DDS_GUID_t DDS_GUID_ZERO

Zero GUID.