RTI Connext Traditional C++ API  Version 5.3.0
 All Classes Functions Variables Typedefs Enumerations Enumerator Groups Pages
DDS_DataWriterQos Struct Reference

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

Public Member Functions

bool operator== (const DDS_DataWriterQos &r) const
 Compares two DataWriterQos objects for equality.
 
bool operator!= (const DDS_DataWriterQos &r) const
 Compares two DataWriterQos objects for inequality.
 

Public Attributes

struct DDS_DurabilityQosPolicy durability
 Durability policy, DURABILITY.
 
struct
DDS_DurabilityServiceQosPolicy 
durability_service
 DurabilityService policy, DURABILITY_SERVICE.
 
struct DDS_DeadlineQosPolicy deadline
 Deadline policy, DEADLINE.
 
struct DDS_LatencyBudgetQosPolicy latency_budget
 Latency budget policy, LATENCY_BUDGET.
 
struct DDS_LivelinessQosPolicy liveliness
 Liveliness policy, LIVELINESS.
 
struct DDS_ReliabilityQosPolicy reliability
 Reliability policy, RELIABILITY.
 
struct
DDS_DestinationOrderQosPolicy 
destination_order
 Destination order policy, DESTINATION_ORDER.
 
struct DDS_HistoryQosPolicy history
 History policy, HISTORY.
 
struct DDS_ResourceLimitsQosPolicy resource_limits
 Resource limits policy, RESOURCE_LIMITS.
 
struct
DDS_TransportPriorityQosPolicy 
transport_priority
 Transport priority policy, TRANSPORT_PRIORITY.
 
struct DDS_LifespanQosPolicy lifespan
 Lifespan policy, LIFESPAN.
 
struct DDS_UserDataQosPolicy user_data
 User data policy, USER_DATA.
 
struct DDS_OwnershipQosPolicy ownership
 Ownership policy, OWNERSHIP.
 
struct
DDS_OwnershipStrengthQosPolicy 
ownership_strength
 Ownership strength policy, OWNERSHIP_STRENGTH.
 
struct
DDS_WriterDataLifecycleQosPolicy 
writer_data_lifecycle
 Writer data lifecycle policy, WRITER_DATA_LIFECYCLE.
 
struct
DDS_DataWriterResourceLimitsQosPolicy 
writer_resource_limits
 <<extension>> Writer resource limits policy, DATA_WRITER_RESOURCE_LIMITS.
 
struct
DDS_DataWriterProtocolQosPolicy 
protocol
 <<extension>> DDSDataWriter protocol policy, DATA_WRITER_PROTOCOL
 
struct
DDS_TransportSelectionQosPolicy 
transport_selection
 <<extension>> Transport plugin selection policy, TRANSPORT_SELECTION.
 
struct
DDS_TransportUnicastQosPolicy 
unicast
 <<extension>> Unicast transport policy, TRANSPORT_UNICAST.
 
struct DDS_PublishModeQosPolicy publish_mode
 <<extension>> Publish mode policy, PUBLISH_MODE.
 
struct DDS_PropertyQosPolicy property
 <<extension>> Property policy, PROPERTY.
 
struct DDS_ServiceQosPolicy service
 <<extension>> Service policy, SERVICE.
 
struct DDS_BatchQosPolicy batch
 <<extension>> Batch policy, BATCH.
 
struct DDS_MultiChannelQosPolicy multi_channel
 <<extension>> Multi channel policy, MULTICHANNEL.
 
struct DDS_AvailabilityQosPolicy availability
 <<extension>> Availability policy, AVAILABILITY.
 
struct DDS_EntityNameQosPolicy publication_name
 <<extension>> EntityName policy, ENTITY_NAME.
 
struct
DDS_TopicQueryDispatchQosPolicy 
topic_query_dispatch
 <<extension>> Topic Query dispatch policy, TOPIC_QUERY_DISPATCH.
 
struct DDS_TypeSupportQosPolicy type_support
 <<extension>> Type support data, TYPESUPPORT.
 

Detailed Description

QoS policies supported by a DDSDataWriter entity.

You must set certain members in a consistent manner:

- DDS_DataWriterQos::history .depth <= DDS_DataWriterQos::resource_limits .max_samples_per_instance

- DDS_DataWriterQos::resource_limits .max_samples_per_instance <= DDS_DataWriterQos::resource_limits .max_samples

- DDS_DataWriterQos::resource_limits .initial_samples <= DDS_DataWriterQos::resource_limits .max_samples

- DDS_DataWriterQos::resource_limits .initial_instances <= DDS_DataWriterQos::resource_limits .max_instances

- length of DDS_DataWriterQos::user_data .value <= DDS_DomainParticipantQos::resource_limits .writer_user_data_max_length

If any of the above are not true, DDSDataWriter::set_qos and DDSDataWriter::set_qos_with_profile and DDSPublisher::set_default_datawriter_qos and DDSPublisher::set_default_datawriter_qos_with_profile will fail with DDS_RETCODE_INCONSISTENT_POLICY and DDSPublisher::create_datawriter and DDSPublisher::create_datawriter_with_profile and will return NULL.

