DDS Domain Module definitions. More...

#include "dds_c/dds_c_dll.h"
#include "osapi/osapi_thread.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 <reda/reda_sequence_decl.h>

Data Structures
struct	DDS_Time_t
	Type for time representation. More...
struct	DDS_Duration_t
	Type for duration representation. 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_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 Micro. More...
struct	DDS_HistoryQosPolicy
	<<cert>> Specifies the behavior of RTI Connext 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
	Durability properties that affect the life-cycle of published data. More...
struct	DDS_ResourceLimitsQosPolicy
	<<cert>> Specifies the resources that RTI Connext Micro can consume in order to meet the requested QoS. 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_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_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 Micro. More...
struct	DDS_ProductVersion_t
	<<eXtension>> <<cert>> Type used to represent the current version of RTI Connext Micro. 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...

Macros
#define	DDS_TIME_ZERO
	The default instant in time: zero seconds and zero nanoseconds.
#define	T DDS_InstanceHandle_t
	A sequence object containing references to one or more DDS_Condition objects.
#define	DDS_STATUS_MASK_NONE
	No bits are set.
#define	DDS_STATUS_MASK_ALL
	All bits are set.
#define	T struct DDS_QosPolicyCount
	A sequence object containing references to one or more DDS_Condition objects.
#define	T struct RTPS_Locator
	A sequence object containing references to one or more DDS_Condition objects.
#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 sequence object containing references to one or more DDS_Condition objects.
#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.

Typedefs
typedef DDS_HANDLE_TYPE_NATIVE	DDS_InstanceHandle_t
	Type definition for an instance handle.
typedef DDS_UnsignedLong	DDS_StatusMask
	A bit-mask (list) of concrete status types, i.e. DDS_StatusKind[].
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.

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 }
	Type for return codes. Errors are modeled as operation return codes of this type. 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 }
	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_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 }
	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_DataReaderResourceLimitsInstanceReplacementKind { DDS_NO_INSTANCE_REPLACEMENT_QOS, DDS_REPLACE_OLDEST_INSTANCE_REPLACEMENT_QOS }
	Kinds of instance replacement. More...
enum	{ DDS_RTPS_AUTO_ID = 0 }

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)
	Check two DDS_InstanceHandle_t structures 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.
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 char *const	DDS_DEADLINE_QOS_POLICY_NAME
	Stringified human-readable name for DDS_DeadlineQosPolicy.
const char *const	DDS_OWNERSHIP_QOS_POLICY_NAME
	Stringified human-readable name for DDS_OwnershipQosPolicy.
const char *const	DDS_OWNERSHIPSTRENGTH_QOS_POLICY_NAME
	Stringified human-readable name for DDS_OwnershipStrengthQosPolicy.
const char *const	DDS_LIVELINESS_QOS_POLICY_NAME
	Stringified human-readable name for DDS_LivelinessQosPolicy.
const char *const	DDS_RELIABILITY_QOS_POLICY_NAME
	Stringified human-readable name for DDS_ReliabilityQosPolicy.
const char *const	DDS_HISTORY_QOS_POLICY_NAME
	Stringified human-readable name for DDS_HistoryQosPolicy.
const char *const	DDS_DURABILITY_QOS_POLICY_NAME
	Stringified human-readable name for DDS_DurabilityQosPolicy.
const char *const	DDS_RESOURCELIMITS_QOS_POLICY_NAME
	Stringified human-readable name for DDS_ResourceLimitsQosPolicy.
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 char *const	DDS_DATAREADERRESOURCELIMITS_QOS_POLICY_NAME
	Stringified human-readable name for DDS_DataReaderResourceLimitsQosPolicy.
const char *const	DDS_DATAWRITERRESOURCELIMITS_QOS_POLICY_NAME
	Stringified human-readable name for DDS_DataWriterResourceLimitsQosPolicy.
const char *const	DDS_ENTITYFACTORY_QOS_POLICY_NAME
	Stringified human-readable name for DDS_EntityFactoryQosPolicy.
const char *const	DDS_SYSTEMRESOURCELIMITS_QOS_POLICY_NAME
	Stringified human-readable name for DDS_SystemResourceLimitsQosPolicy.
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 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.
const char *const	DDS_WIREPROTOCOL_QOS_POLICY_NAME
	Stringified human-readable name for DDS_WireProtocolQosPolicy.
const char *const	DDS_DATAREADERPROTOCOL_QOS_POLICY_NAME
	Stringified human-readable name for DDS_DataReaderProtocolQosPolicy.
const char *const	DDS_DATAWRITERPROTOCOL_QOS_POLICY_NAME
	Stringified human-readable name for DDS_DataWriterProtocolQosPolicy.
const char *const	DDS_TRANSPORT_QOS_POLICY_NAME
	Stringified human-readable name for DDS_TransportQosPolicy.
const char *const	DDS_DOMAINPARTICIPANTRESOURCELIMITS_QOS_POLICY_NAME
	Stringified human-readable name for DDS_DomainParticipantResourceLimitsQosPolicy.
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_ENTITYNAME_QOS_POLICY_NAME
	Stringified human-readable name for DDS_EntityNameQosPolicy.
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 T DDS_InstanceHandle_t

A sequence object containing references to one or more DDS_Condition objects.

#define T struct DDS_QosPolicyCount

A sequence object containing references to one or more DDS_Condition objects.

#define T struct RTPS_Locator

A sequence object containing references to one or more DDS_Condition objects.

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

#define T struct DDS_ConditionImpl*

A sequence object containing references to one or more DDS_Condition objects.

Typedef Documentation

typedef DDS_HANDLE_TYPE_NATIVE DDS_InstanceHandle_t

Type definition for an instance handle.

Handle to identiy different instances of the same DDS_Topic of a certain type.

See also:: DDS_DataWriter_register_instance; DDS_SampleInfo::instance_handle

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 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 Micro will assign the ID automatically. The actual ID value is chosen when the QoS is set: the QoS returned from DDS_DomainParticipant_get_qos, DDS_DataWriter_get_qos or DDS_DataReader_get_qos will never have this value.

QoS:: DDS_WireProtocolQosPolicy::rtps_host_id DDS_WireProtocolQosPolicy::rtps_app_id DDS_WireProtocolQosPolicy::rtps_instance_id

Function Documentation

DDS_Boolean DDS_InstanceHandle_equals	(	const DDS_InstanceHandle_t *	self,
		const DDS_InstanceHandle_t *	other
	)

Check two DDS_InstanceHandle_t structures for equality.

Parameters:

[in]	self	Left side of comparison
[in]	other	Right side of comparison

Returns:: DDS_BOOLEAN_TRUE if the two structures are equal, DDS_BOOLEAN_FALSE otherwise

DDS_Boolean DDS_InstanceHandle_is_nil ( const DDS_InstanceHandle_t * self )

Compare this handle to DDS_HANDLE_NIL.

Returns:: DDS_BOOLEAN_TRUE if the given instance handle is equal to DDS_HANDLE_NIL or DDS_BOOLEAN_FALSE otherwise.

See also:: DDS_InstanceHandle_equals

Variable Documentation

const DDS_InstanceHandle_t DDS_HANDLE_NIL

The NIL instance handle.

Special DDS_InstanceHandle_t value

See also:: DDS_InstanceHandle_is_nil

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.

Data Structures

Macros

Typedefs

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation