Storage writer.
More...
#include <StorageWriter.hpp>
|
| StorageWriter (const rti::recording::PropertySet &properties) |
| Constructor. More...
|
|
virtual | ~StorageWriter () |
| Virtual destructor. More...
|
|
virtual StorageStreamWriter * | create_stream_writer (const rti::recording::StreamInfo &stream_info, const rti::recording::PropertySet &properties)=0 |
| RTI Recording Service calls this to create a user-data stream writer. The built-in DDS discovery topics can be recorded, however, RTI Recording Service will use the create_discovery_stream_writer() call to obtain a stream writer for those types. More...
|
|
virtual ParticipantStorageWriter * | create_participant_writer () |
| RTI Recording Service calls this to create a stream writer for the DDS built-in topic DCPSParticipant. In order for the stream writer to be created, this function has to be implemented. Otherwise, no DCPSParticipant data will be recorded. More...
|
|
virtual PublicationStorageWriter * | create_publication_writer () |
| RTI Recording Service calls this to create a stream writer for the DDS built-in topic DCPSPublication. In order for the stream writer to be created, this function has to be implemented. Otherwise, no DCPSPublication data will be recorded. More...
|
|
virtual SubscriptionStorageWriter * | create_subscription_writer () |
| RTI Recording Service calls this to create a stream writer for the DDS built-in topic DCPSSubscription. In order for the stream writer to be created, this function has to be implemented. Otherwise, no DCPSSubscription data will be recorded. More...
|
|
virtual void | delete_stream_writer (StorageStreamWriter *writer)=0 |
| RTI Recording Service calls this to delete a stream writer. This method should be able to work with any stream, user-data or discovery. More...
|
|
Storage writer.
class rti::recording::storage::StorageWriter
This class is responsible for creating StorageStreamWriters when notified that a new stream has been discovered. A stream is defined by a Topic/type combination
◆ StorageWriter()
rti::recording::storage::StorageWriter::StorageWriter |
( |
const rti::recording::PropertySet & |
properties | ) |
|
|
inline |
Constructor.
Creates a StorageWriter object.
- Parameters
-
properties | Routing Service PropertySet. Contains name/value pairs that can be passed to the plugin in the XML, using the following snippet: <recording_service name="ExampleRecorder">
<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>
</recording_service>
|
◆ ~StorageWriter()
virtual rti::recording::storage::StorageWriter::~StorageWriter |
( |
| ) |
|
|
inlinevirtual |
◆ create_stream_writer()
virtual StorageStreamWriter * rti::recording::storage::StorageWriter::create_stream_writer |
( |
const rti::recording::StreamInfo & |
stream_info, |
|
|
const rti::recording::PropertySet & |
properties |
|
) |
| |
|
pure virtual |
RTI Recording Service calls this to create a user-data stream writer. The built-in DDS discovery topics can be recorded, however, RTI Recording Service will use the create_discovery_stream_writer() call to obtain a stream writer for those types.
- Parameters
-
stream_info | Information about the stream to be created, such as stream name (DDS topic name). |
properties | A collection of value-pair 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) |
- See also
- create_discovery_stream_writer
◆ create_participant_writer()
RTI Recording Service calls this to create a stream writer for the DDS built-in topic DCPSParticipant. In order for the stream writer to be created, this function has to be implemented. Otherwise, no DCPSParticipant data will be recorded.
- See also
- ParticipantStorageWriter
◆ create_publication_writer()
RTI Recording Service calls this to create a stream writer for the DDS built-in topic DCPSPublication. In order for the stream writer to be created, this function has to be implemented. Otherwise, no DCPSPublication data will be recorded.
- See also
- PublicationStorageWriter
◆ create_subscription_writer()
RTI Recording Service calls this to create a stream writer for the DDS built-in topic DCPSSubscription. In order for the stream writer to be created, this function has to be implemented. Otherwise, no DCPSSubscription data will be recorded.
- See also
- SubscriptionStorageWriter
◆ delete_stream_writer()
virtual void rti::recording::storage::StorageWriter::delete_stream_writer |
( |
StorageStreamWriter * |
writer | ) |
|
|
pure virtual |
RTI Recording Service calls this to delete a stream writer. This method should be able to work with any stream, user-data or discovery.
- Parameters
-
writer | Stream Writer to be deleted. |