storagewriter.ifc File Reference

RTI Recording Service Pluggable Storage Writer API. More...

#include "log/log_makeheader.h"
#include "dds_c/dds_c_builtin.h"
#include "routingservice/routingservice_infrastructure.h"

Data Structures
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_RecordingServiceStorageStreamWriter_StoreFcn )(void *stream_writer_data, const RTI_RoutingServiceSample *samples, const RTI_RoutingServiceSampleInfo *sample_infos, const int count)
	Prototype of the callback function for storing data.
typedef void(*	RTI_RecordingServiceStorageParticipantWriter_StoreFcn )(void *stream_writer_data, const DDS_ParticipantBuiltinTopicData **samples, const RTI_RoutingServiceSampleInfo *sample_infos, const int count)
	Prototype of the callback function for storing DCPSParticipant data.
typedef void(*	RTI_RecordingServiceStoragePublicationWriter_StoreFcn )(void *stream_writer_data, const DDS_PublicationBuiltinTopicData **samples, const RTI_RoutingServiceSampleInfo *sample_infos, const int count)
	Prototype of the callback function for storing DCPSPublication data.
typedef void(*	RTI_RecordingServiceStorageSubscriptionWriter_StoreFcn )(void *stream_writer_data, const DDS_SubscriptionBuiltinTopicData **samples, const RTI_RoutingServiceSampleInfo *sample_infos, const int count)
	Prototype of the callback function for storing DCPSSubscription data.
typedef struct RTI_RecordingServiceStorageStreamWriter *(*	RTI_RecordingServiceStorageWriter_CreateStreamWriterFcn )(void *storage_writer_data, const struct RTI_RoutingServiceStreamInfo *stream_info, const struct RTI_RoutingServiceProperties *properties)
	Prototype of the function for creating a StorageStreamWriter.
typedef struct RTI_RecordingServiceStorageParticipantWriter *(*	RTI_RecordingServiceStorageWriter_CreateParticipantWriterFcn )(void *storage_writer_data)
	Prototype of the function for creating a StorageStreamWriter.
typedef struct RTI_RecordingServiceStoragePublicationWriter *(*	RTI_RecordingServiceStorageWriter_CreatePublicationWriterFcn )(void *storage_writer_data)
	Prototype of the function for creating a StorageStreamWriter.
typedef struct RTI_RecordingServiceStorageSubscriptionWriter *(*	RTI_RecordingServiceStorageWriter_CreateSubscriptionWriterFcn )(void *storage_writer_data)
	Prototype of the function for creating a StorageStreamWriter.
typedef void(*	RTI_RecordingServiceStorageWriter_DeleteStreamWriterFcn )(void *storage_writer_data, struct RTI_RecordingServiceStorageStreamWriter *stream_writer)
	Prototype of the function for deleting a StorageStreamWriter.
typedef void(*	RTI_RecordingServiceStorageWriter_DeleteParticipantWriterFcn )(void *storage_writer_data, struct RTI_RecordingServiceStorageParticipantWriter *stream_writer)
	Prototype of the function for deleting a StorageParticipantWriter.
typedef void(*	RTI_RecordingServiceStorageWriter_DeletePublicationWriterFcn )(void *storage_writer_data, struct RTI_RecordingServiceStoragePublicationWriter *stream_writer)
	Prototype of the function for deleting a StoragePublicationWriter.
typedef void(*	RTI_RecordingServiceStorageWriter_DeleteSubscriptionWriterFcn )(void *storage_writer_data, struct RTI_RecordingServiceStorageSubscriptionWriter *stream_writer)
	Prototype of the function for deleting a StorageSubscriptionWriter.
typedef void(*	RTI_RecordingServiceStorageWriter_DeleteFcn )(struct RTI_RecordingServiceStorageWriter *storage_writer)
	Prototype of the function for deleting a StorageWriter.
typedef struct RTI_RecordingServiceStorageWriter *(*	RTI_RecordingServiceStorageWriter_CreateFcn )(const struct RTI_RoutingServiceProperties *properties)
	Prototype of the function for creating a StorageWriter.

Detailed Description

RTI Recording Service Pluggable Storage Writer API.

These APIs define a plugin that can be used by RTI Recording Service to store discovery and user data.

You must first define a Storage Writer creation function, implementing the RTI_RecordingServiceStorageWriter_CreateFcn prototype. This function creates a RTI_RecordingServiceStorageWriter, which:

• Receives notifications of discovered streams, including stream names, stream domain IDs, and the data types of each stream.
• Creates and deletes stream writers, which are used by RTI Recording Service to store user data.