RTI Connext Traditional C++ API  Version 6.1.0
DDS_DomainParticipantQos Struct Reference

QoS policies supported by a DDSDomainParticipant entity. More...

Public Member Functions

bool operator== (const DDS_DomainParticipantQos &r) const
 Compares two DomainParticipantQos objects for inequality. More...
 
bool operator!= (const DDS_DomainParticipantQos &r) const
 Compares two DomainParticipantQos objects for inequality. More...
 
DDS_ReturnCode_t print () const
 Prints this DDS_DomainParticipantQos to stdout. More...
 
DDS_ReturnCode_t to_string (char *string, DDS_UnsignedLong &string_size) const
 Obtains a string representation of this DDS_DomainParticipantQos. More...
 
DDS_ReturnCode_t to_string (char *string, DDS_UnsignedLong &string_size, const DDS_DomainParticipantQos &base) const
 Obtains a string representation of this DDS_DomainParticipantQos. More...
 
DDS_ReturnCode_t to_string (char *string, DDS_UnsignedLong &string_size, const DDS_QosPrintFormat &format) const
 Obtains a string representation of this DDS_DomainParticipantQos. More...
 
DDS_ReturnCode_t to_string (char *string, DDS_UnsignedLong &string_size, const DDS_DomainParticipantQos &base, const DDS_QosPrintFormat &format) const
 Obtains a string representation of this DDS_DomainParticipantQos. More...
 
DDS_ReturnCode_t to_string (char *string, DDS_UnsignedLong &string_size, const DDS_QosPrintAll_t &) const
 Obtains a string representation of this DDS_DomainParticipantQos. More...
 
DDS_ReturnCode_t to_string (char *string, DDS_UnsignedLong &string_size, const DDS_QosPrintAll_t &, const DDS_QosPrintFormat &format) const
 Obtains a string representation of this DDS_DomainParticipantQos. More...
 

Public Attributes

struct DDS_UserDataQosPolicy user_data
 User data policy, USER_DATA. More...
 
struct DDS_EntityFactoryQosPolicy entity_factory
 Entity factory policy, ENTITY_FACTORY. More...
 
struct DDS_WireProtocolQosPolicy wire_protocol
 <<extension>> Wire Protocol policy, WIRE_PROTOCOL. More...
 
struct DDS_TransportBuiltinQosPolicy transport_builtin
 <<extension>> Transport Builtin policy, TRANSPORT_BUILTIN. More...
 
struct DDS_TransportUnicastQosPolicy default_unicast
 <<extension>> Default Unicast Transport policy, TRANSPORT_UNICAST. More...
 
struct DDS_DiscoveryQosPolicy discovery
 <<extension>> Discovery policy, DISCOVERY. More...
 
struct DDS_DomainParticipantResourceLimitsQosPolicy resource_limits
 <<extension>> Domain participant resource limits policy, DOMAIN_PARTICIPANT_RESOURCE_LIMITS. More...
 
struct DDS_EventQosPolicy event
 <<extension>> Event policy, EVENT. More...
 
struct DDS_ReceiverPoolQosPolicy receiver_pool
 <<extension>> Receiver pool policy, RECEIVER_POOL. More...
 
struct DDS_DatabaseQosPolicy database
 <<extension>> Database policy, DATABASE. More...
 
struct DDS_DiscoveryConfigQosPolicy discovery_config
 <<extension>> Discovery config policy, DISCOVERY_CONFIG. More...
 
struct DDS_PropertyQosPolicy property
 <<extension>> Property policy, PROPERTY. More...
 
struct DDS_EntityNameQosPolicy participant_name
 <<extension>> The participant name. ENTITY_NAME More...
 
struct DDS_TransportMulticastMappingQosPolicy multicast_mapping
 <<extension>> The multicast mapping policy. TRANSPORT_MULTICAST_MAPPING More...
 
struct DDS_ServiceQosPolicy service
 <<extension>> The service qos policy. SERVICE More...
 
struct DDS_TypeSupportQosPolicy type_support
 <<extension>> Type support data, TYPESUPPORT. More...
 

Detailed Description

QoS policies supported by a DDSDomainParticipant entity.

Certain members must be set in a consistent manner:

Length of DDS_DomainParticipantQos::user_data .value <= DDS_DomainParticipantQos::resource_limits .participant_user_data_max_length

