dds_c_infrastructure.h File Reference

DDS Domain Module definitions. More...

#include "dds_c/dds_c_config.h"
#include "dds_c/dds_c_dll.h"
#include "cdr/cdr_cdr_type.h"
#include "netio/netio_rtps.h"
#include "rtps/rtps_rtps.h"
#include "dds_c/dds_c_common.h"
#include "dds_c/dds_c_string.h"
#include "dds_c/dds_c_sequence.h"
#include "dds_c/dds_c_user_data_manager.h"
#include "dds_c/dds_c_string_manager.h"
#include "xcdr/xcdr_interpreter.h"
#include <reda/reda_sequence_decl.h>
#include "dds_c/dds_c_property_qos.h"

Data Structures
struct	DDS_Time_t
	Type for time representation. More...
struct	DDS_Duration_t
	Type for duration representation. More...
struct	DDS_InstanceHandleSeq
	Instantiates FooSeq < DDS_InstanceHandle_t > . More...
struct	DDS_GUID_t
	Type for GUID (Global Unique Identifier) representation. More...
struct	DDS_SequenceNumber_t
	Type for sequence number representation. More...
struct	DDS_DeadlineQosPolicy
	<<cert>> Expresses the maximum duration (deadline) within which an instance is expected to be updated. More...
struct	DDS_LatencyBudgetQosPolicy
	Provides a hint as to the maximum acceptable delay from the time the data is written to the time it is received by the subscribing applications. More...
struct	DDS_OwnershipQosPolicy
	<<cert>> Specifies whether it is allowed for multiple DDS_DataWriter (s) to write the same instance of the data and if so, how these modifications should be arbitrated. More...
struct	DDS_OwnershipStrengthQosPolicy
	<<cert>> Specifies the value of the strength used to arbitrate among multiple DDS_DataWriter objects that attempt to modify the same instance of a data type (identified by DDS_Topic + key). More...
struct	DDS_LivelinessQosPolicy
	<<cert>> Determines the mechanism and parameters used by the application to determine whether a DDS_Entity is alive. More...
struct	DDS_ReliabilityQosPolicy
	<<cert>> Indicates the level of reliability offered/requested by RTI Connext DDS Micro. More...
struct	DDS_HistoryQosPolicy
	<<cert>> Specifies the behavior of RTI Connext DDS Micro in the case where the value of a sample changes (one or more times) before it can be successfully communicated to one or more existing subscribers. More...
struct	DDS_DurabilityQosPolicy
	<<cert>> Durability properties that affect the life-cycle of published data. More...
struct	DDS_DataRepresentationQosPolicy
	This QoS policy contains a list of representation identifiers used by DDS_DataWriter and DDS_DataReader entities to negotiate which data representation to use. More...
struct	DDS_ResourceLimitsQosPolicy
	<<cert>> Specifies the resources that RTI Connext DDS Micro can consume in order to meet the requested QoS. More...
struct	DDS_PresentationQosPolicy
	Specifies how the samples representing changes to data instances are presented to a subscribing application. More...
struct	DDS_DestinationOrderQosPolicy
	Destination order policies that affect the ordering of subsribed data. More...
struct	DDS_DataReaderResourceLimitsQosPolicy
	<<cert>> Resource limits that apply only to DDS_DataReader instances. More...
struct	DDS_DataWriterResourceLimitsQosPolicy
	<<cert>> Resource limits that apply only to DDS_DataWriter instances. More...
struct	DDS_EntityFactoryQosPolicy
	<<cert>> A QoS policy for all DDS_Entity types that can act as factories for one or more other DDS_Entity types. More...
struct	DDS_DataWriterShmemRefTransferModeSettings
	Settings related to transferring data using shared memory references. More...
struct	DDS_DataWriterTransferModeQosPolicy
	<<eXtension>> Qos related to transferring data More...
struct	DDS_SystemResourceLimitsQosPolicy
	<<cert>> Resource limits that apply only to DDS_DomainParticipantFactory More...
struct	DDS_RtpsWellKnownPorts_t
	RTPS well-known port mapping configuration. More...
struct	DDS_WireProtocolQosPolicy
	<<cert>> Specifies the wire-protocol-related attributes for the DDS_DomainParticipant. More...
