OpenSplice ISO C++ 2 DCPS  v6.x
ISO C++ 2 OpenSplice Data Distribution Service Data-Centric Publish-Subscribe API
dds::domain::qos::DomainParticipantQos Class Reference

This class provides the basic mechanism for an application to specify Quality of Service attributes for a DomainParticipant. More...

#include "DomainParticipantQos.hpp"

Inheritance diagram for dds::domain::qos::DomainParticipantQos:
Inheritance graph

Public Member Functions

 DomainParticipantQos ()
 
 DomainParticipantQos (const DomainParticipantQos &qos)
 
EntityQosoperator<< (const POLICY &p)
 
const EntityQosoperator>> (POLICY &p) const
 
EntityQospolicy (const POLICY &p)
 
const POLICY & policy () const
 
POLICY & policy ()
 

Detailed Description

This class provides the basic mechanism for an application to specify Quality of Service attributes for a DomainParticipant.

Attributes
QosPolicy Desciption Default Value
dds::core::policy::UserData Additional information (info) UserData::UserData(empty)
dds::core::policy::EntityFactory Create enabled (info) EntityFactory::AutoEnable()
org::opensplice::core::policy::ListenerScheduling Listener thread scheduling parameters SCHEDULE_DEFAULT, PRIORITY_RELATIVE, prio 0
org::opensplice::core::policy::WatchdogScheduling Watchdog thread scheduling parameters SCHEDULE_DEFAULT, PRIORITY_RELATIVE, prio 0
A DomainParticipant will spawn different threads for different purposes:
  • A listener thread is spawned to perform the callbacks to all Listener objects attached to the various Entities contained in the DomainParticipant. The scheduling parameters for this thread can be specified in the listener_scheduling field of the DomainParticipantQos.
  • A watchdog thread is spawned to report the the Liveliness of all Entities contained in the DomainParticipant whose LivelinessQosPolicyKind in their LivelinessQosPolicy is set to AUTOMATIC_LIVELINESS_QOS. The scheduling parameters for this thread can be specified in the watchdog_scheduling field of the DomainParticipantQos.

A QosPolicy can be set when the DomainParticipant is created or modified with the set qos operations. Both operations take the DomainParticipantQos object as a parameter. There may be cases where several policies are in conflict. Consistency checking is performed each time the policies are modified when they are being created and, in case they are already enabled, via the set qos operation.

Some QosPolicy have “immutable” semantics meaning that they can only be specified either at DomainParticipant creation time or prior to calling the enable operation on the DomainParticipant.

See also
Supported Quality of Service (QoS)

Definition at line 71 of file DomainParticipantQos.hpp.

Constructor & Destructor Documentation

◆ DomainParticipantQos() [1/2]

dds::domain::qos::DomainParticipantQos::DomainParticipantQos ( )
inline

Create default QoS.

Definition at line 77 of file DomainParticipantQos.hpp.

◆ DomainParticipantQos() [2/2]

dds::domain::qos::DomainParticipantQos::DomainParticipantQos ( const DomainParticipantQos qos)

Create QoS with policies copied from the given QoS.

Parameters
qosthe QoS to copy policies from.

Member Function Documentation

◆ operator<<()

EntityQos& dds::core::EntityQos::operator<< ( const POLICY &  p)
inherited

Generic function for setting a policy applicable to this QoS object. Available policies depend on the actual instantiation of the template class, which might be DomainParticipantQos, TopicQos, PublisherQos, etc.

Parameters
pthe policy to be set for this QoS instance.

◆ operator>>()

const EntityQos& dds::core::EntityQos::operator>> ( POLICY &  p) const
inherited

Generic function for obtaining the value of a specific policy belonging to this QoS instance.

Returns
policy

◆ policy() [1/3]

EntityQos& dds::core::EntityQos::policy ( const POLICY &  p)
inherited

Generic function for setting a policy applicable to this QoS object. Available policies depend on the actual instantiation of the template class, which might be DomainParticipantQos, TopicQos, PublisherQos, etc.

Parameters
pthe policy to be set for this QoS instance.

◆ policy() [2/3]

const POLICY& dds::core::EntityQos::policy ( ) const
inherited

Generic function for obtaining the value of a specific policy belonging to this QoS instance.

Returns
policy

◆ policy() [3/3]

POLICY& dds::core::EntityQos::policy ( )
inherited

Generic function for obtaining the value of a specific policy belonging to this QoS instance.

Returns
policy

The documentation for this class was generated from the following file: