dds::domain::qos::DomainParticipantQos Class Reference

<<value-type>> Container of the QoS policies that a dds::domain::DomainParticipant supports More...

#include <dds/domain/qos/DomainParticipantQos.hpp>

Public Member Functions
	DomainParticipantQos ()
	Creates a DomainParticipantQos with the default value for each policy.
template<typename POLICY >
const POLICY &	policy () const
	Gets a QoS policy by const reference.
template<typename POLICY >
POLICY &	policy ()
	Gets a QoS policy by reference.
template<typename Policy >
DomainParticipantQos &	policy (const Policy &p)
	Sets a policy.
template<typename Policy >
DomainParticipantQos &	operator<< (const Policy &p)
	Sets a policy.
template<typename Policy >
const DomainParticipantQos &	operator>> (Policy &p) const
	Copies the values of a policy.

Detailed Description

<<value-type>> Container of the QoS policies that a dds::domain::DomainParticipant supports

DomainParticipantQos Policies

A DomainParticipantQos contains the following policies:

• dds::core::policy::UserData,
• dds::core::policy::EntityFactory,
• rti::core::policy::WireProtocol,
• rti::core::policy::TransportBuiltin,
• rti::core::policy::TransportUnicast,
• rti::core::policy::Discovery,
• rti::core::policy::DomainParticipantResourceLimits,
• rti::core::policy::Event,
• rti::core::policy::ReceiverPool,
• rti::core::policy::Database,
• rti::core::policy::DiscoveryConfig,
• rti::core::policy::ExclusiveArea,
• rti::core::policy::Property,
• rti::core::policy::EntityName,
• rti::core::policy::TransportMulticastMapping
• rti::core::policy::Service

To get or set policies use the policy() getters and setters or operator << (see examples).

Certain members must be set in a consistent manner:

Length of dds::domain::qos::DomainParticipantQos::user_data .value <= dds::domain::qos::DomainParticipantQos::resource_limits .participant_user_data_max_length

For dds::domain::qos::DomainParticipantQos::discovery_config .publication_writer
high_watermark <= dds::domain::qos::DomainParticipantQos::resource_limits .local_writer_allocation .max_count heartbeats_per_max_samples <= dds::domain::qos::DomainParticipantQos::resource_limits .local_writer_allocation.max_count

For dds::domain::qos::DomainParticipantQos::discovery_config .suscription_writer
high_watermark <= dds::domain::qos::DomainParticipantQos::resource_limits .local_reader_allocation.max_count heartbeats_per_max_samples <= dds::domain::qos::DomainParticipantQos::resource_limits .local_reader_allocation.max_count

If any of the above are not true, dds::domain::DomainParticipant::qos(const dds::domain::qos::DomainParticipantQos&) and dds::domain::DomainParticipant::set_qos_with_profile and dds::domain::DomainParticipant::default_participant_qos() will fail with dds::core::InconsistentPolicyError, and the dds::domain::DomainParticipant constructors will fail with dds::core::Error

Entity:

dds::domain::DomainParticipant

See Also

QoS Policies and allowed ranges within each Qos.

NDDS_DISCOVERY_PEERS

Qos Use Cases

Constructor & Destructor Documentation

dds::domain::qos::DomainParticipantQos::DomainParticipantQos

(

)

Creates a DomainParticipantQos with the default value for each policy.

Member Function Documentation

template<typename POLICY >

const POLICY& dds::domain::qos::DomainParticipantQos::policy

(

)

const

Gets a QoS policy by const reference.

Template Parameters

Policy

One of the DomainParticipantQos Policies

See Also

Setting Qos Values

template<typename POLICY >

POLICY& dds::domain::qos::DomainParticipantQos::policy

(

)

Gets a QoS policy by reference.

Template Parameters

Policy

One of the DomainParticipantQos Policies

See Also

Setting Qos Values

template<typename Policy >

DomainParticipantQos& dds::domain::qos::DomainParticipantQos::policy ( const Policy &  p )

inline

Sets a policy.

See Also

policy()

Setting Qos Values

template<typename Policy >

DomainParticipantQos& dds::domain::qos::DomainParticipantQos::operator<< ( const Policy &  p )

inline

Sets a policy.

See Also

policy()

Setting Qos Values

template<typename Policy >

const DomainParticipantQos& dds::domain::qos::DomainParticipantQos::operator>> ( Policy &  p ) const

inline

Copies the values of a policy.

Parameters

p	The destination where to copy the current value of the Policy

See Also

policy()

Setting Qos Values