rti::recording::storage::StorageStreamInfoReader Class Reference

Storage discovery stream reader. More...

#include <StorageStreamInfoReader.hpp>

Public Member Functions
virtual	~StorageStreamInfoReader ()
	Virtual destructor.
virtual void	read (std::vector< rti::routing::StreamInfo * > &sample_seq, const SelectorState &selector)=0
	Retrieve stream information data from storage. This operation should behave differently depending on the product's needs, stated in the SelectorState object passed as a parameter. The stream info samples have to be provided in increasing time-stamp order (reception time-stamp).
virtual void	return_loan (std::vector< rti::routing::StreamInfo * > &sample_seq)=0
	Notifies plugin it can release the read stream information objects.
virtual int64_t	service_start_time ()=0
	The time within the recorded time range that can be considered time zero of the recording.
virtual int64_t	service_stop_time ()=0
	The time relative to the recorded time range that can be considered the final recording time of the recording.
virtual bool	finished ()=0
	Whether this discovery stream has finished with all discovery data or not.
virtual void	reset ()=0
	Method used by Replay Service when looping, to start over. After this method is called, the stream reader should be ready to start reading data from the beginning of the stream, again.

Detailed Description

Storage discovery stream reader.

class rti::recording::storage::StorageStreamInfoReader This class is used by the Replay Service and Converter to query the contents of storage to be replayed or converted, including:

• The names of streams that are stored, and their associated type representations, when recorded.
• The domain IDs associated with those streams.
• The first and last timestamps in the stored data.

Constructor & Destructor Documentation

virtual rti::recording::storage::StorageStreamInfoReader::~StorageStreamInfoReader ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

virtual void rti::recording::storage::StorageStreamInfoReader::read ( std::vector< rti::routing::StreamInfo * > &  sample_seq, const SelectorState &  selector  )

pure virtual

Retrieve stream information data from storage. This operation should behave differently depending on the product's needs, stated in the SelectorState object passed as a parameter. The stream info samples have to be provided in increasing time-stamp order (reception time-stamp).

Replay Service and Converter will call this method to retrieve discovery data from the plugins. Discovery data describes which streams are available from storage.

Parameters

sample_seq

Vector of SampleType data. A SampleType is an rti::routing::StreamInfo.

selector

Provides the statefulness and constraints of the data queried by Replay Service or Converter. When the selector's sample state is set to 'any', it means its asking for stateless information (it doesn't care whether the data has been read before or not). When the selector's sample state is set to 'not read' then it's a stateful read, and only samples that weren't given to the application before have to be provided. Note: for the moment, Replay Service or Converter won't ask for data with sample state equal to 'read', so this state can be ignored.

virtual void rti::recording::storage::StorageStreamInfoReader::return_loan ( std::vector< rti::routing::StreamInfo * > &  sample_seq )

pure virtual

Notifies plugin it can release the read stream information objects.

Parameters

sample_seq

A vector of stream info objects that the plugin can now release resources for.

virtual int64_t rti::recording::storage::StorageStreamInfoReader::service_start_time ( )

pure virtual

The time within the recorded time range that can be considered time zero of the recording.

virtual int64_t rti::recording::storage::StorageStreamInfoReader::service_stop_time ( )

pure virtual

The time relative to the recorded time range that can be considered the final recording time of the recording.

virtual bool rti::recording::storage::StorageStreamInfoReader::finished ( )

pure virtual

Whether this discovery stream has finished with all discovery data or not.

virtual void rti::recording::storage::StorageStreamInfoReader::reset ( )

pure virtual

Method used by Replay Service when looping, to start over. After this method is called, the stream reader should be ready to start reading data from the beginning of the stream, again.