RTI Recording Service  Version 7.0.0
RTI Recording Service Storage APIs

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

Data Structures

struct  RTI_RecordingServiceHistoryState
 Instance history selector. More...
 
struct  RTI_RecordingServiceSelectorState
 Sample selector. More...
 
struct  RTI_RecordingServiceStorageStreamInfoReader
 Discovery stream reader. More...
 
struct  RTI_RecordingServiceStorageStreamReader
 Stream reader. More...
 
struct  RTI_RecordingServiceStorageReader
 Storage reader. More...
 
struct  RTI_RecordingServiceStorageStreamWriter
 StorageStreamWriter definition. More...
 
struct  RTI_RecordingServiceStorageParticipantWriter
 A StorageParticipantWriter implements a store() function to store the DCPSParticipant discovery samples to a storage of your choice. More...
 
struct  RTI_RecordingServiceStoragePublicationWriter
 A StoragePublicationWriter implements a store() function to store the DCPSPublication discovery samples to a storage of your choice. More...
 
struct  RTI_RecordingServiceStorageSubscriptionWriter
 A StorageSubscriptionWriter implements a store() function to store the DCPSSubscription discovery samples to a storage of your choice. More...
 
struct  RTI_RecordingServiceStorageWriter
 StorageWriter definition. More...
 

Typedefs

typedef void(* RTI_RecordingServiceStorageStreamInfoReader_ReadFcn) (void *stream_reader_data, struct RTI_RecordingServiceStreamInfo ***stream_info_array, int *count, const struct RTI_RecordingServiceSelectorState *selector)
 Prototype of the callback function for taking discovery data from the plugin. Discovery data describes which streams are available from storage. This function is a stateful function, as it requires implementations to keep track of the discovery data that has already been provided. More...
 
typedef void(* RTI_RecordingServiceStorageStreamInfoReader_ReturnLoanFcn) (void *stream_reader_data, struct RTI_RecordingServiceStreamInfo **stream_info_array, const int count)
 Prototype of the callback function for releasing resources related to the queried stream data. This is called back when the Replay Service has finished with the stream information queried in the take() function. More...
 
typedef long long(* RTI_RecordingServiceStorageStreamInfoReader_GetServiceStartTimeFcn) (void *stream_reader_data)
 Prototype of the callback function for Replay Service querying the start time of the recorded data. More...
 
typedef long long(* RTI_RecordingServiceStorageStreamInfoReader_GetServiceStopTimeFcn) (void *stream_reader_data)
 Prototype of the callback function for Replay Service querying the end time of the recorded data. More...
 
typedef int(* RTI_RecordingServiceStorageStreamInfoReader_FinishedFcn) (void *stream_reader_data)
 Prototype of the callback function for Replay Service querying whether there are no more discovery samples for this stream. More...
 
typedef void(* RTI_RecordingServiceStorageStreamInfoReader_ResetFcn) (void *stream_reader_data)
 Prototype of the callback function for Replay Service used to start over, restarting the stream reader to the initial state. More...
 
typedef void(* RTI_RecordingServiceStorageStreamReader_ReadFcn) (void *stream_reader_data, RTI_RecordingServiceSample **samples, RTI_RecordingServiceSampleInfo **sample_info_array, int *count, const struct RTI_RecordingServiceSelectorState *selector)
 Prototype of the callback function for retrieving user data from the plugin. More...
 
typedef void(* RTI_RecordingServiceStorageStreamReader_ReturnLoanFcn) (void *stream_reader_data, RTI_RecordingServiceSample *samples, RTI_RecordingServiceSampleInfo *sample_infos, int count)
 Prototype of the callback function for releasing resources related to the queried data samples. This is called back when the Replay Service has finished with the data samples queried in the take() function. More...
 
typedef int(* RTI_RecordingServiceStorageStreamReader_FinishedFcn) (void *stream_reader_data)
 Prototype of the callback function for Replay Service querying whether there are no more samples for this stream. More...
 
