DDS_DataWriterQos Struct Reference

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

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

Detailed Description

QoS policies supported by a DDS_DataWriter 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, DDS_DataWriter_set_qos and DDS_DataWriter_set_qos_with_profile and DDS_Publisher_set_default_datawriter_qos and DDS_Publisher_set_default_datawriter_qos_with_profile will fail with DDS_RETCODE_INCONSISTENT_POLICY and DDS_Publisher_create_datawriter and DDS_Publisher_create_datawriter_with_profile and will return NULL.

Entity:

DDS_DataWriter

See also

QoS Policies allowed ranges within each Qos.

Field Documentation

durability

struct DDS_DurabilityQosPolicy DDS_DataWriterQos::durability

Durability policy, DURABILITY.

durability_service

struct DDS_DurabilityServiceQosPolicy DDS_DataWriterQos::durability_service

DurabilityService policy, DURABILITY_SERVICE.

deadline

struct DDS_DeadlineQosPolicy DDS_DataWriterQos::deadline

Deadline policy, DEADLINE.

latency_budget

struct DDS_LatencyBudgetQosPolicy DDS_DataWriterQos::latency_budget

Latency budget policy, LATENCY_BUDGET.

liveliness

struct DDS_LivelinessQosPolicy DDS_DataWriterQos::liveliness

Liveliness policy, LIVELINESS.

reliability

struct DDS_ReliabilityQosPolicy DDS_DataWriterQos::reliability

Reliability policy, RELIABILITY.

destination_order

struct DDS_DestinationOrderQosPolicy DDS_DataWriterQos::destination_order

Destination order policy, DESTINATION_ORDER.

history

struct DDS_HistoryQosPolicy DDS_DataWriterQos::history

History policy, HISTORY.

resource_limits

struct DDS_ResourceLimitsQosPolicy DDS_DataWriterQos::resource_limits

Resource limits policy, RESOURCE_LIMITS.

transport_priority

struct DDS_TransportPriorityQosPolicy DDS_DataWriterQos::transport_priority

Transport priority policy, TRANSPORT_PRIORITY.

lifespan

struct DDS_LifespanQosPolicy DDS_DataWriterQos::lifespan

Lifespan policy, LIFESPAN.

user_data

struct DDS_UserDataQosPolicy DDS_DataWriterQos::user_data

User data policy, USER_DATA.

ownership

struct DDS_OwnershipQosPolicy DDS_DataWriterQos::ownership

Ownership policy, OWNERSHIP.

ownership_strength

struct DDS_OwnershipStrengthQosPolicy DDS_DataWriterQos::ownership_strength

Ownership strength policy, OWNERSHIP_STRENGTH.

writer_data_lifecycle

struct DDS_WriterDataLifecycleQosPolicy DDS_DataWriterQos::writer_data_lifecycle

Writer data lifecycle policy, WRITER_DATA_LIFECYCLE.

representation

struct DDS_DataRepresentationQosPolicy DDS_DataWriterQos::representation

Data representation policy, DATA_REPRESENTATION.

data_tags

DDS_DataTagQosPolicy DDS_DataWriterQos::data_tags

DataTag policy, DATA_TAG.

writer_resource_limits

struct DDS_DataWriterResourceLimitsQosPolicy DDS_DataWriterQos::writer_resource_limits

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

protocol

struct DDS_DataWriterProtocolQosPolicy DDS_DataWriterQos::protocol

<<extension>> DDS_DataWriter protocol policy, DATA_WRITER_PROTOCOL

transport_selection

struct DDS_TransportSelectionQosPolicy DDS_DataWriterQos::transport_selection

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

Specifies the transports available for use by the DDS_DataWriter.

unicast

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 DDS_DataReader entities in the domain.

publish_mode

struct DDS_PublishModeQosPolicy DDS_DataWriterQos::publish_mode

<<extension>> Publish mode policy, PUBLISH_MODE.

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

property

struct DDS_PropertyQosPolicy DDS_DataWriterQos::property

<<extension>> Property policy, PROPERTY.

service

struct DDS_ServiceQosPolicy DDS_DataWriterQos::service

<<extension>> Service policy, SERVICE.

batch

struct DDS_BatchQosPolicy DDS_DataWriterQos::batch

<<extension>> Batch policy, BATCH.

multi_channel

struct DDS_MultiChannelQosPolicy DDS_DataWriterQos::multi_channel

<<extension>> Multi channel policy, MULTICHANNEL.

availability

struct DDS_AvailabilityQosPolicy DDS_DataWriterQos::availability

<<extension>> Availability policy, AVAILABILITY.

publication_name

struct DDS_EntityNameQosPolicy DDS_DataWriterQos::publication_name

<<extension>> EntityName policy, ENTITY_NAME.

topic_query_dispatch

struct DDS_TopicQueryDispatchQosPolicy DDS_DataWriterQos::topic_query_dispatch

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

transfer_mode

struct DDS_DataWriterTransferModeQosPolicy DDS_DataWriterQos::transfer_mode

<<extension>> TransferMode policy, DATA_WRITER_TRANSFER_MODE.

type_support

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.