CoreDX DDS
C++ Reference Manual

dds.hh File Reference

CoreDX DDS C++ API Header File. The include/dds.hh file provides all of the CoreDX DDS declarations for C++ DDS datatypes and functions. This file should be included by C++ application code that uses the C++ DDS Application Programming Interface. More...

Go to the source code of this file.

Classes

struct  UserDataQosPolicy
 Allows the application to attach arbitrary information to a DomainParticipant, DataWriter or DataReader QoS. More...
struct  TopicDataQosPolicy
 Allows the application to attach arbitrary information to a Topic QoS. More...
struct  GroupDataQosPolicy
 Allows the application to attach arbitrary information to a Publisher or Subscriber. More...
struct  TransportPriorityQosPolicy
 A hint to the middleware to help configure the transport priority mechanism. More...
struct  LifespanQosPolicy
 Specifies the maximum duration of validity of the data written by the DataWriter. More...
struct  DurabilityQosPolicy
 The DurablityQosPolicy controls the durablity of data. More...
struct  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  DeadlineQosPolicy
 This QoS policy establishes a minimum update period for data instances. More...
struct  LatencyBudgetQosPolicy
 Specifies allowable latency. More...
struct  OwnershipQosPolicy
 Determines instance ownership in the case of multple writers. CoreDX DDS supports both SHARED_OWNERSHIP_QOS and EXCLUSIVE_OWNERSHIP_QOS. More...
struct  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  LivelinessQosPolicy
 Determines the mechanism and parameters used by the application to determine whether an Entity is alive. More...
struct  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  PartitionQosPolicy
 Defines a logical data partition. More...
struct  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  DestinationOrderQosPolicy
 This QoS policy controls how each Subscriber orders received data samples. More...
struct  HistoryQosPolicy
 Controls the ammount of historical data maintained by a DataReader or DataWriter. More...
struct  ResourceLimitsQosPolicy
 Specifies the resources that the Service can use to maintain data samples and instances. More...
struct  EntityFactoryQosPolicy
struct  WriterDataLifecycleQosPolicy
 Specifies the lifecycle behavior of data instances managed by the DataWriter. If autodispose_unregistered_instances is true, then the DataWriter will automatically dispose any instances that are unregistered. Note: When a DataWriter is deleted, it will automatically unregister all of its instances. With this policy == true, then all instances will also be disposed. More...
struct  ReaderDataLifecycleQosPolicy
 Specifies the lifecycle behavior of data instances managed by the DataReader. More...
struct  DurabilityServiceQosPolicy
struct  EntityNameQosPolicy
struct  LoggingQosPolicy
 Controls the amount and kind of data that is logged. More...
struct  Locator
 Network address. More...
struct  ParticipantLocator
 Describes a the location and identity of a potential peer DomainParticipant. More...
struct  PeerParticipantQosPolicy
 Configures a list of DomainParticipant peers to attempt communication with. More...
struct  TypecodeQosPolicy
 Typecode representing the datatype a DataReader reads or a DataWriter writes. More...
struct  RTPSWriterQosPolicy
 QoS Policy for configuring aspects of the RTPS Writer Protocol. More...
struct  RTPSReaderQosPolicy
 QoS Policy for configuring aspects of the RTPS Reader Protocol. More...
struct  DiscoveryQosPolicy
 QoS Policy for configuring aspects of the Discovery and Builtin entities. More...
struct  ThreadModelQosPolicy
 QoS Policy for configuring the threading behavior of the DomainParticipant. More...
struct  DomainParticipantFactoryQos
 Structure that holds DomainParticipantFactory Quality of Service policies. More...
struct  DomainParticipantQos
 Structure that holds DomainParticipant Quality of Service policies. More...
class  DDS::TopicQos
 Structure that holds Topic Quality of Service policies. More...
class  DDS::DataWriterQos
 Structure that holds DataWriter Quality of Service policies. More...
class  DDS::PublisherQos
 Structure that holds Publisher Quality of Service policies. More...
class  DDS::DataReaderQos
 Structure that holds DataReader Quality of Service policies. More...
class  DDS::SubscriberQos
 Structure that holds Subscriber Quality of Service policies. More...
class  DDS::Entity
 Base class for all DDS Entities. More...
class  DDS::DomainEntity
 Base class for all DDS Domain Entities. More...
class  DDS::DomainParticipantFactory
 DomainParticipantFactory constructs DomainParticipants. The. More...
class  DDS::DomainParticipant
 The DomainParticipant is used to configure, create and destroy Publisher, Subscriber and Topic objects. More...
class  DDS::Publisher
 The Publisher configures, creates, manages and destroys DataWriters. More...
class  DDS::Subscriber
 The Subscriber configures, creates, manages and destroys DataReaders. More...
class  DDS::TopicDescription
 TopicDescription is an abstract 'class' that provides the foundation for Topic, ContentFilteredTopic, and MultiTopic. More...
class  DDS::Topic
 Topic is the basic description of data to be published or subscribed. More...
