DDS::DataWriterQos Class Reference

QoS policies supported by a DDS::DataWriter entity. More...

#include <managed_publication.h>

Public Member Functions
bool	equals (DataWriterQos^ other)
	Compares two DDS::DataWriterQos for equality. More...
virtual System::String ^	ToString () override
	Overrides the builtin ToString method. More...
System::String ^	ToString (DataWriterQos^ base, QosPrintFormat^ format)
	Obtains a string representation of a DataWriterQos object. More...
System::String ^	ToString (QosPrintFormat^ format)
	Obtains a string representation of a DataWriterQos object. More...
System::String ^	ToString (DataWriterQos^ base)
	Obtains a string representation of a DataWriterQos object. More...

Public Attributes
DurabilityQosPolicy	durability
	Durability policy, DURABILITY. More...
DurabilityServiceQosPolicy	durability_service
	DurabilityService policy, DURABILITY_SERVICE. More...
DeadlineQosPolicy	deadline
	Deadline policy, DEADLINE. More...
LatencyBudgetQosPolicy	latency_budget
	Latency budget policy, LATENCY_BUDGET. More...
LivelinessQosPolicy	liveliness
	Liveliness policy, LIVELINESS. More...
ReliabilityQosPolicy	reliability
	Reliability policy, RELIABILITY. More...
DestinationOrderQosPolicy	destination_order
	Destination order policy, DESTINATION_ORDER. More...
HistoryQosPolicy	history
	History policy, HISTORY. More...
ResourceLimitsQosPolicy	resource_limits
	Resource limits policy, RESOURCE_LIMITS. More...
TransportPriorityQosPolicy	transport_priority
	Transport priority policy, TRANSPORT_PRIORITY. More...
LifespanQosPolicy	lifespan
	Lifespan policy, LIFESPAN. More...
UserDataQosPolicy ^	user_data
	User data policy, USER_DATA. More...
OwnershipQosPolicy	ownership
	Ownership policy, OWNERSHIP. More...
OwnershipStrengthQosPolicy	ownership_strength
	Ownership strength policy, OWNERSHIP_STRENGTH. More...
WriterDataLifecycleQosPolicy	writer_data_lifecycle
	Writer data lifecycle policy, WRITER_DATA_LIFECYCLE. More...
DataRepresentationQosPolicy ^	representation
	Data representation policy, DATA_REPRESENTATION. More...
DataTagQosPolicy ^	data_tags
	DataTag policy, DATA_TAG. More...
DataWriterResourceLimitsQosPolicy	writer_resource_limits
	<<extension>> DDS::DataWriter protocol policy, DATA_WRITER_PROTOCOL More...
DataWriterProtocolQosPolicy	protocol
	<<extension>> DDS::DataWriter protocol policy, DATA_WRITER_PROTOCOL More...
TransportSelectionQosPolicy ^	transport_selection
	<<extension>> Transport plugin selection policy, TRANSPORT_SELECTION. More...
TransportUnicastQosPolicy ^	unicast
	<<extension>> Unicast transport policy, TRANSPORT_UNICAST. More...
PublishModeQosPolicy ^	publish_mode
	<<extension>> Publish mode policy, PUBLISH_MODE. More...
PropertyQosPolicy ^	property_qos
	<<extension>> Property policy, PROPERTY. More...
ServiceQosPolicy	service
	<<extension>> Service policy, SERVICE. More...
BatchQosPolicy	batch
	<<extension>> Batch policy, BATCH. More...
MultiChannelQosPolicy ^	multi_channel
	<<extension>> Multi channel policy, MULTICHANNEL. More...
AvailabilityQosPolicy ^	availability
	<<extension>> Availability policy, AVAILABILITY. More...
EntityNameQosPolicy ^	publication_name
	<<extension>> EntityName policy, ENTITY_NAME. More...
TopicQueryDispatchQosPolicy	topic_query_dispatch
	<<extension>> Topic Query dispatch policy, TOPIC_QUERY_DISPATCH. More...
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_InconsistentPolicy 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.

Member Function Documentation

ToString() [1/4]

virtual System::String ^ DDS::DataWriterQos::ToString ( )

overridevirtual

Overrides the builtin ToString method.

The various ToString() overloads allow formatting the output and printing only the differences with respect to another DataWriterQos object.

DataWriterQos qos = new DataWriterQos();
String theString = new String();

// The most basic version of the API simply overrides the builtin
// ToString method. Only the differences with respect to the
// documented default are printed to the string. The string is formatted
// according to the default values for QosPrintFormat.
theString = qos.ToString();

// This overload allows us to specify a base profile. Only the differences
// with respect to this base profile are printed to the string. If the two
// Qos objects are equal, the resultant string will be empty.
DataWriterQos base = new DataWriterQos();
theString = qos.toString(base);
// It is also possible to supply a custom format at this point
QosPrintFormat printFormat = new QosPrintFormat();
theString = qos.ToString(base, format);

// The sentinel value DATAWRITER_QOS_PRINT_ALL can be used as
// the base in order to print the entire qos object
theString = qos.ToString(DATAWRITER_QOS_PRINT_ALL);

This overload uses the default print format and only prints the differences between the supplied DataWriterQos and the documented default.

Returns

The string representation of the Qos.

ToString() [2/4]

System::String ^ DDS::DataWriterQos::ToString	(	DataWriterQos^	base,
		QosPrintFormat^	format
	)

Obtains a string representation of a DataWriterQos object.

Parameters

format	The print format used to format the output.
base	Only the differences between base and the Qos object are included in the output string. If you want to print everything within the Qos, use the DDS::Publisher::DATAWRITER_QOS_PRINT_ALL sentinel value.