struct	DDS_ChecksumProperty
	<<eXtension>> Type to define the checksum properties of the participant RTI Connext DDS Micro. More...
struct	DDS_ChecksumProperty_t
	<<eXtension>> Type to define the checksum properties of the participant RTI Connext DDS Micro. More...
struct	DDS_Locator_t
	<<eXtension>> <<cert>> Type used to represent the addressing information needed to send a message to an RTPS Endpoint using one of the supported transports. More...
struct	DDS_LocatorSeq
	Declares IDL sequence < DDS_Locator_t > More...
struct	DDS_ProtocolVersion
	<<eXtension>> <<cert>> Type used to represent the version of the RTPS protocol. More...
struct	DDS_VendorId
	<<eXtension>> <<cert>> Type used to represent the vendor of the service implementing the RTPS protocol. More...
struct	DDS_VendorId_t
	<<eXtension>> <<cert>> Type used to represent the vendor of the service implementing the RTPS protocol. More...
struct	DDS_ProductVersion
	<<eXtension>> <<cert>> Type used to represent the current version of RTI Connext DDS Micro. More...
struct	DDS_ProductVersion_t
	<<eXtension>> <<cert>> Type used to represent the current version of RTI Connext DDS Micro. More...
struct	DDS_RtpsReliableReaderProtocol_t
	Qos related to reliable reader protocol defined in RTPS. More...
struct	DDS_DataReaderProtocolQosPolicy
	<<eXtension>> Protocol that applies only to DDS_DataReader instances. More...
struct	DDS_RtpsReliableWriterProtocol_t
	<<cert>> QoS related to the reliable writer protocol defined in RTPS. More...
struct	DDS_DataWriterProtocolQosPolicy
	<<eXtension>> <<cert>> Protocol that applies only to DDS_DataWriter instances. More...
struct	DDS_TransportQosPolicy
	<<eXtension>> <<cert>> Settings for available transports More...
struct	DDS_DomainParticipantResourceLimitsQosPolicy
	<<cert>> Resource limits that apply only to DDS_DomainParticipant instances. More...
struct	DDS_BuiltinTopicKey_t
	The key type of the built-in topic types. More...
struct	DDS_ConditionSeq
	A sequence object containing references to one or more DDS_Condition objects. More...
struct	DDS_Listener
	<<interface>> Abstract base class for all Listener interfaces. More...
struct	DDS_EntityNameQosPolicy
	<<cert>> Policy used to name an entity. More...
struct	DDS_SampleIdentity_t
	Data structure used to provide explicit identity information about a published data sample. More...
struct	DDS_WriteParams_t
	Data structure used to provide custom parameters to a DataWriter's write operation. More...
struct	DDS_PublishModeQosPolicy
	Specifies how RTI Connext DDS Micro sends application data on the network. This QoS policy can be used to tell RTI Connext DDS Micro to use its own thread to send data, instead of the user thread. More...

Macros
#define	DDS_TIME_ZERO
	The default instant in time: zero seconds and zero nanoseconds.
#define	T   DDS_InstanceHandle_t
	A two-byte signed integer that identifies a data representation.
#define	DDS_STATUS_MASK_NONE
	No bits are set.
#define	DDS_STATUS_MASK_ALL
	All bits are set.
#define	T   struct DDS_QosPolicyCount
	A two-byte signed integer that identifies a data representation.
#define	T   DDS_EncapsulationId_t
	A two-byte signed integer that identifies a data representation.
#define	T   struct DDS_TransportEncapsulationSettings_t
	A two-byte signed integer that identifies a data representation.
#define	DDS_XCDR_DATA_REPRESENTATION   ((DDS_DataRepresentationId_t)0)
	Corresponds to the Extended Common Data Representation encoding version 1.
#define	DDS_XML_DATA_REPRESENTATION   ((DDS_DataRepresentationId_t)1)
	Corresponds to the XML Data Representation (unsupported).
#define	DDS_XCDR2_DATA_REPRESENTATION   ((DDS_DataRepresentationId_t)2)
	Corresponds to the Extended Common Data Representation encoding version 2.
