RTI Recording Service Storage APIs

This module contains pluggable storage APIs for reading and writing to custom storage. More...

Data Structures
class	rti::recording::storage::SelectorState
	This class is used by Replay Service or Converter when asking the storage plugin for data. It specifies whether the samples should be 'not read' samples, that haven't been returned before, or that 'any' sample state is needed. It also allows to specify the time range the samples returned have to lay within (upper and lower limit). More...
class	rti::recording::storage::StorageReader
	Storage reader. More...
class	rti::recording::storage::StorageStreamInfoReader
	Storage discovery stream reader. More...
class	rti::recording::storage::StorageStreamReader
	Storage stream reader. More...
class	rti::recording::storage::TStorageStreamReader< Data, Info >
	A templatized wrapping implementation of StorageStreamReader, providing a strongly-typed interface regarding data and info representations. More...
class	rti::recording::storage::StorageStreamWriter
	Storage stream writer. More...
class	rti::recording::storage::TStorageStreamWriter< Data, Info >
	A templatized wrapping implementation of StorageStreamWriter, providing a strongly-typed interface regarding data and info representations. More...
class	rti::recording::storage::StorageWriter
	Storage writer. More...

Macros
#define	RTI_RECORDING_STORAGE_READER_CREATE_DECL(STORAGE_READER_CLASS)
	Convenience macro to declare the C-style function that will be called by Replay Service and Converter to create your class.
#define	RTI_RECORDING_STORAGE_READER_CREATE_DEF(STORAGE_READER_CLASS)
	Convenience macro to implement the C-style function that will be called by Replay Service and Converter to create your class.
#define	RTI_RECORDING_STORAGE_WRITER_CREATE_DECL(STORAGE_WRITER_CLASS)
	Convenience macro to declare the C-style function that will be called by RTI Recording Service to create your class.
#define	RTI_RECORDING_STORAGE_WRITER_CREATE_DEF(STORAGE_WRITER_CLASS)
	Convenience macro to implement the C-style function that will be called by RTI Recording Service to create your class.

Typedefs
typedef TStorageStreamWriter < dds::topic::ParticipantBuiltinTopicData, dds::sub::SampleInfo >	rti::recording::storage::ParticipantStorageWriter
	Convenience definition of typed StorageStreamWriter that requires dds::core::xtypes::DynamicData for data samples and dds::sub::SampleInfo for info samples.
typedef TStorageStreamWriter < dds::topic::PublicationBuiltinTopicData, dds::sub::SampleInfo >	rti::recording::storage::PublicationStorageWriter
	Convenience definition of typed StorageStreamWriter that requires dds::core::xtypes::DynamicData for data samples and dds::sub::SampleInfo for info samples.
typedef TStorageStreamWriter < dds::topic::SubscriptionBuiltinTopicData, dds::sub::SampleInfo >	rti::recording::storage::SubscriptionStorageWriter
	Convenience definition of typed StorageStreamWriter that requires dds::core::xtypes::DynamicData for data samples and dds::sub::SampleInfo for info samples.
typedef TStorageStreamReader < dds::core::xtypes::DynamicData, dds::sub::SampleInfo >	rti::recording::storage::DynamicDataStorageStreamReader
	Convenience definition of typed StorageStreamReader that requires dds::core::xtypes::DynamicData for data samples and dds::sub::SampleInfo for info samples.
typedef TStorageStreamWriter < dds::core::xtypes::DynamicData, dds::sub::SampleInfo >	rti::recording::storage::DynamicDataStorageStreamWriter
	Convenience definition of typed StorageStreamWriter that requires dds::core::xtypes::DynamicData for data samples and dds::sub::SampleInfo for info samples.

Detailed Description

This module contains pluggable storage APIs for reading and writing to custom storage.

Macro Definition Documentation

#define RTI_RECORDING_STORAGE_READER_CREATE_DECL

(

STORAGE_READER_CLASS

)

Value:

extern "C" RTI_USER_DLL_EXPORT \
struct RTI_RecordingServiceStorageReader * \
STORAGE_READER_CLASS ## _get_storage_reader( \
        const struct RTI_RoutingServiceProperties *);

Convenience macro to declare the C-style function that will be called by Replay Service and Converter to create your class.

