dds::sub::qos::SubscriberQos Class Reference

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

#include "SubscriberQos.hpp"

Inherits dds::core::EntityQos< org::eclipse::cyclonedds::sub::qos::SubscriberQosDelegate >.

Public Member Functions
	SubscriberQos ()
	SubscriberQos (const SubscriberQos &qos)
EntityQos &	operator<< (const POLICY &p)
const EntityQos &	operator>> (POLICY &p) const
POLICY &	policy ()
const POLICY &	policy () const
EntityQos &	policy (const POLICY &p)

Detailed Description

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

Attributes

QosPolicy	Desciption	Default Value
dds::core::policy::Presentation	Data-instance change dependencies (info)	Presentation::InstanceAccessScope(coherent=false, ordered=false)
dds::core::policy::Partition	Active partitions (info)	Partition::Partition(empty)
dds::core::policy::GroupData	Additional information (info)	GroupData::GroupData(empty)
dds::core::policy::EntityFactory	Create enabled (info)	EntityFactory::AutoEnable()

A QosPolicy can be set when the Subscriber is created or modified with the set qos operation. Both operations take the SubscriberQos 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 Subscriber creation time or prior to calling the enable operation on the Subscriber.

See also

DCPS_QoS

Definition at line 58 of file SubscriberQos.hpp.

Constructor & Destructor Documentation

SubscriberQos() [1/2]

dds::sub::qos::SubscriberQos::SubscriberQos ( )

inline

Create default QoS.

Definition at line 64 of file SubscriberQos.hpp.

SubscriberQos() [2/2]

dds::sub::qos::SubscriberQos::SubscriberQos

(

const SubscriberQos &

qos

)

Create copied QoS type.

Parameters

qos	the 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

p	the 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]

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

inherited

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

Returns

policy

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]

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

p	the policy to be set for this QoS instance.

---

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

• dds/sub/qos/SubscriberQos.hpp