dds::topic::qos::TopicQos Class Reference

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

#include "TopicQos.hpp"

Inherits dds::core::EntityQos< org::eclipse::cyclonedds::topic::qos::TopicQosDelegate >.

Public Member Functions
	TopicQos ()
	TopicQos (const TopicQos &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 struct provides the basic mechanism for an application to specify Quality of Service attributes for a Topic.

Attributes

QosPolicy	Desciption	Default Value
dds::core::policy::TopicData	Additional information (info)	TopicData::TopicData(empty)
dds::core::policy::Durability	Data storage settings for late joiners (info)	Durability::Volatile()
dds::core::policy::DurabilityService	Transient/persistent behaviour (info)	DurabilityService::DurabilityService()
dds::core::policy::Deadline	Period in which new sample is written (info)	Deadline::Deadline(infinite)
dds::core::policy::LatencyBudget	Used for optimization (info)	LatencyBudget::LatencyBudget(zero)
dds::core::policy::Liveliness	Liveliness assertion mechanism (info)	Liveliness::Automatic()
dds::core::policy::Reliability	Reliability settings (info)	Reliability::Reliable()
dds::core::policy::DestinationOrder	DataReader data order settings (info)	DestinationOrder::ReceptionTimestamp()
dds::core::policy::History	Data storage settings (info)	History::KeepLast(depth 1)
dds::core::policy::ResourceLimits	Maximum resource settings (info)	ResourceLimits::ResourceLimits(all unlimited)
dds::core::policy::TransportPriority	Priority hint for transport layer (info)	TransportPriority::TTransportPriority(0)
dds::core::policy::Lifespan	Maximum duration of validity of data (info)	Lifespan::Lifespan(infinite)
dds::core::policy::Ownership	Exclusive ownership or not (info)	Ownership::Shared()

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

See also

DCPS_QoS

Definition at line 67 of file TopicQos.hpp.

Constructor & Destructor Documentation

TopicQos() [1/2]

dds::topic::qos::TopicQos::TopicQos ( )

inline

Create default QoS.

Definition at line 73 of file TopicQos.hpp.

TopicQos() [2/2]

dds::topic::qos::TopicQos::TopicQos

(

const TopicQos &

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/topic/qos/TopicQos.hpp