DDS_DataWriterQos Struct Reference

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

#include <dds_c_publication.h>

Public Attributes
struct DDS_DeadlineQosPolicy	deadline
	Deadline policy, DEADLINE.
struct DDS_LivelinessQosPolicy	liveliness
	Liveliness policy, LIVELINESS.
struct DDS_HistoryQosPolicy	history
	History policy, HISTORY.
struct DDS_ResourceLimitsQosPolicy	resource_limits
	Resource limits policy, RESOURCE_LIMITS.
struct DDS_OwnershipQosPolicy	ownership
	Ownership policy, OWNERSHIP.
struct DDS_OwnershipStrengthQosPolicy	ownership_strength
	Ownership strength policy, OWNERSHIP_STRENGTH.
struct DDS_LatencyBudgetQosPolicy	latency_budget
	Latency budget policy, LATENCY_BUDGET.
struct DDS_ReliabilityQosPolicy	reliability
	Reliability policy, RELIABILITY.
struct DDS_DurabilityQosPolicy	durability
	<<eXtension>> Durability policy, DURABILITY.
struct DDS_DestinationOrderQosPolicy	destination_order
	<<eXtension>> Destination Order policy, DESTINATION_ORDER.
struct DDS_DataRepresentationQosPolicy	representation
	Data representation policy, DATA_REPRESENTATION.
struct DDS_DataWriterProtocolQosPolicy	protocol
	<<eXtension>> DDSDataWriter protocol policy, DATA_WRITER_PROTOCOL
struct DDS_TransportQosPolicy	transport
	Transport policy, TRANSPORT. Only unicast transports are supported.
struct DDS_DataWriterResourceLimitsQosPolicy	writer_resource_limits
	<<eXtension>> Writer resource limits policy, DataWriter Resource Limits.
struct DDS_PublishModeQosPolicy	publish_mode
	<<eXtension>> Publish mode policy, PUBLISH_MODE.
struct DDS_UserDataQosPolicy	user_data
	User data policy, USER_DATA.
struct DDS_PropertyQosPolicy	property
	<<eXtension>> The DDSDataWriter properties. Please refer to the Property Reference for available properties.
struct DDS_EntityNameQosPolicy	publication_name
	<<eXtension>> The DDSDataWriter name. ENTITY_NAME.
struct DDS_DataWriterTransferModeQosPolicy	transfer_mode
	<<eXtension>> QoS related to transferring data
struct DDS_TransportPriorityQosPolicy	transport_priority
	Transport priority policy, TRANSPORT_PRIORITY.

Detailed Description

QoS policies supported by a DDSDataWriter entity.

The DDS_DataWriterQos controls the resources allocated by a DDSDataWriter. Each DDSDataWriter allocates its own resources, even DataWriters of the same DDSTopic. For this reason is it advised to limit the number of DataWriters per topic.

You must set certain members in a consistent manner:

- DDS_DataWriterQos::::DDS_HistoryQosPolicy::depth <= DDS_DataWriterQos::::DDS_ResourceLimitsQosPolicy::max_samples_per_instance

- DDS_DataWriterQos::::DDS_ResourceLimitsQosPolicy::max_samples_per_instance <= DDS_DataWriterQos::::DDS_ResourceLimitsQosPolicy::max_samples

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

Entity:

DDSDataWriter

See also

QoS Policies allowed ranges within each Qos.

Member Data Documentation

deadline

struct DDS_DeadlineQosPolicy DDS_DataWriterQos::deadline

Deadline policy, DEADLINE.

liveliness

struct DDS_LivelinessQosPolicy DDS_DataWriterQos::liveliness

Liveliness policy, LIVELINESS.

history

struct DDS_HistoryQosPolicy DDS_DataWriterQos::history

History policy, HISTORY.

resource_limits

struct DDS_ResourceLimitsQosPolicy DDS_DataWriterQos::resource_limits

Resource limits policy, RESOURCE_LIMITS.

The following consistency constraints must be satisfied: - DDS_HistoryQosPolicy::depth <= max_samples_per_instance - max_samples_per_instance <= max_samples - For unkeyed types: max_samples must equal max_samples_per_instance

See also

DDS_ResourceLimitsQosPolicy for field-level valid ranges.

ownership

struct DDS_OwnershipQosPolicy DDS_DataWriterQos::ownership

Ownership policy, OWNERSHIP.

ownership_strength

struct DDS_OwnershipStrengthQosPolicy DDS_DataWriterQos::ownership_strength

Ownership strength policy, OWNERSHIP_STRENGTH.

latency_budget

struct DDS_LatencyBudgetQosPolicy DDS_DataWriterQos::latency_budget

Latency budget policy, LATENCY_BUDGET.

reliability

struct DDS_ReliabilityQosPolicy DDS_DataWriterQos::reliability

Reliability policy, RELIABILITY.

durability

struct DDS_DurabilityQosPolicy DDS_DataWriterQos::durability

<<eXtension>> Durability policy, DURABILITY.

destination_order

struct DDS_DestinationOrderQosPolicy DDS_DataWriterQos::destination_order

<<eXtension>> Destination Order policy, DESTINATION_ORDER.

representation

struct DDS_DataRepresentationQosPolicy DDS_DataWriterQos::representation

Data representation policy, DATA_REPRESENTATION.

protocol

struct DDS_DataWriterProtocolQosPolicy DDS_DataWriterQos::protocol

<<eXtension>> DDSDataWriter protocol policy, DATA_WRITER_PROTOCOL

transport

struct DDS_TransportQosPolicy DDS_DataWriterQos::transport

Transport policy, TRANSPORT. Only unicast transports are supported.

writer_resource_limits

struct DDS_DataWriterResourceLimitsQosPolicy DDS_DataWriterQos::writer_resource_limits

<<eXtension>> Writer resource limits policy, DataWriter Resource Limits.

Key constraints: - max_remote_readers bounds the maximum number of matched DDSDataReader entities. - writer_loaned_sample_allocation defaults to max_samples + 1 when set to DDS_SIZE_AUTO.

See also

DDS_DataWriterResourceLimitsQosPolicy for field-level valid ranges.

publish_mode

struct DDS_PublishModeQosPolicy DDS_DataWriterQos::publish_mode

<<eXtension>> Publish mode policy, PUBLISH_MODE.

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

user_data

struct DDS_UserDataQosPolicy DDS_DataWriterQos::user_data

User data policy, USER_DATA.

property

struct DDS_PropertyQosPolicy DDS_DataWriterQos::property

<<eXtension>> The DDSDataWriter properties. Please refer to the Property Reference for available properties.

publication_name

struct DDS_EntityNameQosPolicy DDS_DataWriterQos::publication_name

<<eXtension>> The DDSDataWriter name. ENTITY_NAME.

transport_priority

struct DDS_TransportPriorityQosPolicy DDS_DataWriterQos::transport_priority

Transport priority policy, TRANSPORT_PRIORITY.