RTI Recording Service  Version 6.0.1
 All Data Structures Namespaces Files Functions Typedefs Enumerations Enumerator Groups
rti::recording::storage::StorageReader Class Referenceabstract

Storage reader. More...

#include <StorageReader.hpp>

Public Member Functions

 StorageReader (const rti::routing::PropertySet &properties)
 Constructor.
 
virtual ~StorageReader ()
 Virtual destructor.
 
virtual StorageStreamInfoReadercreate_stream_info_reader (const rti::routing::PropertySet &properties)=0
 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.
 
virtual void delete_stream_info_reader (StorageStreamInfoReader *stream_info_reader)=0
 Replay Service calls this to delete a stream information reader.
 
virtual StorageStreamReadercreate_stream_reader (const rti::routing::StreamInfo &stream_info, const rti::routing::PropertySet &properties)=0
 Replay Service calls this to create a user-data stream reader.
 
virtual void delete_stream_reader (StorageStreamReader *stream_reader)=0
 Replay Service calls this to delete a stream reader.
 

Detailed Description

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

Constructor & Destructor Documentation

StorageReader ( const rti::routing::PropertySet &  properties)
inline

Constructor.

Creates a StorageReader object.

Parameters
propertiesRouting 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>
virtual rti::recording::storage::StorageReader::~StorageReader ( )
inlinevirtual

Virtual destructor.

Member Function Documentation

virtual StorageStreamInfoReader* rti::recording::storage::StorageReader::create_stream_info_reader ( const rti::routing::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
propertiesA 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
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_readerStream information reader to be deleted.
virtual StorageStreamReader* rti::recording::storage::StorageReader::create_stream_reader ( const rti::routing::StreamInfo &  stream_info,
const rti::routing::PropertySet &  properties 
)
pure virtual

Replay Service calls this to create a user-data stream reader.

Parameters
stream_infoInformation about the stream (DDS topic) this stream reader will query from the database.
propertiesA 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
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_readerStream reader to be deleted.

RTI Recording Service Version 6.0.1 Copyright © Sun Nov 17 2019 Real-Time Innovations, Inc