dds::pub::qos::DataWriterQos Class Reference

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

#include "DataWriterQos.hpp"

Inherits dds::core::EntityQos< org::eclipse::cyclonedds::pub::qos::DataWriterQosDelegate >.

Public Member Functions
	DataWriterQos ()
	DataWriterQos (const DataWriterQos &qos)
	DataWriterQos (const dds::topic::qos::TopicQos &qos)
EntityQos &	operator<< (const POLICY &p)
DataWriterQos &	operator= (const dds::topic::qos::TopicQos &other)
const EntityQos &	operator>> (POLICY &p) const
POLICY &	policy ()
const POLICY &	policy () const
EntityQos &	policy (const POLICY &p)

Detailed Description

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

Attributes

QosPolicy	Desciption	Default Value
dds::core::policy::UserData	Additional information (info)	UserData::UserData(empty)
dds::core::policy::Durability	Data storage settings for late joiners (info)	Durability::Volatile()
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()
dds::core::policy::OwnershipStrength	Ownership strenght (info)	OwnershipStrength::OwnershipStrength(0)
dds::core::policy::WriterDataLifecycle	Dispose with unregister or not (info)	WriterDataLifecycle::AutoDisposeUnregisteredInstances()

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

See also

DCPS_QoS

Definition at line 68 of file DataWriterQos.hpp.

Constructor & Destructor Documentation

DataWriterQos() [1/3]

dds::pub::qos::DataWriterQos::DataWriterQos ( )

inline

Create default QoS.

Definition at line 74 of file DataWriterQos.hpp.

DataWriterQos() [2/3]

dds::pub::qos::DataWriterQos::DataWriterQos

(

const DataWriterQos &

qos

)

Create copied QoS type.

Parameters

qos	the QoS to copy policies from.

DataWriterQos() [3/3]

dds::pub::qos::DataWriterQos::DataWriterQos

(

const dds::topic::qos::TopicQos &

qos

)

Create a DataWriter QoS from a TopicQos.

This operation will copy the QosPolicy settings from the TopicQos to the corresponding QosPolicy settings in the DataWriterQos. The related value in DataWriterQos will be repliced, while the other policies will get the default QoS policies.

This is a "convenience" operation. It can be used to merge default DataWriter QosPolicy settings with the corresponding ones on the Topic. The resulting DataWriterQos can then be used to create a new DataWriter, or set its DataWriterQos.

dds::topic::qos::TopicQos topicQos = topic.qos();
dds::pub::qos::DataWriterQos writerQos(topicQos);
// Policies of the DataWriterQos that are not present in the TopicQos
// have the default value.

This operation does not check the resulting DataWriterQos for self consistency. This is because the "merged" DataWriterQos may not be the final one, as the application can still modify some QosPolicy settings prior to applying the DataWriterQos to the DataWriter.

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=()

DataWriterQos& dds::pub::qos::DataWriterQos::operator=

(

const dds::topic::qos::TopicQos &

other

)

Assign dds::topic::qos::TopicQos policies to the DataWriterQos.

This operation will copy the QosPolicy settings from the TopicQos to the corresponding QosPolicy settings in the DataWriterQos (replacing the values, if present).

This is a "convenience" operation, useful in combination with the operations Publisher::default_datawriter_qos() and dds::topic::Topic::qos(). This operation can be used to merge the DataWriter QosPolicy settings with the corresponding ones on the Topic. The resulting DataWriterQos can then be used to create a new DataWriter, or set its DataWriterQos.

dds::topic::qos::TopicQos topicQos = topic.qos();
dds::pub::qos::DataWriterQos writerQos = publisher.default_datawriter_qos();
writerQos = topicQos;
// Policies of the DataWriterQos that are not present in the TopicQos are untouched.

This operation does not check the resulting DataWriterQos for self consistency. This is because the "merged" DataWriterQos may not be the final one, as the application can still modify some QosPolicy settings prior to applying the DataWriterQos to the DataWriter.

Parameters

qos	the QoS to copy policies from.

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/pub/qos/DataWriterQos.hpp