#define	DDS_AUTO_DATA_REPRESENTATION   ((DDS_DataRepresentationId_t)-1)
	Representation is automatically chosen based on the type.
#define	T   DDS_DataRepresentationId_t
	A two-byte signed integer that identifies a data representation.
#define	DDS_CHECKSUM_NONE   (0)
	Bitmap indicating no checksum selection.
#define	DDS_CHECKSUM_AUTO   (0xffffU)
	Bitmap indicating automatic checksum selection.
#define	DDS_CHECKSUM_BUILTIN32   (0x1U)
	Bitmap for selecting the builtin 32bit checksum.
#define	DDS_CHECKSUM_BUILTIN64   (0x2U)
	Bitmap for selecting the builtin 64bit checksum.
#define	DDS_CHECKSUM_BUILTIN128   (0x4U)
	Bitmap for selecting the builtin 128bit checksum.
#define	T   struct RTPS_Locator
	A two-byte signed integer that identifies a data representation.
#define	DDS_LOCATOR_INVALID   RTPS_LOCATOR_INVALID
	An invalid locator.
#define	DDS_LOCATOR_DEFAULT   RTPS_LOCATOR_DEFAULT
	A locator with default values.
#define	DDS_LOCATOR_KIND_INVALID
	Locator of this kind is invalid.
#define	DDS_LOCATOR_PORT_INVALID
	An invalid port.
#define	DDS_LOCATOR_ADDRESS_INVALID   RTPS_LOCATOR_ADDRESS_INVALID
	An invalid address.
#define	DDS_LOCATOR_KIND_UDPv4
	A locator for a UDPv4 address.
#define	DDS_LOCATOR_KIND_UDPv6
	A locator for a UDPv6 address.
#define	DDS_LOCATOR_KIND_RESERVED
	Locator of this kind is reserved.
#define	DDS_LOCATOR_KIND_SHMEM
	A locator for an address acessed via shared memory.
#define	DDS_PROTOCOLVERSION_1_0   { 1, 0 }
	The protocol version 1.0.
#define	DDS_PROTOCOLVERSION_1_1   { 1, 1 }
	The protocol version 1.1.
#define	DDS_PROTOCOLVERSION_1_2   { 1, 2 }
	The protocol version 1.2.
#define	DDS_PROTOCOLVERSION_2_0   { 2, 0 }
	The most recent protocol version. Currently 1.2.
#define	DDS_PROTOCOLVERSION_2_1   { 2, 1 }
	The protocol version 2.1.
#define	DDS_PROTOCOLVERSION   { 2, 1 }
	The most recent protocol version. Currently 1.2.
#define	DDS_VENDOR_ID_LENGTH_MAX   2
	Length of vendor id.
#define	DDS_PRODUCTVERSION_UNKNOWN   { 0, 0, '0', 0 }
	The value used when the product version is unknown.
#define	T   struct DDS_ConditionImpl*
	A two-byte signed integer that identifies a data representation.
#define	DDS_Listener_INITIALIZER
	Initialize the DDS_Listener::listener_data pointer to NULL.
#define	DDS_ENTITYNAME_QOS_NAME_MAX   255
	Constant determining the maximum length of the name string contained in a DDS_EntityNameQosPolicy instance.
#define	DDS_WRITEPARAMS_DEFAULT
	Default values used to initialize instances of DDS_WriteParams_t.
#define	DDS_PUBLICATION_PRIORITY_UNDEFINED
	Initializer value for DDS_PublishModeQosPolicy::priority.
#define	DDS_PUBLICATION_PRIORITY_AUTOMATIC
	Constant value for DDS_PublishModeQosPolicy::priority.

Typedefs
typedef DDS_HANDLE_TYPE_NATIVE	DDS_InstanceHandle_t
	Type definition for an instance handle.
typedef struct DDS_GUID_t	DDS_GUID_t
	Type for GUID (Global Unique Identifier) representation.
typedef DDS_UnsignedLong	DDS_StatusMask
	A bit-mask (list) of concrete status types, i.e. DDS_StatusKind[].
typedef DDS_Short	DDS_DataRepresentationId_t
	A two-byte signed integer that identifies a data representation.
