DDS_FilterSampleInfo Struct Reference

Provides meta information associated with the sample. More...

Public Attributes
struct DDS_SampleIdentity_t	related_sample_identity
	The identity of another sample related to this one.
struct DDS_GUID_t	related_source_guid
	Identifies the application logical data source that is related to the sample being written.
struct DDS_GUID_t	related_reader_guid
	Identifies a DataReader that is logically related to the sample.

Detailed Description

Provides meta information associated with the sample.

This can be used by a content filter to perform filtering on meta data.

Member Data Documentation

struct DDS_SampleIdentity_t DDS_FilterSampleInfo::related_sample_identity

The identity of another sample related to this one.

The value of this field identifies another sample that is logically related to the one that is written. For example, the DDSDataWriter created by a Replier uses this field to associate the identity of the request sample with a reponse sample.

To specify that there is no related sample identity, use the value DDS_UNKNOWN_SAMPLE_IDENTITY.

A DDSDataReader can inspect the related sample identity of a received sample by accessing the fields DDS_SampleInfo::related_original_publication_virtual_guid and DDS_SampleInfo::related_original_publication_virtual_sequence_number.

struct DDS_GUID_t DDS_FilterSampleInfo::related_source_guid

Identifies the application logical data source that is related to the sample being written.

The related_source_guid can be set by using the field DDS_WriteParams_t::related_source_guid when writing a sample using the method FooDataWriter::write_w_params.

struct DDS_GUID_t DDS_FilterSampleInfo::related_reader_guid

Identifies a DataReader that is logically related to the sample.

The related_reader_guid can be set by using the field DDS_WriteParams_t::related_reader_guid when writing a sample using the method FooDataWriter::write_w_params.