RTI Recording Service  Version 7.0.0
RTI_RecordingServiceStorageWriter Struct Reference

StorageWriter definition. More...

Data Fields

RTI_RecordingServiceStorageWriter_CreateStreamWriterFcn create_stream_writer
 [Required] Implement the create_stream_writer function to allocate stream writer objects when notified about new streams. More...
 
RTI_RecordingServiceStorageWriter_CreateParticipantWriterFcn create_participant_writer
 [Not required] Implement the creation function to allocate a stream writer dedicated to the DDS Participant built-in topic (DCPSParticipant). More...
 
RTI_RecordingServiceStorageWriter_CreatePublicationWriterFcn create_publication_writer
 [Not required] Implement the creation function to allocate a stream writer dedicated to the DDS Publication built-in topic (DCPSPublication). More...
 
RTI_RecordingServiceStorageWriter_CreateSubscriptionWriterFcn create_subscription_writer
 [Not required] Implement the creation function to allocate a stream writer dedicated to the DDS Subscription built-in topic (DCPSSubscription). More...
 
RTI_RecordingServiceStorageWriter_DeleteStreamWriterFcn delete_stream_writer
 [Required] Implement this delete_stream_writer function to delete stream writer objects when notified about stream disposals or when the service is stopping. More...
 
RTI_RecordingServiceStorageWriter_DeleteParticipantWriterFcn delete_participant_writer
 [Not required] Implement this function to delete DCPSParticipant writer objects. This function must be defined if the creation counterpart function was defined. More...
 
RTI_RecordingServiceStorageWriter_DeletePublicationWriterFcn delete_publication_writer
 [Not required] Implement this function to delete DCPSPublication writer objects. This function must be defined if the creation counterpart function was defined. More...
 
RTI_RecordingServiceStorageWriter_DeleteSubscriptionWriterFcn delete_subscription_writer
 [Not required] Implement this function to delete DCPSSubscription writer objects. This function must be defined if the creation counterpart function was defined. More...
 
RTI_RecordingServiceStorageWriter_DeleteFcn delete_instance
 [Required] Implement the delete_instance function to delete a storage writer instance when RTI Recording Service is shutting down. More...
 
void * storage_writer_data
 A pointer for any data the plug-in might need. Passed to the stream writer creation and deletion functions at runtime. More...
 

Detailed Description

StorageWriter definition.

This type acts as a factory for stream writers, for user-data and also for the three built-in DDS discovery topics. A user-data stream is defined by a name/type combination.

Field Documentation

◆ create_stream_writer

RTI_RecordingServiceStorageWriter_CreateStreamWriterFcn RTI_RecordingServiceStorageWriter::create_stream_writer

[Required] Implement the create_stream_writer function to allocate stream writer objects when notified about new streams.

This call will only be used by RTI Recording Service when creating user-data streams. For any of the three built-in DDS discovery streams, RTI Recording Service will use the create_participant/publication/subscription_writer() methods.

◆ create_participant_writer

RTI_RecordingServiceStorageWriter_CreateParticipantWriterFcn RTI_RecordingServiceStorageWriter::create_participant_writer

[Not required] Implement the creation function to allocate a stream writer dedicated to the DDS Participant built-in topic (DCPSParticipant).

This function is not required. The participant stream writer won't be created if this function not available.

◆ create_publication_writer

RTI_RecordingServiceStorageWriter_CreatePublicationWriterFcn RTI_RecordingServiceStorageWriter::create_publication_writer

[Not required] Implement the creation function to allocate a stream writer dedicated to the DDS Publication built-in topic (DCPSPublication).

This function is not required. The publication stream writer won't be created if this function is not available.

◆ create_subscription_writer

RTI_RecordingServiceStorageWriter_CreateSubscriptionWriterFcn RTI_RecordingServiceStorageWriter::create_subscription_writer

[Not required] Implement the creation function to allocate a stream writer dedicated to the DDS Subscription built-in topic (DCPSSubscription).

This function is not required. The subscription stream writer won't be created if this function not available.

◆ delete_stream_writer

RTI_RecordingServiceStorageWriter_DeleteStreamWriterFcn RTI_RecordingServiceStorageWriter::delete_stream_writer

[Required] Implement this delete_stream_writer function to delete stream writer objects when notified about stream disposals or when the service is stopping.

This method is used to delete instances of user-data stream writers.

◆ delete_participant_writer

RTI_RecordingServiceStorageWriter_DeleteParticipantWriterFcn RTI_RecordingServiceStorageWriter::delete_participant_writer

[Not required] Implement this function to delete DCPSParticipant writer objects. This function must be defined if the creation counterpart function was defined.

◆ delete_publication_writer

RTI_RecordingServiceStorageWriter_DeletePublicationWriterFcn RTI_RecordingServiceStorageWriter::delete_publication_writer

[Not required] Implement this function to delete DCPSPublication writer objects. This function must be defined if the creation counterpart function was defined.

◆ delete_subscription_writer

RTI_RecordingServiceStorageWriter_DeleteSubscriptionWriterFcn RTI_RecordingServiceStorageWriter::delete_subscription_writer

[Not required] Implement this function to delete DCPSSubscription writer objects. This function must be defined if the creation counterpart function was defined.

◆ delete_instance

RTI_RecordingServiceStorageWriter_DeleteFcn RTI_RecordingServiceStorageWriter::delete_instance

[Required] Implement the delete_instance function to delete a storage writer instance when RTI Recording Service is shutting down.

◆ storage_writer_data

void* RTI_RecordingServiceStorageWriter::storage_writer_data

A pointer for any data the plug-in might need. Passed to the stream writer creation and deletion functions at runtime.