DataWriterQos Class Reference

QoS policies supported by a com.rti.dds.publication.DataWriter entity. More...

Inheritance diagram for DataWriterQos:

Public Member Functions
String	toString ()
	Overrides the builtin Object.toString method. More...
String	toString (DataWriterQos baseQos, QosPrintFormat format)
	Obtains a string representation of a DataWriterQos object. More...
String	toString (QosPrintFormat format)
	Obtains a string representation of a DataWriterQos object. More...
String	toString (DataWriterQos baseQos)
	Obtains a string representation of a DataWriterQos object. More...
Public Member Functions inherited from Qos
final boolean	equals (Object other)

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

Detailed Description

QoS policies supported by a com.rti.dds.publication.DataWriter entity.

You must set certain members in a consistent manner:

• com.rti.dds.publication.DataWriterQos.history .depth <= com.rti.dds.publication.DataWriterQos.resource_limits .max_samples_per_instance

• com.rti.dds.publication.DataWriterQos.resource_limits .max_samples_per_instance <= com.rti.dds.publication.DataWriterQos.resource_limits .max_samples

• com.rti.dds.publication.DataWriterQos.resource_limits .initial_samples <= com.rti.dds.publication.DataWriterQos.resource_limits .max_samples

• com.rti.dds.publication.DataWriterQos.resource_limits .initial_instances <= com.rti.dds.publication.DataWriterQos.resource_limits .max_instances

• length of com.rti.dds.publication.DataWriterQos.user_data .value <= com.rti.dds.domain.DomainParticipantQos.resource_limits .writer_user_data_max_length

If any of the above are not true, com.rti.dds.publication.DataWriter.set_qos and com.rti.dds.publication.DataWriter.set_qos_with_profile and com.rti.dds.publication.Publisher.set_default_datawriter_qos and com.rti.dds.publication.Publisher.set_default_datawriter_qos_with_profile will fail with com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY and com.rti.dds.publication.Publisher.create_datawriter and com.rti.dds.publication.Publisher.create_datawriter_with_profile and will return NULL.

Entity:

com.rti.dds.publication.DataWriter

See also

QoS Policies allowed ranges within each Qos.

Member Function Documentation

toString() [1/4]

String toString

(

)

Overrides the builtin Object.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
// Object.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 baseQos = new DataWriterQos(); // ...;
theString = qos.toString(baseQos);
// It is also possible to supply a custom format at this point
QosPrintFormat printFormat = new QosPrintFormat(); // ...;
theString = qos.toString(baseQos, 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.

References DataWriterQos.toString().

Referenced by DataWriterQos.toString().

toString() [2/4]

String toString	(	DataWriterQos	baseQos,
		QosPrintFormat	format
	)

Obtains a string representation of a DataWriterQos object.

Parameters

format	The print format used to format the output.
baseQos	Only the differences between baseQos and the Qos object are included in the output string. If you want to print everything within the Qos, use the com.rti.dds.publication.Publisher.DATAWRITER_QOS_PRINT_ALL sentinel value.

This overload prints the differences between the qos and the supplied baseQos. The output string is formatted using the supplied com.rti.dds.infrastructure.QosPrintFormat.

Returns

The string representation of the Qos.

References Publisher.DATAWRITER_QOS_PRINT_ALL.

toString() [3/4]

String 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 com.rti.dds.infrastructure.QosPrintFormat.

Returns

The string representation of the Qos.

References DataWriterQos.toString().

toString() [4/4]

String toString

(

DataWriterQos

baseQos

)

Obtains a string representation of a DataWriterQos object.

Parameters

baseQos

Only the differences between baseQos and the Qos object are included in the output string. If you want to print everything within the Qos, use the com.rti.dds.publication.Publisher.DATAWRITER_QOS_PRINT_ALL sentinel value.

This overload prints the differences between the qos and the supplied baseQos. The output string is formatted using the default value for com.rti.dds.infrastructure.QosPrintFormat.

Returns

The string representation of the Qos.

References DataWriterQos.toString().

Member Data Documentation

durability

final DurabilityQosPolicy durability

Durability policy, DURABILITY.

durability_service

final DurabilityServiceQosPolicy durability_service

DurabilityService policy, DURABILITY_SERVICE.

deadline

final DeadlineQosPolicy deadline

Deadline policy, DEADLINE.

latency_budget

final LatencyBudgetQosPolicy latency_budget

Latency budget policy, LATENCY_BUDGET.

liveliness

final LivelinessQosPolicy liveliness

Liveliness policy, LIVELINESS.

reliability

final ReliabilityQosPolicy reliability

Reliability policy, RELIABILITY.

destination_order

final DestinationOrderQosPolicy destination_order

Destination order policy, DESTINATION_ORDER.

history

final HistoryQosPolicy history

History policy, HISTORY.

resource_limits

final ResourceLimitsQosPolicy resource_limits

Resource limits policy, RESOURCE_LIMITS.

transport_priority

final TransportPriorityQosPolicy transport_priority

Transport priority policy, TRANSPORT_PRIORITY.

lifespan

final LifespanQosPolicy lifespan

Lifespan policy, LIFESPAN.

user_data

final UserDataQosPolicy user_data

User data policy, USER_DATA.

ownership

final OwnershipQosPolicy ownership

Ownership policy, OWNERSHIP.

ownership_strength

final OwnershipStrengthQosPolicy ownership_strength

Ownership strength policy, OWNERSHIP_STRENGTH.

writer_data_lifecycle

final WriterDataLifecycleQosPolicy writer_data_lifecycle

Writer data lifecycle policy, WRITER_DATA_LIFECYCLE.

writer_resource_limits

final DataWriterResourceLimitsQosPolicy writer_resource_limits

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

protocol

final DataWriterProtocolQosPolicy protocol

<<extension>> com.rti.dds.publication.DataWriter protocol policy, DATA_WRITER_PROTOCOL

Referenced by Requester< TReq, TRep >.Requester().

transport_selection

final TransportSelectionQosPolicy transport_selection

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

Specifies the transports available for use by the com.rti.dds.publication.DataWriter.

unicast

final TransportUnicastQosPolicy 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 com.rti.dds.subscription.DataReader entities in the domain.

publish_mode

final PublishModeQosPolicy publish_mode

<<extension>> Publish mode policy, PUBLISH_MODE.

Determines whether the com.rti.dds.publication.DataWriter publishes data synchronously or asynchronously and how.

property

final PropertyQosPolicy property

<<extension>> Property policy, PROPERTY.

data_tags

final DataTagQosPolicy data_tags

DataTag policy, DATA_TAG.

service

final ServiceQosPolicy service

<<extension>> Service policy, SERVICE.

batch

final BatchQosPolicy batch

<<extension>> Batch policy, BATCH.

multi_channel

final MultiChannelQosPolicy multi_channel

<<extension>> Multi channel policy, MULTICHANNEL.

availability

final AvailabilityQosPolicy availability

<<extension>> Availability policy, AVAILABILITY.

publication_name

final EntityNameQosPolicy publication_name

<<extension>> EntityName policy, ENTITY_NAME.

topic_query_dispatch

final TopicQueryDispatchQosPolicy topic_query_dispatch

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

representation

final DataRepresentationQosPolicy representation

Data representation policy, DATA_REPRESENTATION.

type_support

final TypeSupportQosPolicy type_support

<<extension>> Type support data, TYPESUPPORT.

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