typedef void(* RTI_RecordingServiceStorageStreamReader_ResetFcn) (void *stream_reader_data)
 Prototype of the callback function for Replay Service used to start over, restarting the stream reader to the initial state. More...
 
typedef void(* RTI_RecordingServiceStorageReader_DeleteStreamInfoReaderFcn) (void *storage_reader_data, struct RTI_RecordingServiceStorageStreamInfoReader *stream_reader)
 Prototype of the callback function for deletion of the discovery stream reader. More...
 
typedef struct RTI_RecordingServiceStorageStreamInfoReader *(* RTI_RecordingServiceStorageReader_CreateStreamInfoReaderFcn) (void *storage_reader_data, const struct RTI_RoutingServiceProperties *properties)
 Prototype of the callback function for creation of a discovery stream reader. More...
 
typedef void(* RTI_RecordingServiceStorageReader_DeleteStreamReaderFcn) (void *storage_reader_data, struct RTI_RecordingServiceStorageStreamReader *stream_reader)
 Prototype of the callback function for deletion of the stream reader. More...
 
typedef struct RTI_RecordingServiceStorageStreamReader *(* RTI_RecordingServiceStorageReader_CreateStreamReaderFcn) (void *storage_reader_data, const struct RTI_RecordingServiceStreamInfo *stream_info, const struct RTI_RoutingServiceProperties *properties)
 Prototype of the callback function for creation of a stream reader. More...
 
typedef void(* RTI_RecordingServiceStorageReader_DeleteFcn) (struct RTI_RecordingServiceStorageReader *storage_reader)
 Prototype of the callback function for deletion of the storage reader. More...
 
typedef struct RTI_RecordingServiceStorageReader *(* RTI_RecordingServiceStorageReader_CreateFcn) (const struct RTI_RoutingServiceProperties *properties)
 Storage reader creation function. More...
 
typedef void(* RTI_RecordingServiceStorageStreamWriter_StoreFcn) (void *stream_writer_data, const RTI_RecordingServiceSample *samples, const RTI_RecordingServiceSampleInfo *sample_infos, const int count)
 Prototype of the callback function for storing data. More...
 
typedef void(* RTI_RecordingServiceStorageParticipantWriter_StoreFcn) (void *stream_writer_data, const DDS_ParticipantBuiltinTopicData **samples, const RTI_RecordingServiceSampleInfo *sample_infos, const int count)
 Prototype of the callback function for storing DCPSParticipant data. More...
 
typedef void(* RTI_RecordingServiceStoragePublicationWriter_StoreFcn) (void *stream_writer_data, const DDS_PublicationBuiltinTopicData **samples, const RTI_RecordingServiceSampleInfo *sample_infos, const int count)
 Prototype of the callback function for storing DCPSPublication data. More...
 
typedef void(* RTI_RecordingServiceStorageSubscriptionWriter_StoreFcn) (void *stream_writer_data, const DDS_SubscriptionBuiltinTopicData **samples, const RTI_RecordingServiceSampleInfo *sample_infos, const int count)
 Prototype of the callback function for storing DCPSSubscription data. More...
 
typedef struct RTI_RecordingServiceStorageStreamWriter *(* RTI_RecordingServiceStorageWriter_CreateStreamWriterFcn) (void *storage_writer_data, const struct RTI_RecordingServiceStreamInfo *stream_info, const struct RTI_RoutingServiceProperties *properties)
 Prototype of the function for creating a StorageStreamWriter. More...
 
typedef struct RTI_RecordingServiceStorageParticipantWriter *(* RTI_RecordingServiceStorageWriter_CreateParticipantWriterFcn) (void *storage_writer_data)
 Prototype of the function for creating a StorageStreamWriter. More...
 
typedef struct RTI_RecordingServiceStoragePublicationWriter *(* RTI_RecordingServiceStorageWriter_CreatePublicationWriterFcn) (void *storage_writer_data)
 Prototype of the function for creating a StorageStreamWriter. More...
 
