Publication Built-in Topic

Builtin topic for configuring information about the Publications to be discovered by RTI Connext Micro. More...

Data Structures
struct	DDS_PublicationBuiltinTopicData
	Object describing a remote Publication. More...

Macros
#define	DDS_PUBLICATION_TOPIC_NAME   DDS_PUBLICATION_BUILTIN_TOPIC_NAME
	Publication topic name.

Functions
DDS_Boolean	DDS_PublicationBuiltinTopicData_initialize (struct DDS_PublicationBuiltinTopicData *self)
	<<cert>> Initialize a DDS_PublicationBuiltinTopicData object.
DDS_Boolean	DDS_PublicationBuiltinTopicData_copy (struct DDS_PublicationBuiltinTopicData *out, const struct DDS_PublicationBuiltinTopicData *in)
	<<cert>> Copy a DDS_PublicationBuiltinTopicData object.
DDS_Boolean	DDS_PublicationBuiltinTopicData_is_equal (const struct DDS_PublicationBuiltinTopicData *left, const struct DDS_PublicationBuiltinTopicData *right)
	<<cert>> Compare two DDS_PublicationBuiltinTopicData objects for equality
DDS_Boolean	DDS_PublicationBuiltinTopicData_finalize (struct DDS_PublicationBuiltinTopicData *self)
	Finalize a PublicationBuiltinTopicData object.

---

Detailed Description

Builtin topic for configuring information about the Publications to be discovered by RTI Connext Micro.

---

Macro Definition Documentation

#define DDS_PUBLICATION_TOPIC_NAME   DDS_PUBLICATION_BUILTIN_TOPIC_NAME

Publication topic name.

Topic name of publication builtin topic data DataReader.

See also:

DDS_PublicationBuiltinTopicData

---

Function Documentation

DDS_Boolean DDS_PublicationBuiltinTopicData_initialize

(

struct DDS_PublicationBuiltinTopicData *

self

)

<<cert>> Initialize a DDS_PublicationBuiltinTopicData object.

Parameters:

self	<<in>> Cannot be NULL.

Returns:

DDS_BOOLEAN_TRUE on success,DDS_BOOLEAN_FALSE on failure.

DDS_Boolean DDS_PublicationBuiltinTopicData_copy	(	struct DDS_PublicationBuiltinTopicData *	out,
		const struct DDS_PublicationBuiltinTopicData *	in
	)

<<cert>> Copy a DDS_PublicationBuiltinTopicData object.

Parameters:

[out]	out	The DDS_PublicationBuiltinTopicData object being copied to. The object must have been initialized with DDS_PublicationBuiltinTopicData_initialize.
[in]	in	The DDS_PublicationBuiltinTopicData 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_PublicationBuiltinTopicData_is_equal	(	const struct DDS_PublicationBuiltinTopicData *	left,
		const struct DDS_PublicationBuiltinTopicData *	right
	)

<<cert>> Compare two DDS_PublicationBuiltinTopicData 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_PublicationBuiltinTopicData_finalize

(

struct DDS_PublicationBuiltinTopicData *

self

)

Finalize a PublicationBuiltinTopicData object.

Parameters:

[in]

self

PublicationBuiltinTopicData object to finalize.

Returns:

DDS_BOOLEAN_TRUE on success, DDS_BOOLEAN_FALSE on failure.