class  DDS::ContentFilteredTopic
 ContentFilteredTopic provides a topic that may exclude data based on a specified filter. The ContentFilteredTopic is associated with another un-filtered topic related_topic. It applies a filter to the data of the related topic. If a data sample passes the filter, it will be made available to a DataReader associated with the ContentFilteredTopic. More...
class  DDS::DataWriter
 The DataWriter entity provides an interface for the application to publish (write) data. More...
class  DDS::DataReader
 The DataReader entity allows the application to subscribe to and read data. More...
class  DDS::Condition
 A Condition can be added to a WaitSet to provide synchronous event notification. More...
class  DDS::GuardCondition
 A GuardCondition is a condition where the trigger_value is under application control. More...
class  DDS::StatusCondition
 A StatusCondition is a condition associated with an Entity. More...
class  DDS::ReadCondition
 A ReadCondition is a specialized Condition associated with a DataReader. More...
class  DDS::QueryCondition
 A QueryCondition is a specialized ReadCondition which includes a filter. More...
class  DDS::WaitSet
 A WaitSet maintains a set of Condition objects and allows the application to wait until one or more of them have a trigger_value of TRUE. More...
class  DDS::DataWriterListener
 The DataWriterListener provides asynchronous notification of DataWriter events. More...
class  DDS::PublisherListener
 The PublisherListener provides asynchronous notification of Publisher events. More...
class  DDS::TopicListener
 The TopicListener provides asynchronous notification of Topic events. More...
class  DDS::DataReaderListener
 The DataReaderListener provides asynchronous notification of DataReader events. More...
class  DDS::SubscriberListener
 The SubscriberListener provides asynchronous notification of Subscriber events. More...
class  DDS::DomainParticipantListener
 The DomainParticipantListener provides asynchronous notification of DomainParticipant events. More...

Typedefs

typedef DDS::sequence
< unsigned char > 
DDS::OctetSeq
 sequence of octets
typedef DDS::sequence
< SampleInfo * > 
DDS::SampleInfoSeq
 sequence of SampleInfo pointers
typedef DDS::sequence
< DataReader * > 
DDS::DataReaderSeq
 sequence of DataReader pointers
typedef DDS::sequence
< InstanceHandle_t > 
DDS::InstanceHandleSeq
 sequence of InstanceHandle_t s
typedef DDS::sequence
< Condition * > 
DDS::ConditionSeq
 sequence of Condition pointers
typedef DDS::sequence< char * > DDS::StringSeq
 sequence of character pointers (c strings)
typedef DDS::sequence< void * > DDS::Sequence
 sequence of void pointers

Enumerations

enum  DurabilityQosPolicyKind {
  DDS::VOLATILE_DURABILITY_QOS,
  DDS::TRANSIENT_LOCAL_DURABILITY_QOS,
  DDS::TRANSIENT_DURABILITY_QOS,
  DDS::PERSISTENT_DURABILITY_QOS
}
 

This enumeration contains the kinds of Durability.


enum  PresentationQosPolicyAccessScopeKind {
  DDS::INSTANCE_PRESENTATION_QOS,
  DDS::TOPIC_PRESENTATION_QOS,
  DDS::GROUP_PRESENTATION_QOS
}
 

This enumeration contains the kinds of Access Scope for the PresentationQosPolicy.


enum  OwnershipQosPolicyKind {
  DDS::SHARED_OWNERSHIP_QOS,
  DDS::EXCLUSIVE_OWNERSHIP_QOS
}
 

This enumeration contains the kinds of Ownership.


enum  LivelinessQosPolicyKind {
  DDS::AUTOMATIC_LIVELINESS_QOS,
  DDS::MANUAL_BY_PARTICIPANT_LIVELINESS_QOS,
  DDS::MANUAL_BY_TOPIC_LIVELINESS_QOS
}
 

This enumeration contains the kinds of Liveliness.


enum  ReliabilityQosPolicyKind { ,
  DDS::BEST_EFFORT_RELIABILITY_QOS,
  DDS::RELIABLE_RELIABILITY_QOS
}
 

This enumeration contains the kinds of Reliability.


enum  DestinationOrderQosPolicyKind {
  DDS::BY_RECEPTION_TIMESTAMP_DESTINATIONORDER_QOS,
  DDS::BY_SOURCE_TIMESTAMP_DESTINATIONORDER_QOS
}
 

This enumeration contains the kinds of Destination Ordering.


enum  HistoryQosPolicyKind {
  DDS::KEEP_LAST_HISTORY_QOS,
  DDS::KEEP_ALL_HISTORY_QOS
}
 

This enumeration contains the kinds of History.


enum  DiscoveryQosPolicyDiscoveryKind {
  DDS::PEER_DISCOVERY_QOS,
  DDS::CENTRAL_DISCOVERY_QOS
}
 

This enumeration contains the kinds of Discovery.



Detailed Description

CoreDX DDS C++ API Header File. The include/dds.hh file provides all of the CoreDX DDS declarations for C++ DDS datatypes and functions. This file should be included by C++ application code that uses the C++ DDS Application Programming Interface.

 All Classes Files Functions Variables

© 2009-2013 Twin Oaks Computing, Inc
Castle Rock, CO 80108
All rights reserved.