For DDS_DomainParticipantQos::discovery_config .publication_writer
high_watermark <= DDS_DomainParticipantQos::resource_limits .local_writer_allocation .max_count heartbeats_per_max_samples <= DDS_DomainParticipantQos::resource_limits .local_writer_allocation.max_count

For DDS_DomainParticipantQos::discovery_config .suscription_writer
high_watermark <= DDS_DomainParticipantQos::resource_limits .local_reader_allocation.max_count heartbeats_per_max_samples <= DDS_DomainParticipantQos::resource_limits .local_reader_allocation.max_count

If any of the above are not true, DDSDomainParticipant::set_qos and DDSDomainParticipant::set_qos_with_profile and DDSDomainParticipantFactory::set_default_participant_qos will fail with DDS_RETCODE_INCONSISTENT_POLICY, and DDSDomainParticipantFactory::create_participant will fail.

Entity:
DDSDomainParticipant
See also
QoS Policies and allowed ranges within each Qos.
NDDS_DISCOVERY_PEERS

Member Function Documentation

◆ operator==()

bool DDS_DomainParticipantQos::operator== ( const DDS_DomainParticipantQos r) const
inline

Compares two DomainParticipantQos objects for inequality.

See also
DDS_DomainParticipantQos_equals

References DDS_DomainParticipantQos_equals().

◆ operator!=()

bool DDS_DomainParticipantQos::operator!= ( const DDS_DomainParticipantQos r) const
inline

Compares two DomainParticipantQos objects for inequality.

See also
DDS_DomainParticipantQos_equals

References DDS_DomainParticipantQos_equals().

Member Data Documentation

◆ user_data

struct DDS_UserDataQosPolicy DDS_DomainParticipantQos::user_data

User data policy, USER_DATA.

◆ entity_factory

struct DDS_EntityFactoryQosPolicy DDS_DomainParticipantQos::entity_factory

Entity factory policy, ENTITY_FACTORY.

◆ wire_protocol

struct DDS_WireProtocolQosPolicy DDS_DomainParticipantQos::wire_protocol

<<extension>> Wire Protocol policy, WIRE_PROTOCOL.

The wire protocol (RTPS) attributes associated with the participant.

◆ transport_builtin

struct DDS_TransportBuiltinQosPolicy DDS_DomainParticipantQos::transport_builtin

<<extension>> Transport Builtin policy, TRANSPORT_BUILTIN.

◆ default_unicast

struct DDS_TransportUnicastQosPolicy DDS_DomainParticipantQos::default_unicast

<<extension>> Default Unicast Transport policy, TRANSPORT_UNICAST.

◆ discovery

struct DDS_DiscoveryQosPolicy DDS_DomainParticipantQos::discovery

<<extension>> Discovery policy, DISCOVERY.

◆ resource_limits

struct DDS_DomainParticipantResourceLimitsQosPolicy DDS_DomainParticipantQos::resource_limits

<<extension>> Domain participant resource limits policy, DOMAIN_PARTICIPANT_RESOURCE_LIMITS.

◆ event

struct DDS_EventQosPolicy DDS_DomainParticipantQos::event

<<extension>> Event policy, EVENT.

◆ receiver_pool

struct DDS_ReceiverPoolQosPolicy DDS_DomainParticipantQos::receiver_pool

<<extension>> Receiver pool policy, RECEIVER_POOL.

◆ database

struct DDS_DatabaseQosPolicy DDS_DomainParticipantQos::database

<<extension>> Database policy, DATABASE.

◆ discovery_config

struct DDS_DiscoveryConfigQosPolicy DDS_DomainParticipantQos::discovery_config

<<extension>> Discovery config policy, DISCOVERY_CONFIG.

◆ property

struct DDS_PropertyQosPolicy DDS_DomainParticipantQos::property

<<extension>> Property policy, PROPERTY.

◆ participant_name

struct DDS_EntityNameQosPolicy DDS_DomainParticipantQos::participant_name

<<extension>> The participant name. ENTITY_NAME

◆ multicast_mapping

struct DDS_TransportMulticastMappingQosPolicy DDS_DomainParticipantQos::multicast_mapping

<<extension>> The multicast mapping policy. TRANSPORT_MULTICAST_MAPPING

◆ service

struct DDS_ServiceQosPolicy DDS_DomainParticipantQos::service

<<extension>> The service qos policy. SERVICE

◆ type_support

struct DDS_TypeSupportQosPolicy DDS_DomainParticipantQos::type_support

<<extension>> Type support data, TYPESUPPORT.

Optional value that is passed to a type plugin's on_participant_attached function.