typedef DDS_UnsignedShort	DDS_ChecksumKind_t
	Datatype for checksum kind.
typedef DDS_UnsignedShort	DDS_ChecksumKindMask_t
	Datatype for an OR'ing for DDS_ChecksumKind_t .
typedef struct DDS_ProtocolVersion	DDS_ProtocolVersion_t
	<<eXtension>> <<cert>> Type used to represent the version of the RTPS protocol.
typedef struct DDS_BuiltinTopicKey_t	DDS_BuiltinTopicKey_t
	The key type of the built-in topic types.
typedef struct DDS_EntityImpl	DDS_Entity
	<<interface>> Abstract base class for all the DDS objects that support QoS policies, and a listener.
typedef struct DDS_ConditionImpl	DDS_Condition
	<<interface>> <<cert>> Root class for all the conditions that may be attached to a DDS_WaitSet.
typedef struct DDS_GuardConditionImpl	DDS_GuardCondition
	<<interface>> <<cert>> A specific DDS_Condition whose trigger_value is completely under the control of the application.
typedef struct DDS_StatusConditionImpl	DDS_StatusCondition
	<<interface>> <<cert>> A specific DDS_Condition that is associated with each DDS_Entity.
typedef struct DDS_WaitSetImpl	DDS_WaitSet
	<<interface>> <<cert>> Allows an application to wait until one or more of the attached DDS_Condition objects has a trigger_value of DDS_BOOLEAN_TRUE or else until the timeout expires.
typedef struct DDS_DomainEntityImpl	DDS_DomainEntity
	<<interface>> Abstract base class for all DDS entities except for the DDS_DomainParticipant.
typedef struct DDS_DomainParticipantImpl	DDS_DomainParticipant
	<<interface>> <<cert>> Container for all DDS_DomainEntity objects.
typedef struct DDS_DataReaderImpl	DDS_DataReader
	<<interface>> <<cert>> Allows the application to: (1) declare the data it wishes to receive (i.e. make a subscription) and (2) access the data received by the attached DDS_Subscriber.
typedef struct DDS_DataWriterImpl	DDS_DataWriter
	<<interface>> <<cert>> Allows an application to set the value of the data to be published under a given DDS_Topic.
typedef DDS_UnsignedLong	NDDS_Config_XTypesComplianceMask
	XTypes compliance mask.

Enumerations
enum	DDS_ReturnCode_t {   DDS_RETCODE_OK, DDS_RETCODE_ERROR, DDS_RETCODE_UNSUPPORTED, DDS_RETCODE_BAD_PARAMETER,   DDS_RETCODE_PRECONDITION_NOT_MET, DDS_RETCODE_OUT_OF_RESOURCES, DDS_RETCODE_NOT_ENABLED, DDS_RETCODE_IMMUTABLE_POLICY,   DDS_RETCODE_INCONSISTENT_POLICY, DDS_RETCODE_ALREADY_DELETED, DDS_RETCODE_TIMEOUT, DDS_RETCODE_NO_DATA,   DDS_RETCODE_ILLEGAL_OPERATION, DDS_RETCODE_NOT_ALLOWED_BY_SEC }
	Type for return codes. More...
enum	DDS_StatusKind {   DDS_INCONSISTENT_TOPIC_STATUS, DDS_OFFERED_DEADLINE_MISSED_STATUS, DDS_REQUESTED_DEADLINE_MISSED_STATUS, DDS_OFFERED_INCOMPATIBLE_QOS_STATUS,   DDS_REQUESTED_INCOMPATIBLE_QOS_STATUS, DDS_SAMPLE_LOST_STATUS, DDS_SAMPLE_REJECTED_STATUS, DDS_DATA_ON_READERS_STATUS,   DDS_DATA_AVAILABLE_STATUS, DDS_LIVELINESS_LOST_STATUS, DDS_LIVELINESS_CHANGED_STATUS, DDS_PUBLICATION_MATCHED_STATUS,   DDS_SUBSCRIPTION_MATCHED_STATUS, DDS_INSTANCE_REPLACED_STATUS, DDS_RELIABLE_READER_ACTIVITY_CHANGED_STATUS, DDS_DATA_WRITER_SAMPLE_REMOVED_STATUS }
	Type for status kinds. More...
