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

Classes

struct  DDS_DomainParticipantFactoryQos
 Structure that holds DDS_DomainParticipantFactory Quality of Service policies. More...
 
struct  DDS_DomainParticipantQos
 Structure that holds DDS_DomainParticipant Quality of Service policies. More...
 
struct  DDS_TopicQos
 Structure that holds DDS_Topic Quality of Service policies. More...
 
struct  DDS_DataWriterQos
 Structure that holds DDS_DataWriter Quality of Service policies. More...
 
struct  DDS_PublisherQos
 Structure that holds DDS_Publisher Quality of Service policies. More...
 
struct  DDS_DataReaderQos
 Structure that holds DDS_DataReader Quality of Service policies. More...
 
struct  DDS_SubscriberQos
 Structure that holds DDS_Subscriber Quality of Service policies. More...
 

Macros

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

Typedefs

typedef short DDS_DataRepresentationId_t
 Indicates the form of data, for example CDR or XML.
 

Functions

DDS_QosProviderDDS_QosProvider_newQosProvider (const char *uri, const char *profile, CDX_XmlApi *xml_parser)
 Create a new QosProvider instance that loads QoS settings from a library. More...
 
void DDS_QosProvider_return_provider (DDS_QosProvider *qp)
 Return a QosProvider back to the factory. More...
 
DDS_DomainParticipantFactoryQosDDS_QosProvider_get_participantfactory_qos (DDS_QosProvider *qp, const char *id)
 Access a DomainParticipantFactory QoS. More...
 
void DDS_QosProvider_return_participantfactory_qos (DDS_QosProvider *qp, DDS_DomainParticipantFactoryQos *qos)
 Return a DomainParticipanFactoryQos back to the factory. More...
 
DDS_DomainParticipantQosDDS_QosProvider_get_participant_qos (DDS_QosProvider *qp, const char *id)
 Access a DomainParticipant QoS. More...
 
void DDS_QosProvider_return_participant_qos (DDS_QosProvider *qp, DDS_DomainParticipantQos *qos)
 Return a DomainParticipantQos back to the factory. More...
 
DDS_TopicQosDDS_QosProvider_get_topic_qos (DDS_QosProvider *qp, const char *id)
 Access a Topic QoS. More...
 
void DDS_QosProvider_return_topic_qos (DDS_QosProvider *qp, DDS_TopicQos *qos)
 Return a TopicQos back to the factory. More...
 
DDS_SubscriberQosDDS_QosProvider_get_subscriber_qos (DDS_QosProvider *qp, const char *id)
 Access a Subscriber QoS. More...
 
void DDS_QosProvider_return_subscriber_qos (DDS_QosProvider *qp, DDS_SubscriberQos *qos)
 Return a SubscriberQos back to the factory. More...
 
DDS_PublisherQosDDS_QosProvider_get_publisher_qos (DDS_QosProvider *qp, const char *id)
 Access a Publisher QoS. More...
 
void DDS_QosProvider_return_publisher_qos (DDS_QosProvider *qp, DDS_PublisherQos *qos)
 Return a PublisherQos back to the factory. More...
 
DDS_DataReaderQosDDS_QosProvider_get_datareader_qos (DDS_QosProvider *qp, const char *id)
 Access a DataReader QoS. More...
 
void DDS_QosProvider_return_datareader_qos (DDS_QosProvider *qp, DDS_DataReaderQos *qos)
 Return a DataReaderQos back to the factory. More...
 
DDS_DataWriterQosDDS_QosProvider_get_datawriter_qos (DDS_QosProvider *qp, const char *id)
 Access a DataWriter QoS. More...
 
void DDS_QosProvider_return_datawriter_qos (DDS_QosProvider *qp, DDS_DataWriterQos *qos)
 Return a DataWriterQos back to the factory. More...
 

Detailed Description

Function Documentation

DDS_DataReaderQos* DDS_QosProvider_get_datareader_qos ( DDS_QosProvider qp,
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.

DDS_DataWriterQos* DDS_QosProvider_get_datawriter_qos ( DDS_QosProvider qp,
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.

DDS_DomainParticipantQos* DDS_QosProvider_get_participant_qos ( DDS_QosProvider qp,
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.

DDS_DomainParticipantFactoryQos* DDS_QosProvider_get_participantfactory_qos ( DDS_QosProvider qp,
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.

DDS_PublisherQos* DDS_QosProvider_get_publisher_qos ( DDS_QosProvider qp,
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.

DDS_SubscriberQos* DDS_QosProvider_get_subscriber_qos ( DDS_QosProvider qp,
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.

DDS_TopicQos* DDS_QosProvider_get_topic_qos ( DDS_QosProvider qp,
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* DDS_QosProvider_newQosProvider ( const char *  uri,
const char *  profile,
CDX_XmlApi *  xml_parser 
)

Create 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 ( DDS_QosProvider qp,
DDS_DataReaderQos qos 
)

Return a DataReaderQos back to the factory.

This will reclaim any resources allocated by the QosProvider.

void DDS_QosProvider_return_datawriter_qos ( DDS_QosProvider qp,
DDS_DataWriterQos qos 
)

Return a DataWriterQos back to the factory.

This will reclaim any resources allocated by the QosProvider.

void DDS_QosProvider_return_participant_qos ( DDS_QosProvider qp,
DDS_DomainParticipantQos qos 
)

Return a DomainParticipantQos back to the factory.

This will reclaim any resources allocated by the QosProvider.

void DDS_QosProvider_return_participantfactory_qos ( DDS_QosProvider qp,
DDS_DomainParticipantFactoryQos qos 
)

Return a DomainParticipanFactoryQos back to the factory.

This will reclaim any resources allocated by the QosProvider.

void DDS_QosProvider_return_provider ( DDS_QosProvider qp)

Return a QosProvider back to the factory.

This will reclaim any resources allocated by the QosProvider.

void DDS_QosProvider_return_publisher_qos ( DDS_QosProvider qp,
DDS_PublisherQos qos 
)

Return a PublisherQos back to the factory.

This will reclaim any resources allocated by the QosProvider.

void DDS_QosProvider_return_subscriber_qos ( DDS_QosProvider qp,
DDS_SubscriberQos qos 
)

Return a SubscriberQos back to the factory.

This will reclaim any resources allocated by the QosProvider.

void DDS_QosProvider_return_topic_qos ( DDS_QosProvider qp,
DDS_TopicQos qos 
)

Return a TopicQos 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.