RTI Recording Service  Version 6.0.1
 All Data Structures Files Variables Typedefs Groups
RTI_RecordingServiceStorageStreamInfoReader Struct Reference

Discovery stream reader. More...

Data Fields

RTI_RecordingServiceStorageStreamInfoReader_ReadFcn read
 Replay Service calls this to retrieve data from the plugin about the streams that are stored. After Replay Service takes a stream, the plugin should not notify Replay Service about the same stream. (required)
 
RTI_RecordingServiceStorageStreamInfoReader_ReturnLoanFcn return_loan
 Replay Service calls this to notify the plugin that it is no longer using the stream information, and the plugin can clean up the memory associated with the stream information. (required)
 
RTI_RecordingServiceStorageStreamInfoReader_GetServiceStartTimeFcn get_service_start_time
 Replay Service calls this to determine the first timestamp in the recorded data. (required)
 
RTI_RecordingServiceStorageStreamInfoReader_GetServiceStopTimeFcn get_service_stop_time
 Replay Service calls this to determine the last timestamp in the recorded data. (required)
 
RTI_RecordingServiceStorageStreamInfoReader_FinishedFcn finished
 Replay Service calls this to check if there is more discovery data available. (required)
 
RTI_RecordingServiceStorageStreamInfoReader_ResetFcn reset
 Replay Service calls this when looping is active and starts over. (required)
 
void * stream_reader_data
 Data that the plugin can specify when the RTI_RecordingServiceStorageStreamInfoReader is created. Passed to all discovery stream reader functions.
 

Detailed Description

Discovery stream reader.

This class is used by the Replay Service and Converter to query the contents of storage to be replayed or converted, including:

  • The names of streams that are stored
  • The domain IDs associated with those streams
  • The first and last timestamps in the stored data

Field Documentation

RTI_RecordingServiceStorageStreamInfoReader_ReadFcn RTI_RecordingServiceStorageStreamInfoReader::read

Replay Service calls this to retrieve data from the plugin about the streams that are stored. After Replay Service takes a stream, the plugin should not notify Replay Service about the same stream. (required)

RTI_RecordingServiceStorageStreamInfoReader_ReturnLoanFcn RTI_RecordingServiceStorageStreamInfoReader::return_loan

Replay Service calls this to notify the plugin that it is no longer using the stream information, and the plugin can clean up the memory associated with the stream information. (required)

RTI_RecordingServiceStorageStreamInfoReader_GetServiceStartTimeFcn RTI_RecordingServiceStorageStreamInfoReader::get_service_start_time

Replay Service calls this to determine the first timestamp in the recorded data. (required)

RTI_RecordingServiceStorageStreamInfoReader_GetServiceStopTimeFcn RTI_RecordingServiceStorageStreamInfoReader::get_service_stop_time

Replay Service calls this to determine the last timestamp in the recorded data. (required)

RTI_RecordingServiceStorageStreamInfoReader_FinishedFcn RTI_RecordingServiceStorageStreamInfoReader::finished

Replay Service calls this to check if there is more discovery data available. (required)

RTI_RecordingServiceStorageStreamInfoReader_ResetFcn RTI_RecordingServiceStorageStreamInfoReader::reset

Replay Service calls this when looping is active and starts over. (required)

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

void* RTI_RecordingServiceStorageStreamInfoReader::stream_reader_data

Data that the plugin can specify when the RTI_RecordingServiceStorageStreamInfoReader is created. Passed to all discovery stream reader functions.


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