typedef struct RTI_RecordingServiceStorageSubscriptionWriter *(* RTI_RecordingServiceStorageWriter_CreateSubscriptionWriterFcn) (void *storage_writer_data)
 Prototype of the function for creating a StorageStreamWriter. More...
 
typedef void(* RTI_RecordingServiceStorageWriter_DeleteStreamWriterFcn) (void *storage_writer_data, struct RTI_RecordingServiceStorageStreamWriter *stream_writer)
 Prototype of the function for deleting a StorageStreamWriter. More...
 
typedef void(* RTI_RecordingServiceStorageWriter_DeleteParticipantWriterFcn) (void *storage_writer_data, struct RTI_RecordingServiceStorageParticipantWriter *stream_writer)
 Prototype of the function for deleting a StorageParticipantWriter. More...
 
typedef void(* RTI_RecordingServiceStorageWriter_DeletePublicationWriterFcn) (void *storage_writer_data, struct RTI_RecordingServiceStoragePublicationWriter *stream_writer)
 Prototype of the function for deleting a StoragePublicationWriter. More...
 
typedef void(* RTI_RecordingServiceStorageWriter_DeleteSubscriptionWriterFcn) (void *storage_writer_data, struct RTI_RecordingServiceStorageSubscriptionWriter *stream_writer)
 Prototype of the function for deleting a StorageSubscriptionWriter. More...
 
typedef void(* RTI_RecordingServiceStorageWriter_DeleteFcn) (struct RTI_RecordingServiceStorageWriter *storage_writer)
 Prototype of the function for deleting a StorageWriter. More...
 
typedef struct RTI_RecordingServiceStorageWriter *(* RTI_RecordingServiceStorageWriter_CreateFcn) (const struct RTI_RoutingServiceProperties *properties)
 Prototype of the function for creating a StorageWriter. More...
 

Detailed Description

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

Typedef Documentation

◆ RTI_RecordingServiceStorageStreamInfoReader_ReadFcn

typedef void(* RTI_RecordingServiceStorageStreamInfoReader_ReadFcn) (void *stream_reader_data, struct RTI_RecordingServiceStreamInfo ***stream_info_array, int *count, const struct RTI_RecordingServiceSelectorState *selector)

Prototype of the callback function for taking discovery data from the plugin. Discovery data describes which streams are available from storage. This function is a stateful function, as it requires implementations to keep track of the discovery data that has already been provided.

Parameters
stream_reader_dataData you defined when creating the RTI_RecordingServiceStorageStreamInfoReader object.
stream_info_arrayAn array of stream inforamtion that the Replay Service can use to determine which streams are available from storage for replaying or converting to a new format.
countSize of the arrays.
selectorAllows the selection of the data samples to be returned. The service will provide this depending on the specific needs at the time.

◆ RTI_RecordingServiceStorageStreamInfoReader_ReturnLoanFcn

typedef void(* RTI_RecordingServiceStorageStreamInfoReader_ReturnLoanFcn) (void *stream_reader_data, struct RTI_RecordingServiceStreamInfo **stream_info_array, const int count)

Prototype of the callback function for releasing resources related to the queried stream data. This is called back when the Replay Service has finished with the stream information queried in the take() function.

Parameters
stream_reader_dataData you defined when creating the RTI_RecordingServiceStorageStreamInfoReader object.
stream_info_arrayAn array of stream_info objects that the plugin can now free.
sample_info_arrayAn array of sample_info objects that the plugin can now free.
countSize of the arrays.

◆ RTI_RecordingServiceStorageStreamInfoReader_GetServiceStartTimeFcn

typedef long long(* RTI_RecordingServiceStorageStreamInfoReader_GetServiceStartTimeFcn) (void *stream_reader_data)

Prototype of the callback function for Replay Service querying the start time of the recorded data.

