Storage reader.
More...
#include <StorageReader.hpp>
Storage reader.
class rti::recording::storage::StorageReader This class creates and deletes:
- StreamInfoReaders, that will be used to query discovery data from storage and provide it to Replay Service and Converter
- StreamReaders, that will be used to query user data from storage and provide it to Replay Service and Converter
◆ StorageReader()
Constructor.
Creates a StorageReader object.
- Parameters
-
| properties | Routing Service PropertySet. Contains name/value pairs that can be passed to the plugin in the XML, using the following snippet: <replay_service name="ExampleReplay>
<storage>
<plugin plugin_name="StorageLibrary::ExamplePlugin">
<!-- Storage properties. These are passed to the plugin in the
plugin_library -->
<property>
<value>
<element>
<name>example.filename</name>
<value>PluggableStorage.dat</value>
</element>
</value>
</property>
</plugin>
</storage>
</replay_service>
|
◆ ~StorageReader()
| virtual rti::recording::storage::StorageReader::~StorageReader |
( |
| ) |
|
|
inlinevirtual |
◆ create_stream_info_reader()
| virtual StorageStreamInfoReader* rti::recording::storage::StorageReader::create_stream_info_reader |
( |
const rti::recording::PropertySet & |
properties | ) |
|
|
pure virtual |
Replay Service calls this to create a stream in charge of discovering information about the available user-data streams in the storage, and read them.
- Parameters
-
| properties | A collection of name-value properties. They include some built-in values, like: 1) name='rti.recording_service.start_timestamp' value=the initial timestamp of the selected time range (64-bit integer in text format) for this stream info reader to query data 2) name='rti.recording_service.end_timestamp' value=the final timestamp of the selected time range (64-bit integer in text format) for this stream info reader to query data |
Referenced by ~StorageReader().
◆ delete_stream_info_reader()
| virtual void rti::recording::storage::StorageReader::delete_stream_info_reader |
( |
StorageStreamInfoReader * |
stream_info_reader | ) |
|
|
pure virtual |
Replay Service calls this to delete a stream information reader.
- Parameters
-
| stream_info_reader | Stream information reader to be deleted. |
Referenced by ~StorageReader().
◆ create_stream_reader()
| virtual StorageStreamReader* rti::recording::storage::StorageReader::create_stream_reader |
( |
const rti::recording::StreamInfo & |
stream_info, |
|
|
const rti::recording::PropertySet & |
properties |
|
) |
| |
|
pure virtual |
Replay Service calls this to create a user-data stream reader.
- Parameters
-
| stream_info | Information about the stream (DDS topic) this stream reader will query from the database. |
| properties | A collection of name-value properties. They include some built-in values, like: 1) name='rti.recording_service.domain_id' value=the DDS domain ID the stream was found in (32-bit integer as text) 2) name='rti.recording_service.start_timestamp' value=the initial timestamp of the selected time range (64-bit integer in text format) for this stream info reader to query data 3) name='rti.recording_service.end_timestamp' value=the final timestamp of the selected time range (64-bit integer in text format) for this stream info reader to query data 4) name='rti.recording_service.playback_settings.sample_order' value=the sample order (enum label in text format) for this stream info reader to query data. The possible values are: RECEPTION_TIMESTAMP, SOURCE_TIMESTAMP. |
Referenced by ~StorageReader().
◆ delete_stream_reader()
| virtual void rti::recording::storage::StorageReader::delete_stream_reader |
( |
StorageStreamReader * |
stream_reader | ) |
|
|
pure virtual |
Replay Service calls this to delete a stream reader.
- Parameters
-
| stream_reader | Stream reader to be deleted. |
Referenced by ~StorageReader().