RTI Connext DDS Micro C API  Version 4.0.1
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
Participant Built-in Topic

Builtin topic for accessing information about the DomainParticipants discovered by RTI Connext DDS Micro. More...

Data Structures

struct  DDS_ParticipantBuiltinTopicData
 <<cert>> Object representing a remote DomainParticipant. More...

Macros

#define DDS_PARTICIPANT_TOPIC_NAME   DDS_PARTICIPANT_BUILTIN_TOPIC_NAME
 Participant topic name.

Functions

DDS_Boolean DDS_ParticipantBuiltinTopicData_initialize_from_qos (struct DDS_ParticipantBuiltinTopicData *self, const struct DDS_DomainParticipantQos *dp_qos)
 Initialize the contents of this ParticipantBuiltinTopicData using the resource limits specified in the given QoS.
DDS_Boolean DDS_ParticipantBuiltinTopicData_finalize (struct DDS_ParticipantBuiltinTopicData *self)
 Finalize the contents of this ParticipantBuiltinTopicData.
DDS_Boolean DDS_ParticipantBuiltinTopicData_copy (struct DDS_ParticipantBuiltinTopicData *self, const struct DDS_ParticipantBuiltinTopicData *source)
 Copy the contents of the given ParticipantBuiltinTopicData into this ParticipantBuiltinTopicData.
DDS_Boolean DDS_ParticipantBuiltinTopicData_is_equal (const struct DDS_ParticipantBuiltinTopicData *left, const struct DDS_ParticipantBuiltinTopicData *right)
 Compare two ParticipantBuiltinTopicData structures for equality.

Detailed Description

Builtin topic for accessing information about the DomainParticipants discovered by RTI Connext DDS Micro.


Macro Definition Documentation

#define DDS_PARTICIPANT_TOPIC_NAME   DDS_PARTICIPANT_BUILTIN_TOPIC_NAME

Participant topic name.

Topic name of participant builtin topic data datareader.

See also:
DDS_ParticipantBuiltinTopicData

Function Documentation

DDS_Boolean DDS_ParticipantBuiltinTopicData_initialize_from_qos ( struct DDS_ParticipantBuiltinTopicData self,
const struct DDS_DomainParticipantQos dp_qos 
)

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

Pre-allocate memory for the sequences contained in the ParticipantBuiltinTopicData 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_ParticipantBuiltinTopicData_finalize ( struct DDS_ParticipantBuiltinTopicData self)

Finalize the contents of this ParticipantBuiltinTopicData.

Frees all memory owned by the ParticipantBuiltinTopicData 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_ParticipantBuiltinTopicData_copy ( struct DDS_ParticipantBuiltinTopicData self,
const struct DDS_ParticipantBuiltinTopicData source 
)

Copy the contents of the given ParticipantBuiltinTopicData into this ParticipantBuiltinTopicData.

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

Parameters:
self<<in>> Cannot be NULL.
source<<in>>. ParticipantBuiltinTopicData to be copied from.
Returns:
One of the Standard Return Codes
DDS_Boolean DDS_ParticipantBuiltinTopicData_is_equal ( const struct DDS_ParticipantBuiltinTopicData left,
const struct DDS_ParticipantBuiltinTopicData right 
)

Compare two ParticipantBuiltinTopicData structures for equality.

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

RTI Connext DDS Micro C API Version 4.0.1 Copyright © Mon Jun 3 2024 Real-Time Innovations, Inc