Parameters
stream_reader_dataData you defined when creating the RTI_RecordingServiceStorageStreamInfoReader object.

◆ RTI_RecordingServiceStorageStreamInfoReader_GetServiceStopTimeFcn

typedef long long(* RTI_RecordingServiceStorageStreamInfoReader_GetServiceStopTimeFcn) (void *stream_reader_data)

Prototype of the callback function for Replay Service querying the end time of the recorded data.

Parameters
stream_reader_dataData you defined when creating the RTI_RecordingServiceStorageStreamInfoReader object.

◆ RTI_RecordingServiceStorageStreamInfoReader_FinishedFcn

typedef int(* RTI_RecordingServiceStorageStreamInfoReader_FinishedFcn) (void *stream_reader_data)

Prototype of the callback function for Replay Service querying whether there are no more discovery samples for this stream.

Parameters
stream_reader_dataData you defined when creating the RTI_RecordingServiceStorageStreamInfoReader object.
Returns
1 if there is no more data available for this stream, 0 otherwise.

◆ RTI_RecordingServiceStorageStreamInfoReader_ResetFcn

typedef void(* RTI_RecordingServiceStorageStreamInfoReader_ResetFcn) (void *stream_reader_data)

Prototype of the callback function for Replay Service used to start over, restarting the stream reader to the initial state.

Parameters
stream_reader_dataData you defined when creating the RTI_RecordingServiceStorageStreamInfoReader object.

◆ RTI_RecordingServiceStorageStreamReader_ReadFcn

typedef void(* RTI_RecordingServiceStorageStreamReader_ReadFcn) (void *stream_reader_data, RTI_RecordingServiceSample **samples, RTI_RecordingServiceSampleInfo **sample_info_array, int *count, const struct RTI_RecordingServiceSelectorState *selector)

Prototype of the callback function for retrieving user data from the plugin.

Parameters
stream_reader_dataData you defined when creating the RTI_RecordingServiceStorageStreamReader object.
samplesAn array of data samples that Replay Service will replay or convert to a new format.
sample_info_arrayAn array of sample information about the samples, such as recorded timestamps of the sample data.
countSize of the arrays.
selectorProvides the statefulness and constraints of the data queried by Replay Service or Converter. When the selector's sample state is set to 'any', it means its asking for stateless information (it doesn't care whether the data has been read before or not). When the selector's sample state is set to 'not read' then it's a stateful read, and only samples that weren't given to the application before have to be provided. Note: for the moment, Replay Service or Converter won't ask for data with sample state equal to 'read', so this state can be ignored.

When the selector's start timestamp is set to a value different than 0, it means that Replay Service is on a jumping process. The StreamReader should then prepare its statement with this new start timestamp. Also, if the selector's maximum samples is set to 0, it means that Replay Service is on a jumping breakpoint process instead of a standard jumping process. In this case, the StreamReader should also prepare the statement but it should not read any sample.

◆ RTI_RecordingServiceStorageStreamReader_ReturnLoanFcn

typedef void(* RTI_RecordingServiceStorageStreamReader_ReturnLoanFcn) (void *stream_reader_data, RTI_RecordingServiceSample *samples, RTI_RecordingServiceSampleInfo *sample_infos, int count)

Prototype of the callback function for releasing resources related to the queried data samples. This is called back when the Replay Service has finished with the data samples queried in the take() function.

Parameters
stream_reader_dataData you defined when creating the RTI_RecordingServiceStorageStreamReader object.
samplesAn array of sample objects that the plugin can now free.
sample_infosAn array of sample_info objects that the plugin can now free.
countSize of the arrays.

◆ RTI_RecordingServiceStorageStreamReader_FinishedFcn

typedef int(* RTI_RecordingServiceStorageStreamReader_FinishedFcn) (void *stream_reader_data)

Prototype of the callback function for Replay Service querying whether there are no more samples for this stream.

Parameters
stream_reader_dataData you defined when creating the RTI_RecordingServiceStorageStreamReader object.
Returns
1 if there is no more data available for this stream, 0 otherwise.