enum	DDS_QosPolicyId_t {   DDS_INVALID_QOS_POLICY_ID , DDS_DEADLINE_QOS_POLICY_ID , DDS_OWNERSHIP_QOS_POLICY_ID, DDS_OWNERSHIPSTRENGTH_QOS_POLICY_ID,   DDS_LIVELINESS_QOS_POLICY_ID , DDS_RELIABILITY_QOS_POLICY_ID , DDS_HISTORY_QOS_POLICY_ID , DDS_ENTITYFACTORY_QOS_POLICY_ID }
	Type to identify QosPolicies. More...
enum	DDS_EntityKind_t {   DDS_UNKNOWN_ENTITY_KIND = 0, DDS_PARTICIPANT_ENTITY_KIND = 1, DDS_PUBLISHER_ENTITY_KIND = 2, DDS_SUBSCRIBER_ENTITY_KIND = 3,   DDS_TOPIC_ENTITY_KIND = 4, DDS_DATAREADER_ENTITY_KIND = 5, DDS_DATAWRITER_ENTITY_KIND = 6 }
	Type of a DDS entity. More...
enum	DDS_OwnershipQosPolicyKind { DDS_SHARED_OWNERSHIP_QOS, DDS_EXCLUSIVE_OWNERSHIP_QOS }
	Kinds of ownership. More...
enum	DDS_LivelinessQosPolicyKind { DDS_AUTOMATIC_LIVELINESS_QOS, DDS_MANUAL_BY_PARTICIPANT_LIVELINESS_QOS, DDS_MANUAL_BY_TOPIC_LIVELINESS_QOS }
	Kinds of liveliness. More...
enum	DDS_ReliabilityQosPolicyKind { DDS_BEST_EFFORT_RELIABILITY_QOS, DDS_RELIABLE_RELIABILITY_QOS }
	Kinds of reliability. More...
enum	DDS_HistoryQosPolicyKind { DDS_KEEP_LAST_HISTORY_QOS, DDS_KEEP_ALL_HISTORY_QOS }
	Kinds of history. More...
enum	DDS_DurabilityQosPolicyKind { DDS_VOLATILE_DURABILITY_QOS, DDS_TRANSIENT_LOCAL_DURABILITY_QOS }
	Enumerated values used to describe the durability of published data. More...
enum	DDS_PresentationQosPolicyAccessScopeKind { DDS_INSTANCE_PRESENTATION_QOS, DDS_TOPIC_PRESENTATION_QOS, DDS_GROUP_PRESENTATION_QOS }
	Kinds of presentation "access scope". More...
enum	DDS_DestinationOrderQosPolicyKind { DDS_BY_RECEPTION_TIMESTAMP_DESTINATIONORDER_QOS, DDS_BY_SOURCE_TIMESTAMP_DESTINATIONORDER_QOS }
	Enumerated values used to describe the destination order of published data. More...
enum	DDS_DataReaderResourceLimitsInstanceReplacementKind { DDS_NO_INSTANCE_REPLACEMENT_QOS, DDS_REPLACE_OLDEST_INSTANCE_REPLACEMENT_QOS }
	Kinds of instance replacement. More...
enum	{ DDS_RTPS_AUTO_ID = 0 }
enum	DDS_PublishModeQosPolicyKind { DDS_SYNCHRONOUS_PUBLISH_MODE_QOS, DDS_ASYNCHRONOUS_PUBLISH_MODE_QOS, DDS_AUTOMATIC_PUBLISH_MODE_QOS }
	Kinds of publishing mode. More...
enum	DDS_ExceptionCode_t {   DDS_NO_EXCEPTION_CODE, DDS_USER_EXCEPTION_CODE, DDS_SYSTEM_EXCEPTION_CODE, DDS_BAD_PARAM_SYSTEM_EXCEPTION_CODE,   DDS_NO_MEMORY_SYSTEM_EXCEPTION_CODE, DDS_BAD_TYPECODE_SYSTEM_EXCEPTION_CODE, DDS_BADKIND_USER_EXCEPTION_CODE, DDS_BOUNDS_USER_EXCEPTION_CODE,   DDS_IMMUTABLE_TYPECODE_SYSTEM_EXCEPTION_CODE, DDS_BAD_MEMBER_NAME_USER_EXCEPTION_CODE, DDS_BAD_MEMBER_ID_USER_EXCEPTION_CODE }
	Exception codes. More...
