CoreDX DDS C++ Reference Manual
Classes | Typedefs | Functions
DDS Quality of Service

Classes

class  DDS::DomainParticipantFactoryQos
 Structure that holds DomainParticipantFactory Quality of Service policies. More...
 
class  DDS::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::QosProvider
 QosProvider loads QoS settings from a library and provides interfaces to access entity specific QoS Policies. More...
 

Typedefs

typedef short DDS::DataRepresentationId_t
 Indicates the form of data, for example CDR or XML.
 

Functions

 DDS::QosProvider::QosProvider (const char *uri, const char *profile, CDX_XmlApi *xml_parser)
 Constructor. Creates a new QosProvider instance that loads QoS settings from a library. More...
 
 DDS::QosProvider::~QosProvider ()
 Destructor. Returns a QosProvider back to the factory. More...
 
DomainParticipantFactoryQos * DDS::QosProvider::get_participantfactory_qos (const char *id)
 Access a DomainParticipantFactory QoS. More...
 
void DDS::QosProvider::return_participantfactory_qos (DomainParticipantFactoryQos *qos)
 Return a DomainParticipanFactoryQos back to the factory. More...
 
DomainParticipantQos * DDS::QosProvider::get_participant_qos (const char *id)
 Access a DomainParticipant QoS. More...
 
void DDS::QosProvider::return_participant_qos (DomainParticipantQos *qos)
 Return a DomainParticipantQos back to the factory. More...
 
TopicQos * DDS::QosProvider::get_topic_qos (const char *id)
 Access a Topic QoS. More...
 
void DDS::QosProvider::return_topic_qos (TopicQos *qos)
 Return a TopicQos back to the factory. More...
 
SubscriberQos * DDS::QosProvider::get_subscriber_qos (const char *id)
 Access a Subscriber QoS. More...
 
void DDS::QosProvider::return_subscriber_qos (SubscriberQos *qos)
 Return a SubscriberQos back to the factory. More...
 
PublisherQos * DDS::QosProvider::get_publisher_qos (const char *id)
 Access a Publisher QoS. More...
 
void DDS::QosProvider::return_publisher_qos (PublisherQos *qos)
 Return a PublisherQos back to the factory. More...
 
DataReaderQos * DDS::QosProvider::get_datareader_qos (const char *id)
 Access a DataReader QoS. More...
 
void DDS::QosProvider::return_datareader_qos (DataReaderQos *qos)
 Return a DataReaderQos back to the factory. More...
 
DataWriterQos * DDS::QosProvider::get_datawriter_qos (const char *id)
 Access a DataWriter QoS. More...
 
void DDS::QosProvider::return_datawriter_qos (DataWriterQos *qos)
 Return a DataWriterQos back to the factory. More...
 

Detailed Description

Function Documentation

DataReaderQos* DDS::QosProvider::get_datareader_qos ( const char *  id)

Access a DataReader QoS.

If 'id' is NULL, then the first instance of DataReaderQos in the library is returned. If 'id' is not NULL, then the 'name' field of the QoS policy is checked, and the first match is returned.

DataWriterQos* DDS::QosProvider::get_datawriter_qos ( const char *  id)

Access a DataWriter QoS.

If 'id' is NULL, then the first instance of DataWriterQos in the library is returned. If 'id' is not NULL, then the 'name' field of the QoS policy is checked, and the first match is returned.

DomainParticipantQos* DDS::QosProvider::get_participant_qos ( const char *  id)

Access a DomainParticipant QoS.

If 'id' is NULL, then the first instance of DomainParticipantQos in the library is returned. If 'id' is not NULL, then the 'name' field of the QoS policy is checked, and the first match is returned.

DomainParticipantFactoryQos* DDS::QosProvider::get_participantfactory_qos ( const char *  id)

Access a DomainParticipantFactory QoS.

If 'id' is NULL, then the first instance of DomainParticipantFactoryQos in the library is returned. If 'id' is not NULL, then the 'name' field of the DomainParticpantFactoryQos is checked, and the first match is returned.

PublisherQos* DDS::QosProvider::get_publisher_qos ( const char *  id)

Access a Publisher QoS.

If 'id' is NULL, then the first instance of PublisherQos in the library is returned. If 'id' is not NULL, then the 'name' field of the QoS policy is checked, and the first match is returned.

SubscriberQos* DDS::QosProvider::get_subscriber_qos ( const char *  id)

Access a Subscriber QoS.

If 'id' is NULL, then the first instance of SubscriberQos in the library is returned. If 'id' is not NULL, then the 'name' field of the QoS policy is checked, and the first match is returned.

TopicQos* DDS::QosProvider::get_topic_qos ( const char *  id)

Access a Topic QoS.

If 'id' is NULL, then the first instance of TopicQos in the library is returned. If 'id' is not NULL, then the 'name' field of the QoS policy is checked, and the first match is returned.

DDS::QosProvider::QosProvider ( const char *  uri,
const char *  profile,
CDX_XmlApi xml_parser 
)

Constructor. Creates a new QosProvider instance that loads QoS settings from a library.

The QoS library source is indicated by 'uri'. Currently CoreDX DDS supports only the 'file:///' type URI. The QosProvider selects QoS policies from the library based on the 'profile' parameter. The 'xml_parser' paramater provides the implementation of an XML parser that should be used to parse the QoS library document. CoreDX DDS provides an implementation of CDX_XmlApi based on libxml2 named 'cdx_libxml2_impl' available in the include/dds/xml_api.h header file. Alternate implemenations are also available, including on based on RapidXML.

void DDS::QosProvider::return_datareader_qos ( DataReaderQos qos)

Return a DataReaderQos back to the factory.

This will reclaim any resources allocated by the QosProvider.

void DDS::QosProvider::return_datawriter_qos ( DataWriterQos qos)

Return a DataWriterQos back to the factory.

This will reclaim any resources allocated by the QosProvider.

void DDS::QosProvider::return_participant_qos ( DomainParticipantQos qos)

Return a DomainParticipantQos back to the factory.

This will reclaim any resources allocated by the QosProvider.

void DDS::QosProvider::return_participantfactory_qos ( DomainParticipantFactoryQos qos)

Return a DomainParticipanFactoryQos back to the factory.

This will reclaim any resources allocated by the QosProvider.

void DDS::QosProvider::return_publisher_qos ( PublisherQos qos)

Return a PublisherQos back to the factory.

This will reclaim any resources allocated by the QosProvider.

void DDS::QosProvider::return_subscriber_qos ( SubscriberQos qos)

Return a SubscriberQos back to the factory.

This will reclaim any resources allocated by the QosProvider.

void DDS::QosProvider::return_topic_qos ( TopicQos qos)

Return a TopicQos back to the factory.

This will reclaim any resources allocated by the QosProvider.

DDS::QosProvider::~QosProvider ( )

Destructor. Returns a QosProvider back to the factory.

This will reclaim any resources allocated by the QosProvider.


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