DDS_WriteParams_t Struct Reference

<<eXtension>> Input parameters for writing with FooDataWriter::write_w_params, FooDataWriter::dispose_w_params, FooDataWriter::register_instance_w_params, FooDataWriter::unregister_instance_w_params More...

Public Attributes
DDS_Boolean	replace_auto
	Allows retrieving the actual value of those fields that were automatic.
struct DDS_SampleIdentity_t	identity
	Identity of the sample.
struct DDS_SampleIdentity_t	related_sample_identity
	The identity of another sample related to this one.
struct DDS_Time_t	source_timestamp
	Source timestamp upon write.
DDS_InstanceHandle_t	handle
	Instance handle.
DDS_Long	priority
	Publication priority.

Detailed Description

<<eXtension>> Input parameters for writing with FooDataWriter::write_w_params, FooDataWriter::dispose_w_params, FooDataWriter::register_instance_w_params, FooDataWriter::unregister_instance_w_params

Member Data Documentation

DDS_Boolean DDS_WriteParams_t::replace_auto

Allows retrieving the actual value of those fields that were automatic.

When this field is set, the fields that were configured with an automatic value (for example, DDS_AUTO_SAMPLE_IDENTITY) receive their actual value after FooDataWriter::write_w_params is called.

To reset those fields to their automatic value after calling FooDataWriter::write_w_params, use DDS_WriteParams_reset

struct DDS_SampleIdentity_t DDS_WriteParams_t::identity

Identity of the sample.

Identifies the sample being written. The identity consists of a pair (Virtual Writer GUID, Virtual Sequence Number).

Use the default value to let RTI Connext determine the sample identity as follows:

• The Virtual Writer GUID is the virtual GUID associated with the writer writing the sample. This virtual GUID is configured using DDS_DataWriterProtocolQosPolicy::virtual_guid.

• The sequence number is increased by one with respect to the previous value.

The virtual sequence numbers for a virtual writer must be strictly monotonically increasing. If the user tries to write a sample with a sequence number smaller or equal to the last sequence number, the write operation will fail.

A DataReader can access the identity of a received sample by using the fields DDS_SampleInfo::original_publication_virtual_guid and DDS_SampleInfo::original_publication_virtual_sequence_number in the DDS_SampleInfo.

[default] DDS_AUTO_SAMPLE_IDENTITY.

struct DDS_SampleIdentity_t DDS_WriteParams_t::related_sample_identity

The identity of another sample related to this one.

Identifies another sample that is logically related to the one that is written.

When this field is set, the related sample identity is propagated an subscribing applications can retrieve it from the DDS_SampleInfo (see DDS_SampleInfo_get_related_sample_identity).

The default value is DDS_UNKNOWN_SAMPLE_IDENTITY, and is not propagated.

A DataReader can access the related identity of a received sample by using the fields DDS_SampleInfo::related_original_publication_virtual_guid and DDS_SampleInfo::related_original_publication_virtual_sequence_number in the DDS_SampleInfo.

[default] DDS_UNKNOWN_SAMPLE_IDENTITY

struct DDS_Time_t DDS_WriteParams_t::source_timestamp

Source timestamp upon write.

Specifies the source timestamp that will be available to the DDSDataReader objects by means of the source_timestamp attribute within the DDS_SampleInfo.

[default] DDS_TIME_INVALID.

DDS_InstanceHandle_t DDS_WriteParams_t::handle

Instance handle.

Either the handle returned by a previous call to FooDataWriter::register_instance, or else the special value DDS_HANDLE_NIL.

[default] DDS_HANDLE_NIL

DDS_Long DDS_WriteParams_t::priority

Publication priority.

A positive integer value designating the relative priority of the sample, used to determine the transmission order of pending writes.

Use of publication priorities requires an asynchronous publisher (DDS_ASYNCHRONOUS_PUBLISH_MODE_QOS) with DDS_FlowControllerProperty_t::scheduling_policy set to DDS_HPF_FLOW_CONTROLLER_SCHED_POLICY.

Larger numbers have higher priority.

For multi-channel DataWriters, the publication priority of a sample may be used as a filter criteria for determining channel membership.

If the publication priority of the parent DataWriter, or for multi-channel DataWriters, if the publication priority of the parent channel, is set to DDS_PUBLICATION_PRIORITY_AUTOMATIC, then the DataWriter or channel will be assigned the priority of the largest publication priority of all samples in the DataWriter or channel.

If the publication priority of the parent DataWriter, and for multi-channel DataWriters, if the publication priority of the parent channel, are set to DDS_PUBLICATION_PRIORITY_UNDEFINED, then the DataWriter or channel will be assigned the lowest priority, regardless of the value of the publication priorities of samples written to the DataWriter or channel.

The publication priority of each sample can be set in the DDS_WriteParams_t of FooDataWriter::write_w_params.

For dispose and unregister samples, use the DDS_WriteParams_t of FooDataWriter::dispose_w_params and FooDataWriter::unregister_instance_w_params.

[default] 0 (lowest priority)