CoreDX DDS C Reference Manual
|
Go to the source code of this file.
Classes | |
| struct | DDS_Duration_t |
| The Duration_t structure contains data to define a time duration. More... | |
| struct | DDS_UserDataQosPolicy |
| Allows the application to attach arbitrary information to a DomainParticipant, DataWriter or DataReader QoS. More... | |
| struct | DDS_TopicDataQosPolicy |
| Allows the application to attach arbitrary information to a Topic QoS. More... | |
| struct | DDS_GroupDataQosPolicy |
| Allows the application to attach arbitrary information to a Publisher or Subscriber. More... | |
| struct | DDS_TransportPriorityQosPolicy |
| A hint to the middleware to help configure the transport priority mechanism. More... | |
| struct | DDS_LifespanQosPolicy |
| Specifies the maximum duration of validity of the data written by the DataWriter. More... | |
| struct | DDS_DurabilityQosPolicy |
| The DurabilityQosPolicy controls the durablity of data. More... | |
| struct | DDS_PresentationQosPolicy |
| Controls the presentation of received data samples to the application. CoreDX DDS currently supports only the access_scope = INSTANCE_PRESENTATION_QOS policy. More... | |
| struct | DDS_DeadlineQosPolicy |
| This QoS policy establishes a minimum update period for data instances. More... | |
| struct | DDS_LatencyBudgetQosPolicy |
| Specifies allowable latency. More... | |
| struct | DDS_OwnershipQosPolicy |
| Determines instance ownership in the case of multple writers. CoreDX DDS supports both SHARED_OWNERSHIP_QOS and EXCLUSIVE_OWNERSHIP_QOS. More... | |
| struct | DDS_OwnershipStrengthQosPolicy |
| Defines the strength, or priority, of a Writer. The strength is used to determine ownership in the case of EXCLUSIVE_OWNERSHIP_QOS. When multiple writers publish data about the same instance, the stronger writer is considered the owner, and data from other writers is not delivered to the reader. More... | |
| struct | DDS_LivelinessQosPolicy |
| Determines the mechanism and parameters used by the application to determine whether an Entity is alive. More... | |
| struct | DDS_TimeBasedFilterQosPolicy |
| Defines a filter based on time between samples. The DataReader indicates that it wants at most one sample for each instance every minimum_separation interval. More... | |
| struct | DDS_PartitionQosPolicy |
| Defines a logical data partition. More... | |
| struct | DDS_ReliabilityQosPolicy |
| Indicates the level of reliability offered/provided by the Entity. If kind is RELIABLE_RELIABILITY_QOS, then the middleware will attempt to deliver all samples in the history cache. If samples are not received, then they will be retried. More... | |
| struct | DDS_DestinationOrderQosPolicy |
| This QoS policy controls how each Subscriber orders received data samples. More... | |
| struct | DDS_HistoryQosPolicy |
| Controls the ammount of historical data maintained by a DataReader or DataWriter. More... | |
| struct | DDS_ResourceLimitsQosPolicy |
| Specifies the resources that the Service can use to maintain data samples and instances. More... | |
| struct | DDS_DurabilityServiceQosPolicy |
| struct | DDS_DataRepresentationQosPolicy |
| Describes the data representation used by a topic. More... | |
| struct | DDS_TypeConsistencyEnforcementQosPolicy |
| rules for determining type consistency More... | |
| struct | DDS_TypecodeQosPolicy |
| Typecode representing the datatype a DataReader reads or a DataWriter writes. More... | |
| struct | DDS_RpcQosPolicy |
| Augment a DataWriter or DataReader with RPC specific information. More... | |
| struct | DDS_Property_t |
| A name-value pair property. The 'propagate' flag indicates if this property should be transfered through discovery. More... | |
| struct | DDS_PropertyQosPolicy |
| struct | DDS_DCPSParticipant |
| struct | DDS_DCPSPublication |
| struct | DDS_DCPSSubscription |
Macros | |
| #define | DDS_VOLATILE_DURABILITY_QOS 0 |
| The data is volatile, and is not persisted beyond the initial publication. | |
| #define | DDS_TRANSIENT_LOCAL_DURABILITY_QOS 1 |
| The data is persisted locally within the source DataWriter. | |
| #define | DDS_TRANSIENT_DURABILITY_QOS 2 |
| #define | DDS_PERSISTENT_DURABILITY_QOS 3 |
| #define | DDS_INSTANCE_PRESENTATION_QOS 0 |
| The scope is within an Instance. | |
| #define | DDS_TOPIC_PRESENTATION_QOS 1 |
| The scope is within samples published by DataWriters on the Topic. | |
| #define | DDS_GROUP_PRESENTATION_QOS 2 |
| The scope is within samples published by DataWriters within the Publisher. | |
| #define | DDS_SHARED_OWNERSHIP_QOS 0 |
| DataReaders receive data published by multiple DataWriters. | |
| #define | DDS_EXCLUSIVE_OWNERSHIP_QOS 1 |
| DataReaders receive data published by the highest strength DataWriter for each Instance. | |
| #define | DDS_AUTOMATIC_LIVELINESS_QOS 0 |
| The DomainParticipant automatically asserts liveliness for all DataWriters within the DomainParticipant. | |
| #define | DDS_MANUAL_BY_PARTICIPANT_LIVELINESS_QOS 1 |
| The application manually asserts the liveliness all DataWriters within this DomainParticipant by calling assert_liveliness() or writing data on any one DataWriter within this DomainParticipant. | |
| #define | DDS_MANUAL_BY_TOPIC_LIVELINESS_QOS 2 |
| The application manually asserts the liveliness for each individual DataWriter by calling assert_liveliness() or writing data on that DataWriter. | |
| #define | DDS_BEST_EFFORT_RELIABILITY_QOS 1 |
| Best effort delivery – NO retransmission, HB, or ACKNACK. | |
| #define | DDS_RELIABLE_RELIABILITY_QOS 2 |
| Reliable delivery – HB, ACKNACK, and re-transmission. | |
| #define | DDS_BY_RECEPTION_TIMESTAMP_DESTINATIONORDER_QOS 0 |
| Use the reception time to determine the order of samples. | |
| #define | DDS_BY_SOURCE_TIMESTAMP_DESTINATIONORDER_QOS 1 |
| Use the timestamp set by the publisher to determine the order of samples. | |
| #define | DDS_KEEP_LAST_HISTORY_QOS 0 |
| Store at most depth Samples in the data cache for each Instance. Samples may be overwritten. | |
| #define | DDS_KEEP_ALL_HISTORY_QOS 1 |
| Store Samples for each Instance (up to the limits specified by ResourceLimitsQosPolicy) until the DDS infrastructure is finished with them. Until this time, Samples may not be overwritten. | |
| #define | DDS_XCDR_DATA_REPRESENTATION 0 /* type: DDS_DataRepresentationId_t */ |
| a DDS_DataRepresentationId_t that indicates XCDR form. | |
| #define | DDS_XML_DATA_REPRESENTATION 1 /* type: DDS_DataRepresentationId_t */ |
| a DDS_DataRepresentationId_t that indicates XML form. | |
| #define | DDS_DISALLOW_TYPE_COERCION 0 |
| #define | DDS_ALLOW_TYPE_COERCION 1 |
Typedefs | |
| typedef unsigned int | DDS_DurabilityQosPolicyKind |
| This enumeration contains the kinds of Durability. | |
| typedef unsigned int | DDS_PresentationQosPolicyAccessScopeKind |
| This enumeration contains the kinds of Access Scope for the PresentationQosPolicy. | |
| typedef unsigned int | DDS_OwnershipQosPolicyKind |
| This enumeration contains the kinds of Ownership. | |
| typedef unsigned int | DDS_LivelinessQosPolicyKind |
| This enumeration contains the kinds of Liveliness. | |
| typedef unsigned int | DDS_ReliabilityQosPolicyKind |
| This enumeration contains the kinds of Reliability. | |
| typedef unsigned int | DDS_DestinationOrderQosPolicyKind |
| This enumeration contains the kinds of Destination Ordering. | |
| typedef unsigned int | DDS_HistoryQosPolicyKind |
| This enumeration contains the kinds of History. | |
| typedef short | DDS_DataRepresentationId_t |
| Indicates the form of data, for example CDR or XML. | |
| typedef unsigned short | DDS_TypeConsistencyKind |
| the allowed kinds of TypeConsistency | |
| #define DDS_ALLOW_TYPE_COERCION 1 |
allow coercion
| #define DDS_DISALLOW_TYPE_COERCION 0 |
disallow coercion (type name and structure must match)
| #define DDS_PERSISTENT_DURABILITY_QOS 3 |
The data is persisted to 'off-line' storage, and is available even after a system reboot.
| #define DDS_TRANSIENT_DURABILITY_QOS 2 |
The data is persisted beyond the lifecycle of the originating DataWriter, and is available even after that DataWriter has been destroyed.