enum	NDDS_Config_XTypesComplianceMaskBits { , NDDS_CONFIG_XTYPES_ENCAPSULATION_OPTIONS_WITH_PADDING_BIT }
	The bits for the NDDS_Config_XTypesComplianceMask with different aspects of the Extended CDR encoding (XCDR and XCDR2). More...

Functions
DDS_Boolean	DDS_Time_greater_than (const struct DDS_Time_t *l, const struct DDS_Time_t *r)
DDS_Boolean	DDS_Time_is_zero (const struct DDS_Time_t *time)
	Check if time is zero.
DDS_Boolean	DDS_Duration_is_infinite (const struct DDS_Duration_t *duration)
int	DDS_Duration_compare (const struct DDS_Duration_t *left, const struct DDS_Duration_t *right)
void	DDS_Duration_to_ntp_time (const struct DDS_Duration_t *self, struct OSAPI_NtpTime *dst)
	Converts a DDS_Duration_t instance into an equivalent OSAPI_NtpTime value.
void	DDS_Duration_from_ntp_time (struct DDS_Duration_t *self, const struct OSAPI_NtpTime *src)
	Fills a DDS_Duration_t instance with the value contained in an OSAPI_NtpTime object.
DDS_Boolean	DDS_Duration_equal (const struct DDS_Duration_t *self, const struct DDS_Duration_t *other)
DDS_Boolean	DDS_Duration_is_zero (const struct DDS_Duration_t *duration)
DDS_Boolean	DDS_InstanceHandle_equals (const DDS_InstanceHandle_t *self, const DDS_InstanceHandle_t *other)
	Compares this instance handle with another handle for equality.
DDS_Boolean	DDS_InstanceHandle_is_nil (const DDS_InstanceHandle_t *self)
	Compare this handle to DDS_HANDLE_NIL.
int	DDS_SequenceNumber_compare (const struct DDS_SequenceNumber_t *sn1, const struct DDS_SequenceNumber_t *sn2)
	Compares two sequence numbers.
const char *	DDSC_Library_get_version (void)
	Returns the version string for the DDS C library.
DDS_Boolean	DDS_Condition_get_trigger_value (DDS_Condition *self)
	<<cert>> Retrieve the trigger_value.
DDS_Condition *	DDS_GuardCondition_as_condition (DDS_GuardCondition *guard_cond)
	<<cert>> Access a DDS_GuardCondition's supertype instance.
DDS_GuardCondition *	DDS_GuardCondition_new (void)
	<<cert>> No argument constructor.
DDS_ReturnCode_t	DDS_GuardCondition_delete (DDS_GuardCondition *self)
	Destructor.
DDS_ReturnCode_t	DDS_GuardCondition_set_trigger_value (DDS_GuardCondition *self, DDS_Boolean value)
	<<cert>> Set the guard condition trigger value.
DDS_Condition *	DDS_StatusCondition_as_condition (DDS_StatusCondition *statusCondition)
	<<cert>> Access a DDS_StatusCondition's supertype instance.
DDS_StatusMask	DDS_StatusCondition_get_enabled_statuses (DDS_StatusCondition *self)
	<<cert>> Get the list of statuses enabled on an DDS_Entity.
DDS_ReturnCode_t	DDS_StatusCondition_set_enabled_statuses (DDS_StatusCondition *self, DDS_StatusMask mask)
	<<cert>> This operation defines the list of communication statuses that determine the trigger_value of the DDS_StatusCondition.
DDS_Entity *	DDS_StatusCondition_get_entity (DDS_StatusCondition *self)
	<<cert>> Get the DDS_Entity associated with the DDS_StatusCondition.
DDS_WaitSet *	DDS_WaitSet_new (void)
	<<cert>> Create a new, empty waitset.
