RTI Persistence Service API

This API allows you to embed RTI Persistence Service in your application. More...

Modules
	RTI Persistence Service Version API

Data Structures
struct	RTI_PersistenceService
	RTI Persistence Service. More...
struct	RTI_PersistenceServiceProperty
	Configuration of RTI Persistence Service. More...

Functions
PERSISTENCEDllExport struct RTI_PersistenceService *	RTI_PersistenceService_new (struct RTI_PersistenceServiceProperty *property)
	Create a new RTI Persistence Service instance.
PERSISTENCEDllExport void	RTI_PersistenceService_delete (struct RTI_PersistenceService *self)
	Stop and delete an RTI Persistence Service instance.
PERSISTENCEDllExport DDS_Boolean	RTI_PersistenceService_start (struct RTI_PersistenceService *self)
	Start RTI Persistence Service.
PERSISTENCEDllExport DDS_Boolean	RTI_PersistenceService_stop (struct RTI_PersistenceService *self)
	Stop RTI Persistence Service.
PERSISTENCEDllExport DDS_Boolean	RTI_PersistenceService_initialize_globals ()
	Initialize the RTI Persistence Service globals.
PERSISTENCEDllExport void	RTI_PersistenceService_finalize_globals ()
	Finalize the RTI Persistence Service globals.

Variables
PERSISTENCEDllExport struct RTI_PersistenceServiceProperty	RTI_PersistenceServiceProperty_INITIALIZER
	The initial values for an RTI_PersistenceServiceProperty instance.
PERSISTENCEDllExport const int	RTI_PERSISTENCE_SERVICE_LOG_VERBOSITY_INFO
	Verbosity level: exceptions + warnings + info.
PERSISTENCEDllExport const int	RTI_PERSISTENCE_SERVICE_LOG_VERBOSITY_WARNINGS
	Verbosity level: exceptions + warnings.
PERSISTENCEDllExport const int	RTI_PERSISTENCE_SERVICE_LOG_VERBOSITY_EXCEPTIONS
	Verbosity level: exceptions.
PERSISTENCEDllExport const int	RTI_PERSISTENCE_SERVICE_LOG_VERBOSITY_SILENT
	Verbosity level: silent.

Detailed Description

This API allows you to embed RTI Persistence Service in your application.

The API allows you to create, configure and start RTI Persistence Service instances from your application. The following code shows the typical use of the API:

struct RTI_PersistenceServiceProperty property = RTI_PersistenceServiceProperty_INITIALIZER;
struct RTI_PersistenceService * service = NULL;

property.cfg_file = "my_persistence_service_cfg.xml";
property.cfg_name = "default";
...

service = RTI_PersistenceService_new(&property);
if(service == NULL) {
   printf("Error...");
   return -1;
}

if(!RTI_PersistenceService_start(service)) {
   printf("Error..."); 
   RTI_PersistenceService_delete(service);
   return -1;
}

while(keep_running) {
    sleep();
    ...
}

RTI_PersistenceService_delete(service);

return 0;

Instead of a file, you can use XML strings to configure RTI Persistence Service. See RTI_PersistenceServiceProperty for more information.

To build your application you need to link with the RTI Persistence Service library in $NDDSHOME/lib/<architecture>/

An example is provided in $NDDSHOME/example/C/persistenceServiceLib

Function Documentation

PERSISTENCEDllExport struct RTI_PersistenceService* RTI_PersistenceService_new ( struct RTI_PersistenceServiceProperty *  property )

read

Create a new RTI Persistence Service instance.

Parameters

property

The properties to configure RTI Persistence Service. This parameter is copied internally, so the user is responsible for releasing any memory allocated inside this structure.

PERSISTENCEDllExport void RTI_PersistenceService_delete

(

struct RTI_PersistenceService *

self

)

Stop and delete an RTI Persistence Service instance.

See Also

RTI_PersistenceService_stop

Parameters

self	An RTI_PersistenceService instance created with RTI_PersistenceService_new

PERSISTENCEDllExport DDS_Boolean RTI_PersistenceService_start

(

struct RTI_PersistenceService *

self

)

Start RTI Persistence Service.

This is a non-blocking operation. RTI Persistence Service will create its own set of threads to perform its tasks.

Parameters

self	An RTI_PersistenceService instance created with RTI_PersistenceService_new

PERSISTENCEDllExport DDS_Boolean RTI_PersistenceService_stop

(

struct RTI_PersistenceService *

self

)

Stop RTI Persistence Service.

This function will not return execution control until the instance is fully stopped.

Parameters

self	An RTI_PersistenceService instance created with RTI_PersistenceService_new

PERSISTENCEDllExport DDS_Boolean RTI_PersistenceService_initialize_globals

(

)

Initialize the RTI Persistence Service globals.

This function will initialize Persistence Service globals. This function must be called before creating any Persistence Service instance.

PERSISTENCEDllExport void RTI_PersistenceService_finalize_globals

(

)

Finalize the RTI Persistence Service globals.

This function will finalize Persistence Service globals. This functionm must be called after all the instances of Persistence Service have been deleted.

Variable Documentation

PERSISTENCEDllExport struct RTI_PersistenceServiceProperty RTI_PersistenceServiceProperty_INITIALIZER

The initial values for an RTI_PersistenceServiceProperty instance.

PERSISTENCEDllExport const int RTI_PERSISTENCE_SERVICE_LOG_VERBOSITY_INFO

Verbosity level: exceptions + warnings + info.

PERSISTENCEDllExport const int RTI_PERSISTENCE_SERVICE_LOG_VERBOSITY_WARNINGS

Verbosity level: exceptions + warnings.

PERSISTENCEDllExport const int RTI_PERSISTENCE_SERVICE_LOG_VERBOSITY_EXCEPTIONS

Verbosity level: exceptions.

PERSISTENCEDllExport const int RTI_PERSISTENCE_SERVICE_LOG_VERBOSITY_SILENT

Verbosity level: silent.