◆ RTI_RecordingServiceStorageStreamReader_ResetFcn

typedef void(* RTI_RecordingServiceStorageStreamReader_ResetFcn) (void *stream_reader_data)

Prototype of the callback function for Replay Service used to start over, restarting the stream reader to the initial state.

After this method is called, the stream reader should be ready to read again from the beginning of the stream.

Parameters
stream_reader_dataData you defined when creating the RTI_RecordingServiceStorageStreamReader object.

◆ RTI_RecordingServiceStorageReader_DeleteStreamInfoReaderFcn

typedef void(* RTI_RecordingServiceStorageReader_DeleteStreamInfoReaderFcn) (void *storage_reader_data, struct RTI_RecordingServiceStorageStreamInfoReader *stream_reader)

Prototype of the callback function for deletion of the discovery stream reader.

Parameters
storage_reader_dataData you defined when creating the RTI_RecordingServiceStorageReader object.
stream_readerDiscovery stream reader to be deleted.

◆ RTI_RecordingServiceStorageReader_CreateStreamInfoReaderFcn

typedef struct RTI_RecordingServiceStorageStreamInfoReader*(* RTI_RecordingServiceStorageReader_CreateStreamInfoReaderFcn) (void *storage_reader_data, const struct RTI_RoutingServiceProperties *properties)

Prototype of the callback function for creation of a discovery stream reader.

Parameters
storage_reader_dataData you defined when creating the RTI_RecordingServiceStorageReader object.
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 3) 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. 4) name='rti.recording_service.playback_settings.reverse_mode' value= the status of the reverse mode (ENABLED or DISABLED) for this stream info reader to query data. The possible values are: true, false.

◆ RTI_RecordingServiceStorageReader_DeleteStreamReaderFcn

typedef void(* RTI_RecordingServiceStorageReader_DeleteStreamReaderFcn) (void *storage_reader_data, struct RTI_RecordingServiceStorageStreamReader *stream_reader)

Prototype of the callback function for deletion of the stream reader.

Parameters
storage_reader_dataData you defined when creating the RTI_RecordingServiceStorageReader object.
stream_readerStream reader to be deleted.

◆ RTI_RecordingServiceStorageReader_CreateStreamReaderFcn

typedef struct RTI_RecordingServiceStorageStreamReader*(* RTI_RecordingServiceStorageReader_CreateStreamReaderFcn) (void *storage_reader_data, const struct RTI_RecordingServiceStreamInfo *stream_info, const struct RTI_RoutingServiceProperties *properties)

Prototype of the callback function for creation of a stream reader.

Parameters
storage_reader_dataData you defined when creating the RTI_RecordingServiceStorageReader object.
stream_infoInformation about the stream (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 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. 5) name='rti.recording_service.playback_settings.reverse_mode' value= the status of the reverse mode (ENABLED or DISABLED) for this stream info reader to query data. The possible values are: true, false.

◆ RTI_RecordingServiceStorageReader_DeleteFcn

typedef void(* RTI_RecordingServiceStorageReader_DeleteFcn) (struct RTI_RecordingServiceStorageReader *storage_reader)

Prototype of the callback function for deletion of the storage reader.

Parameters
storage_readerStorage reader to be deleted.

◆ RTI_RecordingServiceStorageReader_CreateFcn

typedef struct RTI_RecordingServiceStorageReader*(* RTI_RecordingServiceStorageReader_CreateFcn) (const struct RTI_RoutingServiceProperties *properties)

Storage reader creation function.

Parameters
propertiesRouting Service properties, originating in the plugin properties in the XML configuration file. Passed as name/value pairs.

This function is called by Replay Service to create the plugin's storage reader. Later, Replay Service will call functions on the storage reader to create discovery stream readers and stream readers used to query discovery and user data from the database.

The name of this function must be specified in the XML configuration of the Replay Service, as described in the following XML:

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

