Subscription Built-in Topic

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

Data Structures
struct	DDS_SubscriptionBuiltinTopicData
	Entry created when a DDS_DataReader is discovered in association with its Subscriber. More...

Macros
#define	DDS_SUBSCRIPTION_TOPIC_NAME   DDS_SUBSCRIPTION_BUILTIN_TOPIC_NAME
	Subscription topic name.

Functions
DDS_Boolean	DDS_SubscriptionBuiltinTopicData_initialize_from_qos (struct DDS_SubscriptionBuiltinTopicData *self, const struct DDS_DomainParticipantQos *dp_qos)
	Initialize the contents of this SubscriptionBuiltinTopicData using the resource limits specified in the given QoS.
DDS_Boolean	DDS_SubscriptionBuiltinTopicData_finalize (struct DDS_SubscriptionBuiltinTopicData *self)
	Finalize the contents of this SubscriptionBuiltinTopicData.
DDS_Boolean	DDS_SubscriptionBuiltinTopicData_copy (struct DDS_SubscriptionBuiltinTopicData *self, const struct DDS_SubscriptionBuiltinTopicData *source)
	Copy the contents of the given SubscriptionBuiltinTopicData into this SubscriptionBuiltinTopicData.
DDS_Boolean	DDS_SubscriptionBuiltinTopicData_is_equal (const struct DDS_SubscriptionBuiltinTopicData *left, const struct DDS_SubscriptionBuiltinTopicData *right)
	Compare two SubscriptionBuiltinTopicData structures for equality.

---

Detailed Description

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

---

Macro Definition Documentation

#define DDS_SUBSCRIPTION_TOPIC_NAME   DDS_SUBSCRIPTION_BUILTIN_TOPIC_NAME

Subscription topic name.

Topic name of subscription builtin topic data DataReader.

See also:

DDS_SubscriptionBuiltinTopicData

---

Function Documentation

DDS_Boolean DDS_SubscriptionBuiltinTopicData_initialize_from_qos	(	struct DDS_SubscriptionBuiltinTopicData *	self,
		const struct DDS_DomainParticipantQos *	dp_qos
	)

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

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

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_SubscriptionBuiltinTopicData_finalize

(

struct DDS_SubscriptionBuiltinTopicData *

self

)

Finalize the contents of this SubscriptionBuiltinTopicData.

Frees all memory owned by the SubscriptionBuiltinTopicData 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_SubscriptionBuiltinTopicData_copy	(	struct DDS_SubscriptionBuiltinTopicData *	self,
		const struct DDS_SubscriptionBuiltinTopicData *	source
	)

Copy the contents of the given SubscriptionBuiltinTopicData into this SubscriptionBuiltinTopicData.

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

Parameters:

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

Returns:

One of the Standard Return Codes

DDS_Boolean DDS_SubscriptionBuiltinTopicData_is_equal	(	const struct DDS_SubscriptionBuiltinTopicData *	left,
		const struct DDS_SubscriptionBuiltinTopicData *	right
	)

Compare two SubscriptionBuiltinTopicData structures for equality.

This function compares two SubscriptionBuiltinTopicData 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.