|
RTI Connext C API
Version 6.0.1
|
|
RTI Connext C API
Version 6.0.1
|
APIs related to RTI Connext Durability and Persistence. More...
APIs related to RTI Connext Durability and Persistence.
RTI Connext offers the following mechanisms for achieving durability and persistence:
To use the first two features, you need a relational database, which is not included with RTI Connext. Supported databases are listed in the Release Notes.
The third feature, provided by RTI Persistence Service, can use the filesystem or a relational database to persist information.
These three features can be used separately or in combination.
This feature allows a DDS_DataWriter to locally persist its local history cache so that it can survive shutdowns, crashes and restarts. When an application restarts, each DDS_DataWriter that has been configured to have durable writer history automatically loads all the data in its history cache from disk and can carry on sending data as if it had never stopped executing. To the rest of the system, it will appear as if the DDS_DataWriter had been temporarily disconnected from the network and then reappeared.
This feature allows a DDS_DataReader to locally persists its state and remember the sequence numbers it has already received. When an application restarts, each DDS_DataReader that has been configured to have durable reader state automatically loads its state from disk and can carry on receiving data as if it had never stopped executing. Data that had already been received by the DDS_DataReader before the restart will will not be provided to the application again.
This feature is a full implementation of the OMG DDS Persistence Profile. The DURABILITY QoS lets an application configure a DDS_DataWriter such that the information written by the DDS_DataWriter survives beyond the lifetime of the DDS_DataWriter. In this manner, a late-joining DDS_DataReader can subscribe and receive the information even after the DDS_DataWriter application is no longer executing. To use this feature, you need RTI Persistence Service – an optional product that can be purchased separately.
Every modification to the global dataspace made by a DDS_DataWriter is identified by a pair (virtual GUID, sequence number).
Several DDS_DataWriter entities can be configured with the same virtual GUID. If each of these DDS_DataWriter entities publishes a sample with sequence number '0', the sample will only be received once by the DDS_DataReader entities subscribing to the content published by the DDS_DataWriter entities.
RTI Connext also uses the virtual GUID (Global Unique Identifier) to associate a persisted state (state in permanent storage) to the corresponding DDS entity.
For example, the history of a DDS_DataWriter will be persisted in a database table with a name generated from the virtual GUID of the DDS_DataWriter. If the DDS_DataWriter is restarted, it must have associated the same virtual GUID to restore its previous history.
Likewise, the state of a DDS_DataReader will be persisted in a database table whose name is generated from the DDS_DataReader virtual GUID
A DDS_DataWriter's virtual GUID can be configured using DDS_DataWriterProtocolQosPolicy::virtual_guid. Similarly, a DDS_DataReader's virtual GUID can be configured using DDS_DataReaderProtocolQosPolicy::virtual_guid.
The DDS_PublicationBuiltinTopicData and DDS_SubscriptionBuiltinTopicData structures include the virtual GUID associated with the discovered publication or subscription.
Refer to the User's Manual for additional use cases.
To configure a DDS_DataWriter to have durable writer history, use the PROPERTY QoS policy associated with the DDS_DataWriter or the DDS_DomainParticipant.
Properties defined for the DDS_DomainParticipant will be applied to all the DDS_DataWriter objects belonging to the DDS_DomainParticipant, unless the property is overwritten by the DDS_DataWriter.
The following table lists the supported durable writer history properties.
| Property | Description |
|---|---|
| dds.data_writer.history.plugin_name | Must be set to "dds.data_writer.history.odbc_plugin.builtin" to enable durable writer history in the DataWriter. This property is required. |
| dds.data_writer.history.odbc_plugin.dsn | The ODBC DSN (Data Source Name) associated with the database where the writer history must be persisted. This property is required. |
| dds.data_writer.history.odbc_plugin.driver | This property tells RTI Connext which ODBC driver to load. If the property is not specified, RTI Connext will try to use the standard ODBC driver manager library: UnixOdbc (odbc32.dll) on UNIX/Linux systems; the Windows ODBC driver manager (libodbc.so) on Windows systems). |
| dds.data_writer.history.odbc_plugin.username | Configures the username used to connect to the database. This property is not used if it is unspecified. There is no default value. |
| dds.data_writer.history.odbc_plugin.password | Configures the password used to connect to the database. This property is not used if it is unspecified. There is no default value. |
| dds.data_writer.history.odbc_plugin.shared | If set to 1, RTI Connext creates a single connection per DSN that will be shared across DataWriters within the same Publisher. If set to 0 (the default), a DDS_DataWriter will create its own database connection. Default: 0 (false) </TD> |
| dds.data_writer.history.odbc_plugin.instance_cache_max_size | These properties configure the resource limits associated with the ODBC writer history caches. To minimize the number of accesses to the database, RTI Connext uses two caches, one for samples and one for instances. The initial and maximum sizes of these caches are configured using these properties. The resource limits initial_instances, max_instances, initial_samples, max_samples and max_samples_per_instance in the DDS_ResourceLimitsQosPolicy are used to configure the maximum number of samples and instances that can be stored in the relational database. Default: DDS_ResourceLimitsQosPolicy::max_instances |
| dds.data_writer.history.odbc_plugin.instance_cache_init_size | See description above. Default: DDS_ResourceLimitsQosPolicy::initial_instances |
| dds.data_writer.history.odbc_plugin.sample_cache_max_size | See description above. Default: 32 (the minimum) |
| dds.data_writer.history.odbc_plugin.sample_cache_init_size | See description above. Default: 32 |
| dds.data_writer.history.odbc_plugin.restore | This property indicates whether or not the persisted writer history must be restored once the DDS_DataWriter is restarted. If the value is 0, the content of the database associated with the DDS_DataWriter being restarted will be deleted. If the value is 1, the DDS_DataWriter will restore its previous state from the database content. Default: 1 |
| dds.data_writer.history.odbc_plugin.in_memory_state | This property determines how much state will be kept in memory by the ODBC writer history in order to avoid accessing the database. When in_memory_state is equal to 1, instance_cache_max_size is always equal to DDS_ResourceLimitsQosPolicy::max_instances (it cannot be changed). In addition, the ODBC writer history will keep in memory a fixed state overhead of 24 bytes per sample. In this operating mode, the ODBC writer history provides the best performance. However, the restore operation will be slower and the maximum number of samples that the writer history can manage will be limited by the available physical memory. If in_memory_state is equal to 0, all the state will be kept in the underlying database. In this operating mode, the maximum number of samples in the writer history will not be limited by the physical memory available unless the underlying database is an in-memory database (TimesTen). Default: 1 |
To configure a DDS_DataReader with durable reader state, use the PROPERTY QoS policy associated with the DDS_DataReader or DDS_DomainParticipant.
A property defined in the DDS_DomainParticipant will be applicable to all the DDS_DataReader belonging to the DDS_DomainParticipant unless it is overwritten by the DDS_DataReader.
The following table lists the supported durable reader state properties.
| Property | Description |
|---|---|
| dds.data_reader.state.odbc.dsn | The ODBC DSN (Data Source Name) associated with the database where the DDS_DataReader state must be persisted. This property is required. |
| dds.data_reader.state.filter_redundant_samples | To enable durable reader state, this property must be set to 1. Otherwise, the reader state will not be kept and/or persisted. When the reader state is not maintained, RTI Connext does not filter duplicate samples that may be coming from the same virtual writer. By default, this property is set to 1. |
| dds.data_reader.state.odbc.driver | This property is used to indicate which ODBC driver to load. If the property is not specified, RTI Connext will try to use the standard ODBC driver manager library: UnixOdbc (odbc32.dll) on UNIX/Linux systems; the Windows ODBC driver manager (libodbc.so) on Windows systems). |
| dds.data_reader.state.odbc.username | This property configures the username used to connect to the database. This property is not used if it is unspecified. There is no default value. |
| dds.data_reader.state.odbc.password | This property configures the password used to connect to the database. This property is not used if it is unspecified. There is no default value. |
| dds.data_reader.state.restore | This property indicates if the persisted DDS_DataReader state must be restored or not once the DDS_DataReader is restarted. If this property is 0, the previous state will be deleted from the database. If it is 1, the DDS_DataReader will restore its previous state from the database content. Default: 1 |
| dds.data_reader.state.checkpoint_frequency | This property controls how often the reader state is stored in the database. A value of N means to store the state once every N samples. A high frequency will provide better performance. However, if the reader is restarted it may receive some duplicate samples. These samples will be filtered by the middleware and they will not be propagated to the application. Default: 1 |
| dds.data_reader.state.persistence_service.request_depth | This property indicates the number of most recent historical samples that the persisted DDS_DataReader wants to receive when it starts up. Default: 0 |
RTI Connext implements DDS_TRANSIENT_DURABILITY_QOS and DDS_PERSISTENT_DURABILITY_QOS durability using RTI Persistence Service, available for purchase as a separate RTI product.
For more information on RTI Persistence Service, refer to the User's Manual, or the RTI Persistence Service API Reference HTML documentation.
RTI Connext C API Version 6.0.1
Copyright © Sat Nov 23 2019
Real-Time Innovations, Inc