◆ RTI_RecordingServiceStorageStreamWriter_StoreFcn

typedef void(* RTI_RecordingServiceStorageStreamWriter_StoreFcn) (void *stream_writer_data, const RTI_RecordingServiceSample *samples, const RTI_RecordingServiceSampleInfo *sample_infos, const int count)

Prototype of the callback function for storing data.

Parameters
storage_writer_dataData you defined when creating the RTI_RecordingServiceStorageStreamWriter structure.
samplesArray of sample objects, which contain recorded data as DynamicData.
sample_infosArray of information about samples.
countSize of the samples and sample_infos arrays.

A StorageStreamWriter must implement a store() function, which will be used to store data to the storage of your choice.

◆ RTI_RecordingServiceStorageParticipantWriter_StoreFcn

typedef void(* RTI_RecordingServiceStorageParticipantWriter_StoreFcn) (void *stream_writer_data, const DDS_ParticipantBuiltinTopicData **samples, const RTI_RecordingServiceSampleInfo *sample_infos, const int count)

Prototype of the callback function for storing DCPSParticipant data.

Parameters
storage_writer_dataData you defined when creating the RTI_RecordingServiceStorageParticipantWriter structure.
samplesArray of DDS_ParticipantBuiltinTopicData objects to be stored.
sample_infosArray of information about samples.
countSize of the samples and sample_infos arrays.

◆ RTI_RecordingServiceStoragePublicationWriter_StoreFcn

typedef void(* RTI_RecordingServiceStoragePublicationWriter_StoreFcn) (void *stream_writer_data, const DDS_PublicationBuiltinTopicData **samples, const RTI_RecordingServiceSampleInfo *sample_infos, const int count)

Prototype of the callback function for storing DCPSPublication data.

Parameters
storage_writer_dataData you defined when creating the RTI_RecordingServiceStoragePublicationWriter structure.
samplesArray of DDS_PublicationBuiltinTopicData objects to be stored.
sample_infosArray of information about samples.
countSize of the samples and sample_infos arrays.

◆ RTI_RecordingServiceStorageSubscriptionWriter_StoreFcn

typedef void(* RTI_RecordingServiceStorageSubscriptionWriter_StoreFcn) (void *stream_writer_data, const DDS_SubscriptionBuiltinTopicData **samples, const RTI_RecordingServiceSampleInfo *sample_infos, const int count)

Prototype of the callback function for storing DCPSSubscription data.

Parameters
storage_writer_dataData you defined when creating the RTI_RecordingServiceStorageSubscriptionWriter structure.
samplesArray of DDS_SubscriptionBuiltinTopicData objects to be stored.
sample_infosArray of information about samples.
countSize of the samples and sample_infos arrays.

◆ RTI_RecordingServiceStorageWriter_CreateStreamWriterFcn

typedef struct RTI_RecordingServiceStorageStreamWriter*(* RTI_RecordingServiceStorageWriter_CreateStreamWriterFcn) (void *storage_writer_data, const struct RTI_RecordingServiceStreamInfo *stream_info, const struct RTI_RoutingServiceProperties *properties)

Prototype of the function for creating a StorageStreamWriter.

Parameters
storage_writer_dataData you defined when creating the RTI_RecordingServiceStorageStreamWriter structure.
stream_infoInformation about the discovered stream, including stream name (Topic name) and data type.
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) A StorageWriter is responsible for creating StreamWriters when notified about new streams.

◆ RTI_RecordingServiceStorageWriter_CreateParticipantWriterFcn

typedef struct RTI_RecordingServiceStorageParticipantWriter*(* RTI_RecordingServiceStorageWriter_CreateParticipantWriterFcn) (void *storage_writer_data)

Prototype of the function for creating a StorageStreamWriter.

Parameters
storage_writer_dataData you defined when creating the RTI_RecordingServiceStorageParticipantWriter structure.

◆ RTI_RecordingServiceStorageWriter_CreatePublicationWriterFcn

typedef struct RTI_RecordingServiceStoragePublicationWriter*(* RTI_RecordingServiceStorageWriter_CreatePublicationWriterFcn) (void *storage_writer_data)

Prototype of the function for creating a StorageStreamWriter.

Parameters
storage_writer_dataData you defined when creating the RTI_RecordingServiceStoragePublicationWriter structure.

◆ RTI_RecordingServiceStorageWriter_CreateSubscriptionWriterFcn

typedef struct RTI_RecordingServiceStorageSubscriptionWriter*(* RTI_RecordingServiceStorageWriter_CreateSubscriptionWriterFcn) (void *storage_writer_data)

Prototype of the function for creating a StorageStreamWriter.

Parameters
storage_writer_dataData you defined when creating the RTI_RecordingServiceStorageSubscriptionWriter structure.

◆ RTI_RecordingServiceStorageWriter_DeleteStreamWriterFcn

typedef void(* RTI_RecordingServiceStorageWriter_DeleteStreamWriterFcn) (void *storage_writer_data, struct RTI_RecordingServiceStorageStreamWriter *stream_writer)

Prototype of the function for deleting a StorageStreamWriter.

Parameters
storage_writer_dataData you defined when creating the RTI_RecordingServiceStorageStreamWriter structure.
stream_writerStreamWriter to delete.

◆ RTI_RecordingServiceStorageWriter_DeleteParticipantWriterFcn

typedef void(* RTI_RecordingServiceStorageWriter_DeleteParticipantWriterFcn) (void *storage_writer_data, struct RTI_RecordingServiceStorageParticipantWriter *stream_writer)

Prototype of the function for deleting a StorageParticipantWriter.

Parameters
storage_writer_dataData you defined when creating the RTI_RecordingServiceStorageParticipantWriter structure.
stream_writerThe ParticipantWriter instance to delete.

◆ RTI_RecordingServiceStorageWriter_DeletePublicationWriterFcn

typedef void(* RTI_RecordingServiceStorageWriter_DeletePublicationWriterFcn) (void *storage_writer_data, struct RTI_RecordingServiceStoragePublicationWriter *stream_writer)

Prototype of the function for deleting a StoragePublicationWriter.

Parameters
storage_writer_dataData you defined when creating the RTI_RecordingServiceStoragePublicationWriter structure.
stream_writerThe PublicationWriter instance to delete.

◆ RTI_RecordingServiceStorageWriter_DeleteSubscriptionWriterFcn

typedef void(* RTI_RecordingServiceStorageWriter_DeleteSubscriptionWriterFcn) (void *storage_writer_data, struct RTI_RecordingServiceStorageSubscriptionWriter *stream_writer)

Prototype of the function for deleting a StorageSubscriptionWriter.

Parameters
storage_writer_dataData you defined when creating the RTI_RecordingServiceStorageSubscriptionWriter structure.
stream_writerThe SubscriptionWriter instance to delete.

◆ RTI_RecordingServiceStorageWriter_DeleteFcn

typedef void(* RTI_RecordingServiceStorageWriter_DeleteFcn) (struct RTI_RecordingServiceStorageWriter *storage_writer)

Prototype of the function for deleting a StorageWriter.

Parameters
storage_writerStorageWriter to delete.

◆ RTI_RecordingServiceStorageWriter_CreateFcn

typedef struct RTI_RecordingServiceStorageWriter*(* RTI_RecordingServiceStorageWriter_CreateFcn) (const struct RTI_RoutingServiceProperties *properties)

Prototype of the function for creating a StorageWriter.

Parameters
propertiesRoutingService properties, originating in the plugin properties in the XML configuration file. Passed as name/value pairs.

This function is called by RTI Recording Service to create the plugin's storage writer, which will then be called to create stream writers for each discovered stream (Topic).

The name of this function must be specified in the XML configuration of the RTI Recording Service, as described in the following XML:

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