Publication Built-in Topic

Builtin topic for configuring information about the Publications to be discovered by RTI Connext DDS 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_from_qos (struct DDS_PublicationBuiltinTopicData *self, const struct DDS_DomainParticipantQos *dp_qos)
	Initialize the contents of this PublicationBuiltinTopicData using the resource limits specified in the given QoS.
DDS_Boolean	DDS_PublicationBuiltinTopicData_finalize (struct DDS_PublicationBuiltinTopicData *self)
	Finalize the contents of this PublicationBuiltinTopicData.
DDS_Boolean	DDS_PublicationBuiltinTopicData_copy (struct DDS_PublicationBuiltinTopicData *self, const struct DDS_PublicationBuiltinTopicData *source)
	Copy the contents of the given PublicationBuiltinTopicData into this PublicationBuiltinTopicData.
DDS_Boolean	DDS_PublicationBuiltinTopicData_is_equal (const struct DDS_PublicationBuiltinTopicData *left, const struct DDS_PublicationBuiltinTopicData *right)
	Compare two PublicationBuiltinTopicData structures for equality.

---

Detailed Description

Builtin topic for configuring information about the Publications to be discovered by RTI Connext DDS 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_from_qos	(	struct DDS_PublicationBuiltinTopicData *	self,
		const struct DDS_DomainParticipantQos *	dp_qos
	)

Initialize the contents of this PublicationBuiltinTopicData using the resource limits specified in the given QoS.

Pre-allocate memory for the sequences contained in the PublicationBuiltinTopicData using the resource limits specified in the given QoS.

C++ accepts the the QoS resource limits as an argument for the constructor.

Parameters:

self	<<in>> Cannot be NULL.
dp_qos	<<in>>. DomainParticipantQoS to be used for initialization.

Returns:

One of the Standard Return Codes

DDS_Boolean DDS_PublicationBuiltinTopicData_finalize

(

struct DDS_PublicationBuiltinTopicData *

self

)

Finalize the contents of this PublicationBuiltinTopicData.

Frees all memory owned by the PublicationBuiltinTopicData which was allocated through the standard DDS APIs, such as initialize_from_qos, copy, or sequence set_maximum. If you have allocated memory for any attribute in this object using non-standard APIs, then the attribute must be returned to its initialized state before calling finalize. Any memory allocated using non-standard APIs is the responsibility of the user to manage.

Parameters:

self	<<in>> Cannot be NULL.

Returns:

One of the Standard Return Codes

DDS_Boolean DDS_PublicationBuiltinTopicData_copy	(	struct DDS_PublicationBuiltinTopicData *	self,
		const struct DDS_PublicationBuiltinTopicData *	source
	)

Copy the contents of the given PublicationBuiltinTopicData into this PublicationBuiltinTopicData.

Creates a deep copy of the source into the destiantion. May allocate memory for the sequences contained in the PublicationBuiltinTopicData if the destination does not have enough memory allocated.

Parameters:

self	<<in>> Cannot be NULL.
source	<<in>>. PublicationBuiltinTopicData to be copied from.

Returns:

One of the Standard Return Codes

DDS_Boolean DDS_PublicationBuiltinTopicData_is_equal	(	const struct DDS_PublicationBuiltinTopicData *	left,
		const struct DDS_PublicationBuiltinTopicData *	right
	)

Compare two PublicationBuiltinTopicData structures for equality.

This function compares two PublicationBuiltinTopicData structures for equality. The comparison is performed field by field.

Parameters:

left	<<in>>. The left side of the comparison.
right	<<in>>. The right side of the comparison.

Returns:

DDS_BOOLEAN_TRUE if the two structures are equal, DDS_BOOLEAN_FALSE otherwise.