RTI Connext DDS Micro
Version 2.4.6
|
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>
Go to the source code of this file.
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. More... | |
#define | T DDS_InstanceHandle_t |
A sequence object containing references to one or more DDS_Condition objects. More... | |
#define | DDS_STATUS_MASK_NONE |
No bits are set. More... | |
#define | DDS_STATUS_MASK_ALL |
All bits are set. More... | |
#define | T struct DDS_QosPolicyCount |
A sequence object containing references to one or more DDS_Condition objects. More... | |
#define | T struct RTPS_Locator |
A sequence object containing references to one or more DDS_Condition objects. More... | |
#define | DDS_LOCATOR_INVALID RTPS_LOCATOR_INVALID |
An invalid locator. More... | |
#define | DDS_LOCATOR_DEFAULT RTPS_LOCATOR_DEFAULT |
A locator with default values. More... | |
#define | DDS_LOCATOR_KIND_INVALID |
Locator of this kind is invalid. More... | |
#define | DDS_LOCATOR_PORT_INVALID |
An invalid port. More... | |
#define | DDS_LOCATOR_ADDRESS_INVALID RTPS_LOCATOR_ADDRESS_INVALID |
An invalid address. More... | |
#define | DDS_LOCATOR_KIND_UDPv4 |
A locator for a UDPv4 address. More... | |
#define | DDS_LOCATOR_KIND_UDPv6 |
A locator for a UDPv6 address. More... | |
#define | DDS_LOCATOR_KIND_RESERVED |
Locator of this kind is reserved. More... | |
#define | DDS_LOCATOR_KIND_SHMEM |
A locator for an address acessed via shared memory. More... | |
#define | DDS_PROTOCOLVERSION_1_0 { 1, 0 } |
The protocol version 1.0. More... | |
#define | DDS_PROTOCOLVERSION_1_1 { 1, 1 } |
The protocol version 1.1. More... | |
#define | DDS_PROTOCOLVERSION_1_2 { 1, 2 } |
The protocol version 1.2. More... | |
#define | DDS_PROTOCOLVERSION_2_0 { 2, 0 } |
The most recent protocol version. Currently 1.2. More... | |
#define | DDS_PROTOCOLVERSION_2_1 { 2, 1 } |
The protocol version 2.1. More... | |
#define | DDS_PROTOCOLVERSION { 2, 1 } |
The most recent protocol version. Currently 1.2. More... | |
#define | DDS_VENDOR_ID_LENGTH_MAX 2 |
Length of vendor id. More... | |
#define | DDS_PRODUCTVERSION_UNKNOWN { 0, 0, '0', 0 } |
The value used when the product version is unknown. More... | |
#define | T struct DDS_ConditionImpl* |
A sequence object containing references to one or more DDS_Condition objects. More... | |
#define | DDS_Listener_INITIALIZER |
Initialize the DDS_Listener::listener_data pointer to NULL. More... | |
#define | DDS_ENTITYNAME_QOS_NAME_MAX 255 |
Constant determining the maximum length of the name string contained in a DDS_EntityNameQosPolicy instance. More... | |
#define | DDS_WRITEPARAMS_DEFAULT |
Default values used to initialize instances of DDS_WriteParams_t. More... | |
Typedefs | |
typedef DDS_HANDLE_TYPE_NATIVE | DDS_InstanceHandle_t |
Type definition for an instance handle. More... | |
typedef DDS_UnsignedLong | DDS_StatusMask |
A bit-mask (list) of concrete status types, i.e. DDS_StatusKind[]. More... | |
typedef struct DDS_ProtocolVersion | DDS_ProtocolVersion_t |
<<eXtension>> <<cert>> Type used to represent the version of the RTPS protocol. More... | |
typedef struct DDS_BuiltinTopicKey_t | DDS_BuiltinTopicKey_t |
The key type of the built-in topic types. More... | |
typedef struct DDS_EntityImpl | DDS_Entity |
<<interface>> Abstract base class for all the DDS objects that support QoS policies, and a listener. More... | |
typedef struct DDS_ConditionImpl | DDS_Condition |
<<interface>> <<cert>> Root class for all the conditions that may be attached to a DDS_WaitSet. More... | |
typedef struct DDS_GuardConditionImpl | DDS_GuardCondition |
<<interface>> <<cert>> A specific DDS_Condition whose trigger_value is completely under the control of the application. More... | |
typedef struct DDS_StatusConditionImpl | DDS_StatusCondition |
<<interface>> <<cert>> A specific DDS_Condition that is associated with each DDS_Entity. More... | |
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. More... | |
typedef struct DDS_DomainEntityImpl | DDS_DomainEntity |
<<interface>> Abstract base class for all DDS entities except for the DDS_DomainParticipant. More... | |
typedef struct DDS_DomainParticipantImpl | DDS_DomainParticipant |
<<interface>> <<cert>> Container for all DDS_DomainEntity objects. More... | |
Variables | |
const DDS_Long | DDS_TIME_INVALID_SEC |
A sentinel indicating an invalid second of time. More... | |
const DDS_UnsignedLong | DDS_TIME_INVALID_NSEC |
A sentinel indicating an invalid nano-second of time. More... | |
struct DDS_Time_t | DDS_TIME_INVALID |
A sentinel indicating an invalid time. More... | |
const DDS_Long | DDS_DURATION_INFINITE_SEC |
An infinite second period of time. More... | |
const DDS_UnsignedLong | DDS_DURATION_INFINITE_NSEC |
An infinite nano-second period of time. More... | |
struct DDS_Duration_t | DDS_DURATION_INFINITE |
An infinite period of time. More... | |
const DDS_Long | DDS_DURATION_ZERO_SEC |
A zero-length second period of time. More... | |
const DDS_UnsignedLong | DDS_DURATION_ZERO_NSEC |
A zero-length nano-second period of time. More... | |
struct DDS_Duration_t | DDS_DURATION_ZERO |
A zero-length period of time. More... | |
const DDS_InstanceHandle_t | DDS_HANDLE_NIL |
The NIL instance handle. More... | |
struct DDS_GUID_t | DDS_GUID_UNKNOWN |
Unknown GUID. More... | |
const char *const | DDS_DEADLINE_QOS_POLICY_NAME |
Stringified human-readable name for DDS_DeadlineQosPolicy. More... | |
const char *const | DDS_OWNERSHIP_QOS_POLICY_NAME |
Stringified human-readable name for DDS_OwnershipQosPolicy. More... | |
const char *const | DDS_OWNERSHIPSTRENGTH_QOS_POLICY_NAME |
Stringified human-readable name for DDS_OwnershipStrengthQosPolicy. More... | |
const char *const | DDS_LIVELINESS_QOS_POLICY_NAME |
Stringified human-readable name for DDS_LivelinessQosPolicy. More... | |
const char *const | DDS_RELIABILITY_QOS_POLICY_NAME |
Stringified human-readable name for DDS_ReliabilityQosPolicy. More... | |
const char *const | DDS_HISTORY_QOS_POLICY_NAME |
Stringified human-readable name for DDS_HistoryQosPolicy. More... | |
const char *const | DDS_DURABILITY_QOS_POLICY_NAME |
Stringified human-readable name for DDS_DurabilityQosPolicy. More... | |
const char *const | DDS_RESOURCELIMITS_QOS_POLICY_NAME |
Stringified human-readable name for DDS_ResourceLimitsQosPolicy. More... | |
const DDS_Long | DDS_LENGTH_UNLIMITED |
A special value indicating an unlimited quantity. More... | |
const DDS_Long | DDS_LENGTH_AUTO |
A special value indicating the resource-limit is determined based on other settings. More... | |
const char *const | DDS_DATAREADERRESOURCELIMITS_QOS_POLICY_NAME |
Stringified human-readable name for DDS_DataReaderResourceLimitsQosPolicy. More... | |
const char *const | DDS_DATAWRITERRESOURCELIMITS_QOS_POLICY_NAME |
Stringified human-readable name for DDS_DataWriterResourceLimitsQosPolicy. More... | |
const char *const | DDS_ENTITYFACTORY_QOS_POLICY_NAME |
Stringified human-readable name for DDS_EntityFactoryQosPolicy. More... | |
const char *const | DDS_SYSTEMRESOURCELIMITS_QOS_POLICY_NAME |
Stringified human-readable name for DDS_SystemResourceLimitsQosPolicy. More... | |
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. More... | |
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. More... | |
const char *const | DDS_WIREPROTOCOL_QOS_POLICY_NAME |
Stringified human-readable name for DDS_WireProtocolQosPolicy. More... | |
const char *const | DDS_DATAREADERPROTOCOL_QOS_POLICY_NAME |
Stringified human-readable name for DDS_DataReaderProtocolQosPolicy. More... | |
const char *const | DDS_DATAWRITERPROTOCOL_QOS_POLICY_NAME |
Stringified human-readable name for DDS_DataWriterProtocolQosPolicy. More... | |
const char *const | DDS_TRANSPORT_QOS_POLICY_NAME |
Stringified human-readable name for DDS_TransportQosPolicy. More... | |
const char *const | DDS_DOMAINPARTICIPANTRESOURCELIMITS_QOS_POLICY_NAME |
Stringified human-readable name for DDS_DomainParticipantResourceLimitsQosPolicy. More... | |
struct DDS_BuiltinTopicKey_t | DDS_BUILTINTOPICKEY_AUTO |
Constant indicating an automatically generated keyed instance in one of the built-in topics. More... | |
struct DDS_BuiltinTopicKey_t | DDS_BUILTINTOPICKEY_UNKNOWN |
Constant indicating an unknown keyed instance detected on one of the built-in topics. More... | |
const char *const | DDS_ENTITYNAME_QOS_POLICY_NAME |
Stringified human-readable name for DDS_EntityNameQosPolicy. More... | |
const char *const | DDS_AUTO_NAME_ENTITY |
Constant used to request that an entity be assigned an automatically generated name. More... | |
DDS Domain Module definitions.
#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 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.
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. |
DDS_Boolean DDS_InstanceHandle_equals | ( | const DDS_InstanceHandle_t * | self, |
const DDS_InstanceHandle_t * | other | ||
) |
Check two DDS_InstanceHandle_t structures for equality.
[in] | self | Left side of comparison |
[in] | other | Right side of comparison |
DDS_Boolean DDS_InstanceHandle_is_nil | ( | const DDS_InstanceHandle_t * | self | ) |
Compare this handle to DDS_HANDLE_NIL.
const DDS_InstanceHandle_t DDS_HANDLE_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.