DDS_ReturnCode_t	DDS_WaitSet_wait (DDS_WaitSet *self, struct DDS_ConditionSeq *active_conditions, const struct DDS_Duration_t *timeout)
	<<cert>> Allows an application thread to wait for the occurrence of certain conditions.
DDS_ReturnCode_t	DDS_WaitSet_attach_condition (DDS_WaitSet *self, DDS_Condition *cond)
	<<cert>> Attaches a DDS_Condition to the DDS_WaitSet.
DDS_ReturnCode_t	DDS_WaitSet_delete (DDS_WaitSet *self)
	Destructor.
DDS_ReturnCode_t	DDS_WaitSet_detach_condition (DDS_WaitSet *self, DDS_Condition *cond)
	Detaches a DDS_Condition from the DDS_WaitSet.
DDS_ReturnCode_t	DDS_WaitSet_get_conditions (DDS_WaitSet *self, struct DDS_ConditionSeq *attached_conditions)
	<<cert>> Retrieves the list of attached DDS_Condition (s).
DDS_ReturnCode_t	DDS_Entity_enable (DDS_Entity *self)
	<<cert>> Enables the DDS_Entity.
DDS_Boolean	DDS_Entity_is_enabled (DDS_Entity *self)
	<<cert>> Checks whether an DDS_Entity is enabled or not.
DDS_InstanceHandle_t	DDS_Entity_get_instance_handle (DDS_Entity *self)
	<<cert>> Allows access to the DDS_InstanceHandle_t associated with the DDS_Entity.
DDS_EntityKind_t	DDS_Entity_get_entity_kind (DDS_Entity *self)
	Determine the type of DDS_Entity.
DDS_StatusCondition *	DDS_Entity_get_statuscondition (DDS_Entity *self)
	<<cert>> Return the DDS_StatusCondition associated with a particular DDS_Entity.
DDS_StatusMask	DDS_Entity_get_status_changes (DDS_Entity *self)
	<<cert>> Retrieves the list of communication statuses in the DDS_Entity that are triggered.
DDS_Boolean	DDS_EntityNameQosPolicy_set_name (struct DDS_EntityNameQosPolicy *const self, const char *const name)
	Set the EntityName policy.

Variables
const DDS_Long	DDS_TIME_INVALID_SEC
	A sentinel indicating an invalid second of time.
const DDS_UnsignedLong	DDS_TIME_INVALID_NSEC
	A sentinel indicating an invalid nano-second of time.
struct DDS_Time_t	DDS_TIME_INVALID
	A sentinel indicating an invalid time.
const DDS_Long	DDS_DURATION_INFINITE_SEC
	An infinite second period of time.
const DDS_UnsignedLong	DDS_DURATION_INFINITE_NSEC
	An infinite nano-second period of time.
struct DDS_Duration_t	DDS_DURATION_INFINITE
	An infinite period of time.
const DDS_Long	DDS_DURATION_ZERO_SEC
	A zero-length second period of time.
const DDS_UnsignedLong	DDS_DURATION_ZERO_NSEC
	A zero-length nano-second period of time.
struct DDS_Duration_t	DDS_DURATION_ZERO
	A zero-length period of time.
const DDS_InstanceHandle_t	DDS_HANDLE_NIL
	The NIL instance handle.
struct DDS_GUID_t	DDS_GUID_UNKNOWN
	Unknown GUID.
const DDS_Long	DDS_LENGTH_UNLIMITED
	A special value indicating an unlimited quantity.
const DDS_Long	DDS_LENGTH_AUTO
	A special value indicating the resource-limit is determined based on other settings.
const DDS_Long	DDS_SIZE_AUTO
	A special value indicating the resource-limit is determined based on other settings.
struct DDS_RtpsWellKnownPorts_t	DDS_RTI_BACKWARDS_COMPATIBLE_RTPS_WELL_KNOWN_PORTS
	Assign to use well-known port mappings which are compatible with previous versions of the RTI Connext DDS Micro middleware.
struct DDS_RtpsWellKnownPorts_t	DDS_INTEROPERABLE_RTPS_WELL_KNOWN_PORTS
	Assign to use well-known port mappings which are compliant with OMG's DDS Interoperability Wire Protocol.
struct DDS_BuiltinTopicKey_t	DDS_BUILTINTOPICKEY_AUTO
	Constant indicating an automatically generated keyed instance in one of the built-in topics.
struct DDS_BuiltinTopicKey_t	DDS_BUILTINTOPICKEY_UNKNOWN
	Constant indicating an unknown keyed instance detected on one of the built-in topics.
const char *const	DDS_AUTO_NAME_ENTITY
	Constant used to request that an entity be assigned an automatically generated name.

---

Detailed Description

DDS Domain Module definitions.

---

Macro Definition Documentation

#define DDS_LOCATOR_DEFAULT   RTPS_LOCATOR_DEFAULT

A locator with default values.

#define DDS_PRODUCTVERSION_UNKNOWN   { 0, 0, '0', 0 }

The value used when the product version is unknown.

---

Enumeration Type Documentation

enum DDS_EntityKind_t

Type of a DDS entity.

Enumerator:

DDS_UNKNOWN_ENTITY_KIND	Entity is of an unknown type.
DDS_PARTICIPANT_ENTITY_KIND	Entity is a DDS_DomainParticipant.
DDS_PUBLISHER_ENTITY_KIND	Entity is a DDS_Publisher.
DDS_SUBSCRIBER_ENTITY_KIND	Entity is a DDS_Subscriber.
DDS_TOPIC_ENTITY_KIND	Entity is a DDS_Topic.
DDS_DATAREADER_ENTITY_KIND	Entity is a DDS_DataReader.
DDS_DATAWRITER_ENTITY_KIND	Entity is a DDS_DataWriter.

anonymous enum

Enumerator:

DDS_RTPS_AUTO_ID

Indicates that RTI Connext DDS Micro should choose an appropriate host, app, instance or object ID automatically. If this special value is assigned to DDS_WireProtocolQosPolicy::rtps_host_id, DDS_WireProtocolQosPolicy::rtps_app_id, DDS_WireProtocolQosPolicy::rtps_instance_id, DDS_DataWriterProtocolQosPolicy::rtps_object_id or DDS_DataReaderProtocolQosPolicy::rtps_object_id RTI Connext DDS Micro will assign the ID automatically. QoS: DDS_WireProtocolQosPolicy::rtps_host_id DDS_WireProtocolQosPolicy::rtps_app_id DDS_WireProtocolQosPolicy::rtps_instance_id

enum DDS_ExceptionCode_t

Exception codes.

Exceptions are modeled via a special parameter passed to the operations.

Enumerator:

DDS_NO_EXCEPTION_CODE	No exception is thrown.
DDS_USER_EXCEPTION_CODE	User exception.
DDS_SYSTEM_EXCEPTION_CODE	System exception.
DDS_BAD_PARAM_SYSTEM_EXCEPTION_CODE	Exception thrown when a parameter passed to a call is considered illegal.
DDS_NO_MEMORY_SYSTEM_EXCEPTION_CODE	Exception thrown when there is not enough memory for a dynamic memory allocation.
DDS_BAD_TYPECODE_SYSTEM_EXCEPTION_CODE	Exception thrown when a malformed type code is found (for example, a type code with an invalid TCKind value).
DDS_BADKIND_USER_EXCEPTION_CODE	The exception BadKind is thrown when an inappropriate operation is invoked on a TypeCode object.
DDS_BOUNDS_USER_EXCEPTION_CODE	A user exception thrown when a parameter is not within the legal bounds.
DDS_IMMUTABLE_TYPECODE_SYSTEM_EXCEPTION_CODE	An attempt was made to modify a DDS_TypeCode that was received from a remote object.
DDS_BAD_MEMBER_NAME_USER_EXCEPTION_CODE	The specified DDS_TypeCode member name is invalid.
DDS_BAD_MEMBER_ID_USER_EXCEPTION_CODE	The specified DDS_TypeCode member ID is invalid.

---

Variable Documentation

struct DDS_BuiltinTopicKey_t DDS_BUILTINTOPICKEY_AUTO

Constant indicating an automatically generated keyed instance in one of the built-in topics.

struct DDS_BuiltinTopicKey_t DDS_BUILTINTOPICKEY_UNKNOWN

Constant indicating an unknown keyed instance detected on one of the built-in topics.