RTI Recording Service  Version 6.1.2
StorageStreamInfoReader.hpp
1 /******************************************************************************
2  * (c) Copyright, Real-Time Innovations, 2016-.
3  * All rights reserved.
4  * No duplications, whole or partial, manual or electronic, may be made
5  * without express written permission. Any such copies, or
6  * revisions thereof, must display this notice unaltered.
7  * This code contains trade secrets of Real-Time Innovations, Inc.
8  *****************************************************************************/
9 
10 #ifndef HPP_RTI_RECORDING_STORAGE_DISCOVERYSTREAMREADER_HPP_
11 #define HPP_RTI_RECORDING_STORAGE_DISCOVERYSTREAMREADER_HPP_
12 
13 #include "dds/dds.hpp"
14 #include "rti/recording/StreamInfo.hpp"
15 
16 #include "SelectorState.hpp"
17 
18 namespace rti { namespace recording { namespace storage {
19 
32 public:
33 
39 
69  virtual void read(
70  std::vector<rti::recording::StreamInfo *>& sample_seq,
71  const SelectorState& selector) = 0;
72 
79  virtual void return_loan(
80  std::vector<rti::recording::StreamInfo *>& sample_seq) = 0;
81 
86  virtual int64_t service_start_time() = 0;
87 
92  virtual int64_t service_stop_time() = 0;
93 
98  virtual bool finished() = 0;
99 
105  virtual void reset() = 0;
106 };
107 
108 } } } /* namespace rti::recording::storage */
109 
110 #endif /* HPP_RTI_RECORDING_STORAGE_DISCOVERYSTREAMREADER_HPP_ */
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.
virtual bool finished()=0
Whether this discovery stream has finished with all discovery data or not.
virtual ~StorageStreamInfoReader()
Virtual destructor.
Definition: StorageStreamInfoReader.hpp:38
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 r...
virtual int64_t service_start_time()=0
The time within the recorded time range that can be considered time zero of the recording.
The RTI namespace.
Definition: RecordingServiceImpl.hpp:22
This class is used by Replay Service or Converter when asking the storage plugin for data...
Definition: SelectorState.hpp:98
Storage discovery stream reader.
Definition: StorageStreamInfoReader.hpp:31
virtual void return_loan(std::vector< rti::recording::StreamInfo *> &sample_seq)=0
Notifies plugin it can release the read stream information objects.
virtual void read(std::vector< rti::recording::StreamInfo *> &sample_seq, const SelectorState &selector)=0
Retrieve stream information data from storage. This operation should behave differently depending on ...