Participant Built-in Topic

Builtin topic for accessing information about the DomainParticipants discovered by RTI Connext Micro. More...

Data Structures
struct	DDS_ParticipantBuiltinTopicData
	<<cert>> Object representing a remote DomainParticipant. More...

Macros
#define	DDS_PARTICIPANT_TOPIC_NAME   DDS_PARTICIPANT_BUILTIN_TOPIC_NAME
	<<cert>> Participant topic name

Functions
DDS_Boolean	DDS_ParticipantBuiltinTopicData_initialize (struct DDS_ParticipantBuiltinTopicData *self)
	<<cert>> Initialize a DDS_ParticipantBuiltinTopicData object.
DDS_Boolean	DDS_ParticipantBuiltinTopicData_copy (struct DDS_ParticipantBuiltinTopicData *out, const struct DDS_ParticipantBuiltinTopicData *in)
	<<cert>> Copy a DDS_ParticipantBuiltinTopicData object.
DDS_Boolean	DDS_ParticipantBuiltinTopicData_is_equal (const struct DDS_ParticipantBuiltinTopicData *left, const struct DDS_ParticipantBuiltinTopicData *right)
	<<cert>> Compare two DDS_ParticipantBuiltinTopicData objects for equality.
DDS_Boolean	DDS_ParticipantBuiltinTopicData_finalize (struct DDS_ParticipantBuiltinTopicData *self)
	Finalize a ParticipantBuiltinTopicData object.

---

Detailed Description

Builtin topic for accessing information about the DomainParticipants discovered by RTI Connext Micro.

---

Macro Definition Documentation

#define DDS_PARTICIPANT_TOPIC_NAME   DDS_PARTICIPANT_BUILTIN_TOPIC_NAME

<<cert>> Participant topic name

Topic name of participant builtin topic data DataReader.

See also:

DDS_ParticipantBuiltinTopicData

---

Function Documentation

DDS_Boolean DDS_ParticipantBuiltinTopicData_initialize

(

struct DDS_ParticipantBuiltinTopicData *

self

)

<<cert>> Initialize a DDS_ParticipantBuiltinTopicData object.

Parameters:

self	<<in>> Cannot be NULL.

Returns:

DDS_BOOLEAN_TRUE on success,DDS_BOOLEAN_FALSE on failure.

DDS_Boolean DDS_ParticipantBuiltinTopicData_copy	(	struct DDS_ParticipantBuiltinTopicData *	out,
		const struct DDS_ParticipantBuiltinTopicData *	in
	)

<<cert>> Copy a DDS_ParticipantBuiltinTopicData object.

Parameters:

[out]	out	The DDS_ParticipantBuiltinTopicData object being copied to. The object must have been initialized with DDS_ParticipantBuiltinTopicData_initialize.
[in]	in	The DDS_ParticipantBuiltinTopicData object being copied from.

Returns:

DDS_BOOLEAN_TRUE on success,DDS_BOOLEAN_FALSE on failure.

MT Safety:

UNSAFE. This operation is not thread safe. This operation does not protect the source or destination from being modified by another thread while the source is being copied to the destination.

API Restriction:

This function must only be called after DDS_DomainParticipantFactory_get_instance.

DDS_Boolean DDS_ParticipantBuiltinTopicData_is_equal	(	const struct DDS_ParticipantBuiltinTopicData *	left,
		const struct DDS_ParticipantBuiltinTopicData *	right
	)

<<cert>> Compare two DDS_ParticipantBuiltinTopicData objects for equality.

Parameters:

[in]	left	The left side of the comparison.
[in]	right	The right side of the comparison.

Returns:

DDS_BOOLEAN_TRUE if left is equal to right, otherwise DDS_BOOLEAN_FALSE.

MT Safety:

UNSAFE. This operation does not protect against the left or right side from being modified by another thread while the comparison is made.

DDS_Boolean DDS_ParticipantBuiltinTopicData_finalize

(

struct DDS_ParticipantBuiltinTopicData *

self

)

Finalize a ParticipantBuiltinTopicData object.

Parameters:

[in]

self

ParticipantBuiltinTopicData object to finalize.

Returns:

DDS_BOOLEAN_TRUE on success, DDS_BOOLEAN_FALSE on failure.