rti::topic::FilterSampleInfo Class Reference

<<extension>> <<value-type>> Provides meta information associated with the sample. More...

#include <rti/topic/FilterSampleInfo.hpp>

Public Member Functions
rti::core::SampleIdentity	related_sample_identity () const
	Get the identity of another sample related to this one.
int32_t	priority () const
	Get a positive integer designating the relative priority of the sample, used to determine the transmission order of pending transmissions.

Detailed Description

<<extension>> <<value-type>> Provides meta information associated with the sample.

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

Member Function Documentation

rti::core::SampleIdentity rti::topic::FilterSampleInfo::related_sample_identity ( ) const

inline

Get 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 dds::pub::DataWriter 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 rti::core::SampleIdentity::unknown().

A dds::sub::DataReader can inspect the related sample identity of a received sample by accessing the fields dds::sub::SampleInfo::related_original_publication_virtual_guid and dds::sub::SampleInfo::related_original_publication_virtual_sequence_number.

int32_t rti::topic::FilterSampleInfo::priority ( ) const

inline

Get a positive integer designating the relative priority of the sample, used to determine the transmission order of pending transmissions.

To use publication priorities, the rti::core::policy::PublishMode must be set for asynchronous publishing and the dds::pub::DataWriter must use a rti::pub::FlowController with a FlowControllerSchedulingPolicy_def::HIGHEST_PRIORITY_FIRST

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