This macro automatically declares a C wrapper function for your class creation. Replay Service and Converter must be initialized with the name of this function. For example if your StorageReader class is 'FileStorageReader' this creates wrapper function called 'FileStorageReader_get_storage_reader' that you must specify in your XML file, such as:

 <plugin_library name="StorageLibrary">
     <storage_plugin name="ExamplePlugin">
         <dll>FileStorageReader</dll>
         <create_function>FileStorageReader_get_storage_reader</create_function>
     </storage_plugin>
 </plugin_library>

#define RTI_RECORDING_STORAGE_READER_CREATE_DEF

(

STORAGE_READER_CLASS

)

Value:

struct RTI_RecordingServiceStorageReader * \
STORAGE_READER_CLASS ## _get_storage_reader( \
        const struct RTI_RoutingServiceProperties *native_properties) \
{ \
    rti::routing::PropertySet properties; \
    rti::routing::PropertyAdapter::add_properties_from_native( \
            properties, \
            native_properties); \
    return new rti::recording::storage::detail::StorageReaderForwarder( \
            new STORAGE_READER_CLASS(properties)); \
}

Convenience macro to implement the C-style function that will be called by Replay Service and Converter to create your class.

This macro automatically defines a C wrapper function for your class creation. Replay Service and Converter must be initialized with the name of this function.

#define RTI_RECORDING_STORAGE_WRITER_CREATE_DECL

(

STORAGE_WRITER_CLASS

)

Value:

extern "C" RTI_USER_DLL_EXPORT \
struct RTI_RecordingServiceStorageWriter * \
STORAGE_WRITER_CLASS ## _get_storage_writer( \
        const struct RTI_RoutingServiceProperties *);

Convenience macro to declare the C-style function that will be called by RTI Recording Service to create your class.

This macro automatically declares a C wrapper function for your class creation. RTI Recording Service must be initialized with the name of this function. For example if your StorageWriter class is 'FileStorageWriter' this creates wrapper function called 'FileStorageWriter_get_storage_writer' that you must specify in your XML file, such as:

  <plugin_library name="StorageLibrary">
      <storage_plugin name="ExamplePlugin">
          <dll>FileStorageWriter</dll>
          <create_function>FileStorageWriter_get_storage_writer</create_function>
      </storage_plugin>
  </plugin_library>

#define RTI_RECORDING_STORAGE_WRITER_CREATE_DEF

(

STORAGE_WRITER_CLASS

)

Value:

struct RTI_RecordingServiceStorageWriter * \
STORAGE_WRITER_CLASS ## _get_storage_writer( \
        const struct RTI_RoutingServiceProperties *native_properties) \
{ \
    rti::routing::PropertySet properties; \
    rti::routing::PropertyAdapter::add_properties_from_native( \
            properties, \
            native_properties); \
    return new rti::recording::storage::detail::StorageWriterForwarder( \
            new STORAGE_WRITER_CLASS(properties)); \
}

Convenience macro to implement the C-style function that will be called by RTI Recording Service to create your class.

This macro automatically defines a C wrapper function for your class creation. RTI Recording Service must be initialized with the name of this function.

Typedef Documentation

typedef TStorageStreamWriter< dds::topic::ParticipantBuiltinTopicData, dds::sub::SampleInfo> rti::recording::storage::ParticipantStorageWriter

Convenience definition of typed StorageStreamWriter that requires dds::core::xtypes::DynamicData for data samples and dds::sub::SampleInfo for info samples.

typedef TStorageStreamWriter< dds::topic::PublicationBuiltinTopicData, dds::sub::SampleInfo> rti::recording::storage::PublicationStorageWriter

Convenience definition of typed StorageStreamWriter that requires dds::core::xtypes::DynamicData for data samples and dds::sub::SampleInfo for info samples.

typedef TStorageStreamWriter< dds::topic::SubscriptionBuiltinTopicData, dds::sub::SampleInfo> rti::recording::storage::SubscriptionStorageWriter

Convenience definition of typed StorageStreamWriter that requires dds::core::xtypes::DynamicData for data samples and dds::sub::SampleInfo for info samples.

typedef TStorageStreamReader< dds::core::xtypes::DynamicData, dds::sub::SampleInfo> rti::recording::storage::DynamicDataStorageStreamReader

Convenience definition of typed StorageStreamReader that requires dds::core::xtypes::DynamicData for data samples and dds::sub::SampleInfo for info samples.

typedef TStorageStreamWriter< dds::core::xtypes::DynamicData, dds::sub::SampleInfo> rti::recording::storage::DynamicDataStorageStreamWriter

Convenience definition of typed StorageStreamWriter that requires dds::core::xtypes::DynamicData for data samples and dds::sub::SampleInfo for info samples.