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
	<<cert>> Entry created when a DDS_DataReader is discovered in association with its Subscriber. More...

Macros
#define	DDS_SubscriptionBuiltinTopicData_INITIALIZER
	<<cert>> Initializer for new instances.

Functions
DDS_Boolean	DDS_SubscriptionBuiltinTopicData_initialize (struct DDS_SubscriptionBuiltinTopicData *self)
	<<cert>> Initialize a DDS_SubscriptionBuiltinTopicData object.
DDS_Boolean	DDS_SubscriptionBuiltinTopicData_initialize_from_qos (struct DDS_SubscriptionBuiltinTopicData *self, const struct DDS_DomainParticipantQos *dp_qos)
	<<cert>> 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)
	<<cert>> 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)
	<<cert>> Compare two SubscriptionBuiltinTopicData structures for equality.

Variables
const char *const	DDS_SUBSCRIPTION_TOPIC_NAME
	<<cert>> Subscription topic name

Detailed Description

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

Macro Definition Documentation

DDS_SubscriptionBuiltinTopicData_INITIALIZER

#define DDS_SubscriptionBuiltinTopicData_INITIALIZER

<<cert>> Initializer for new instances.

New DDS_SubscriptionBuiltinTopicData instances stored on the stack should be initialized with this value before they are passed to any function. This step ensures that those fields that use dynamic memory are properly initialized. This does not allocate memory.

The simplest way to create a new structure is to initialize it on the stack at the time of its creation.

Function Documentation

DDS_SubscriptionBuiltinTopicData_initialize()

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_SubscriptionBuiltinTopicData_initialize_from_qos()

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

<<cert>> 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.

C++ accepts 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

DDS_BOOLEAN_TRUE on success, DDS_BOOLEAN_FALSE on failure.

DDS_SubscriptionBuiltinTopicData_finalize()

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

DDS_BOOLEAN_TRUE on success, DDS_BOOLEAN_FALSE on failure.

DDS_SubscriptionBuiltinTopicData_copy()

DDS_Boolean DDS_SubscriptionBuiltinTopicData_copy	(	struct DDS_SubscriptionBuiltinTopicData *	self,
		const struct DDS_SubscriptionBuiltinTopicData *	source )

<<cert>> Copy the contents of the given SubscriptionBuiltinTopicData into this SubscriptionBuiltinTopicData.

Creates a deep copy of the source into the destination. 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

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_SubscriptionBuiltinTopicData_is_equal()

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

<<cert>> 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.

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.

Variable Documentation

DDS_SUBSCRIPTION_TOPIC_NAME

const char* const DDS_SUBSCRIPTION_TOPIC_NAME

<<cert>> Subscription topic name

Topic name of subscription builtin topic data DDS_DataReader.

See also

DDS_SubscriptionBuiltinTopicData