DDS_DataWriterProtocolQosPolicy Struct Reference

<<eXtension>> <<cert>> Protocol that applies only to DDS_DataWriter instances. More...

#include <dds_c_infrastructure.h>

Data Fields
DDS_UnsignedLong	rtps_object_id
	The RTPS Object ID.
struct DDS_RtpsReliableWriterProtocol_t	rtps_reliable_writer
	The reliable protocol defined in RTPS.
DDS_Boolean	serialize_on_write
	Indicate whether a sample should be serialized when it is written (TRUE) or when it is sent (FALSE).

Detailed Description

<<eXtension>> <<cert>> Protocol that applies only to DDS_DataWriter instances.

This QoS policy is an extension to the DDS standard.

Entity:

DDS_DataWriter

Properties:

RxO = N/A
Changeable = NO

Field Documentation

rtps_object_id

DDS_UnsignedLong DDS_DataWriterProtocolQosPolicy::rtps_object_id

The RTPS Object ID.

This value is used to determine the RTPS object ID of a DDS_DataWriter according to the DDS-RTPS Interoperability Wire Protocol.

Only the last 3 bytes are used; the most significant byte is ignored.

[default] DDS_RTPS_AUTO_ID

[range] [0,0x00ffffff]

rtps_reliable_writer

struct DDS_RtpsReliableWriterProtocol_t DDS_DataWriterProtocolQosPolicy::rtps_reliable_writer

The reliable protocol defined in RTPS.

[default] heartbeat_period 3.0 seconds;
heartbeats_per_max_samples: 1;
max_send_window: minimum(256, ::DDS_HistoryQosPolicy::depth * ::DDS_ResourceLimitsQosPolicy::max_instances);
max_heartbeat_retries: DDS_LENGTH_UNLIMITED;

serialize_on_write

DDS_Boolean DDS_DataWriterProtocolQosPolicy::serialize_on_write

Indicate whether a sample should be serialized when it is written (TRUE) or when it is sent (FALSE).

To send a sample over the network it must first be serialized. The serialize_on_write attribute determines when the sample is serialized.

If set to DDS_BOOLEAN_TRUE, the sample is serialized when it is written using FooDataWriter_write or a similar API. This is the default behavior and results in the sample being stored in serialized form in case it needs to be resent.

If set to DDS_BOOLEAN_FALSE, the sample is not serialized when using FooDataWriter_write or a similar API. Instead it is serialized when it is needed and never stored in serialized form. This requires the unserialized sample to be available for the life-span of the DDS_DataWriter. If this is not the case, this option must not be used. Use of this option will also require a specialized type-plugin which is not supported by the IDL compiler.

[default] TRUE