This overload prints the differences between the qos and the supplied base. The output string is formatted using the supplied DDS::QosPrintFormat.

Returns

The string representation of the Qos.

ToString() [3/4]

System::String ^ DDS::DataWriterQos::ToString

(

QosPrintFormat^

format

)

Obtains a string representation of a DataWriterQos object.

Parameters

format

The print format used to format the output.

This overload prints the differences between the qos and the documented. default. The output string is formatted using the supplied DDS::QosPrintFormat.

Returns

The string representation of the Qos.

ToString() [4/4]

System::String ^ DDS::DataWriterQos::ToString

(

DataWriterQos^

base

)

Obtains a string representation of a DataWriterQos object.

Parameters

base	Only the differences between base and the Qos object are included in the output string. If you want to print everything within the Qos, use the DDS::Publisher::DATAWRITER_QOS_PRINT_ALL sentinel value.

This overload prints the differences between the Qos and the supplied base. The output string is formatted using the default value for DDS::QosPrintFormat.

Returns

The string representation of the Qos.

Member Data Documentation

durability

DurabilityQosPolicy DDS::DataWriterQos::durability

Durability policy, DURABILITY.

Referenced by RTI.Connext.Queuing.QueueConsumer< TRep >::QueueConsumer().

durability_service

DurabilityServiceQosPolicy DDS::DataWriterQos::durability_service

DurabilityService policy, DURABILITY_SERVICE.

deadline

DeadlineQosPolicy DDS::DataWriterQos::deadline

Deadline policy, DEADLINE.

latency_budget

LatencyBudgetQosPolicy DDS::DataWriterQos::latency_budget

Latency budget policy, LATENCY_BUDGET.

liveliness

LivelinessQosPolicy DDS::DataWriterQos::liveliness

Liveliness policy, LIVELINESS.

reliability

ReliabilityQosPolicy DDS::DataWriterQos::reliability

Reliability policy, RELIABILITY.

Referenced by RTI.Connext.Queuing.QueueConsumer< TRep >::QueueConsumer().

destination_order

DestinationOrderQosPolicy DDS::DataWriterQos::destination_order

Destination order policy, DESTINATION_ORDER.

history

HistoryQosPolicy DDS::DataWriterQos::history

History policy, HISTORY.

Referenced by RTI.Connext.Queuing.QueueConsumer< TRep >::QueueConsumer().

resource_limits

ResourceLimitsQosPolicy DDS::DataWriterQos::resource_limits

Resource limits policy, RESOURCE_LIMITS.

transport_priority

TransportPriorityQosPolicy DDS::DataWriterQos::transport_priority

Transport priority policy, TRANSPORT_PRIORITY.

lifespan

LifespanQosPolicy DDS::DataWriterQos::lifespan

Lifespan policy, LIFESPAN.

user_data

UserDataQosPolicy ^ DDS::DataWriterQos::user_data

User data policy, USER_DATA.

ownership

OwnershipQosPolicy DDS::DataWriterQos::ownership

Ownership policy, OWNERSHIP.

ownership_strength

OwnershipStrengthQosPolicy DDS::DataWriterQos::ownership_strength

Ownership strength policy, OWNERSHIP_STRENGTH.

writer_data_lifecycle

WriterDataLifecycleQosPolicy DDS::DataWriterQos::writer_data_lifecycle

Writer data lifecycle policy, WRITER_DATA_LIFECYCLE.

representation

DataRepresentationQosPolicy ^ DDS::DataWriterQos::representation

Data representation policy, DATA_REPRESENTATION.

data_tags

DataTagQosPolicy ^ DDS::DataWriterQos::data_tags

DataTag policy, DATA_TAG.

writer_resource_limits

DataWriterResourceLimitsQosPolicy DDS::DataWriterQos::writer_resource_limits

<<extension>> DDS::DataWriter protocol policy, DATA_WRITER_PROTOCOL

protocol

DataWriterProtocolQosPolicy DDS::DataWriterQos::protocol

<<extension>> DDS::DataWriter protocol policy, DATA_WRITER_PROTOCOL

Referenced by RTI.Connext.Queuing.QueueProducer< TRep >::QueueProducer(), and RTI.Connext.RequestReply.Requester< TReq, TRep >::Requester().

transport_selection

TransportSelectionQosPolicy ^ DDS::DataWriterQos::transport_selection

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

Specifies the transports available for use by the DDS::DataWriter.

unicast

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

PublishModeQosPolicy ^ DDS::DataWriterQos::publish_mode

<<extension>> Publish mode policy, PUBLISH_MODE.

Determines whether the DDS::DataWriter publishes data synchronously or asynchronously and how.

property_qos

PropertyQosPolicy ^ DDS::DataWriterQos::property_qos

<<extension>> Property policy, PROPERTY.

service

ServiceQosPolicy DDS::DataWriterQos::service

<<extension>> Service policy, SERVICE.

batch

BatchQosPolicy DDS::DataWriterQos::batch

<<extension>> Batch policy, BATCH.

multi_channel

MultiChannelQosPolicy ^ DDS::DataWriterQos::multi_channel

<<extension>> Multi channel policy, MULTICHANNEL.

availability

AvailabilityQosPolicy ^ DDS::DataWriterQos::availability

<<extension>> Availability policy, AVAILABILITY.

publication_name

EntityNameQosPolicy ^ DDS::DataWriterQos::publication_name

<<extension>> EntityName policy, ENTITY_NAME.

topic_query_dispatch

TopicQueryDispatchQosPolicy DDS::DataWriterQos::topic_query_dispatch

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

type_support

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.