Entity:
DDSDataWriter
See Also
QoS Policies allowed ranges within each Qos.

Member Function Documentation

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

Compares two DataWriterQos objects for equality.

See Also
DDS_DataWriterQos_equals
bool DDS_DataWriterQos::operator!= ( const DDS_DataWriterQos r) const
inline

Compares two DataWriterQos objects for inequality.

See Also
DDS_DataWriterQos_equals

Member Data Documentation

struct DDS_DurabilityQosPolicy DDS_DataWriterQos::durability

Durability policy, DURABILITY.

struct DDS_DurabilityServiceQosPolicy DDS_DataWriterQos::durability_service

DurabilityService policy, DURABILITY_SERVICE.

struct DDS_DeadlineQosPolicy DDS_DataWriterQos::deadline

Deadline policy, DEADLINE.

struct DDS_LatencyBudgetQosPolicy DDS_DataWriterQos::latency_budget

Latency budget policy, LATENCY_BUDGET.

struct DDS_LivelinessQosPolicy DDS_DataWriterQos::liveliness

Liveliness policy, LIVELINESS.

struct DDS_ReliabilityQosPolicy DDS_DataWriterQos::reliability

Reliability policy, RELIABILITY.

struct DDS_DestinationOrderQosPolicy DDS_DataWriterQos::destination_order

Destination order policy, DESTINATION_ORDER.

struct DDS_HistoryQosPolicy DDS_DataWriterQos::history

History policy, HISTORY.

struct DDS_ResourceLimitsQosPolicy DDS_DataWriterQos::resource_limits

Resource limits policy, RESOURCE_LIMITS.

struct DDS_TransportPriorityQosPolicy DDS_DataWriterQos::transport_priority

Transport priority policy, TRANSPORT_PRIORITY.

struct DDS_LifespanQosPolicy DDS_DataWriterQos::lifespan

Lifespan policy, LIFESPAN.

struct DDS_UserDataQosPolicy DDS_DataWriterQos::user_data

User data policy, USER_DATA.

struct DDS_OwnershipQosPolicy DDS_DataWriterQos::ownership

Ownership policy, OWNERSHIP.

struct DDS_OwnershipStrengthQosPolicy DDS_DataWriterQos::ownership_strength

Ownership strength policy, OWNERSHIP_STRENGTH.

struct DDS_WriterDataLifecycleQosPolicy DDS_DataWriterQos::writer_data_lifecycle

Writer data lifecycle policy, WRITER_DATA_LIFECYCLE.

struct DDS_DataWriterResourceLimitsQosPolicy DDS_DataWriterQos::writer_resource_limits

<<extension>> Writer resource limits policy, DATA_WRITER_RESOURCE_LIMITS.

struct DDS_DataWriterProtocolQosPolicy DDS_DataWriterQos::protocol
struct DDS_TransportSelectionQosPolicy DDS_DataWriterQos::transport_selection

<<extension>> Transport plugin selection policy, TRANSPORT_SELECTION.

Specifies the transports available for use by the DDSDataWriter.

struct DDS_TransportUnicastQosPolicy DDS_DataWriterQos::unicast

<<extension>> Unicast transport policy, TRANSPORT_UNICAST.

Specifies the unicast transport interfaces and ports on which messages can be received.

The unicast interfaces are used to receive messages from DDSDataReader entities in the domain.

struct DDS_PublishModeQosPolicy DDS_DataWriterQos::publish_mode

<<extension>> Publish mode policy, PUBLISH_MODE.

Determines whether the DDSDataWriter publishes data synchronously or asynchronously and how.

struct DDS_PropertyQosPolicy DDS_DataWriterQos::property

<<extension>> Property policy, PROPERTY.

struct DDS_ServiceQosPolicy DDS_DataWriterQos::service

<<extension>> Service policy, SERVICE.

struct DDS_BatchQosPolicy DDS_DataWriterQos::batch

<<extension>> Batch policy, BATCH.

struct DDS_MultiChannelQosPolicy DDS_DataWriterQos::multi_channel

<<extension>> Multi channel policy, MULTICHANNEL.

struct DDS_AvailabilityQosPolicy DDS_DataWriterQos::availability

<<extension>> Availability policy, AVAILABILITY.

struct DDS_EntityNameQosPolicy DDS_DataWriterQos::publication_name

<<extension>> EntityName policy, ENTITY_NAME.

struct DDS_TopicQueryDispatchQosPolicy DDS_DataWriterQos::topic_query_dispatch

<<extension>> Topic Query dispatch policy, TOPIC_QUERY_DISPATCH.

struct DDS_TypeSupportQosPolicy DDS_DataWriterQos::type_support

<<extension>> Type support data, TYPESUPPORT.

Optional value that is passed to a type plugin's on_endpoint_attached and serialization functions.


RTI Connext Traditional C++ API Version 5.3.0 Copyright © Sun Jun 25 2017 Real-Time Innovations, Inc