Subscription Built-in Topic

Builtin topic for configuring information about the Subscriptions to be discovered by RTI Connext 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 (struct DDS_SubscriptionBuiltinTopicData *self)
	<<cert>> Initialize a DDS_SubscriptionBuiltinTopicData object.
DDS_Boolean	DDS_SubscriptionBuiltinTopicData_copy (struct DDS_SubscriptionBuiltinTopicData *out, const struct DDS_SubscriptionBuiltinTopicData *in)
	<<cert>> Copy a DDS_SubscriptionBuiltinTopicData object.
DDS_Boolean	DDS_SubscriptionBuiltinTopicData_is_equal (const struct DDS_SubscriptionBuiltinTopicData *left, const struct DDS_SubscriptionBuiltinTopicData *right)
	<<cert>> Compare two DDS_SubscriptionBuiltinTopicData objects for equality
DDS_Boolean	DDS_SubscriptionBuiltinTopicData_finalize (struct DDS_SubscriptionBuiltinTopicData *self)
	Finalize a SubscriptionBuiltinTopicData object.

---

Detailed Description

Builtin topic for configuring information about the Subscriptions to be discovered by RTI Connext 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

(

struct DDS_SubscriptionBuiltinTopicData *

self

)

<<cert>> Initialize a DDS_SubscriptionBuiltinTopicData object.

Parameters:

self	<<in>> Cannot be NULL.

Returns:

DDS_BOOLEAN_TRUE on success,DDS_BOOLEAN_FALSE on failure.

DDS_Boolean DDS_SubscriptionBuiltinTopicData_copy	(	struct DDS_SubscriptionBuiltinTopicData *	out,
		const struct DDS_SubscriptionBuiltinTopicData *	in
	)

<<cert>> Copy a DDS_SubscriptionBuiltinTopicData object.

Parameters:

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

<<cert>> Compare two DDS_SubscriptionBuiltinTopicData 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_SubscriptionBuiltinTopicData_finalize

(

struct DDS_SubscriptionBuiltinTopicData *

self

)

Finalize a SubscriptionBuiltinTopicData object.

Parameters:

[in]

self

SubscriptionBuiltinTopicData object to finalize.

Returns:

DDS_BOOLEAN_TRUE on success, DDS_BOOLEAN_FALSE on failure.