RTI Connext C# API Version 7.2.0
Rti.Dds.Core.Policy.PersistentStorageSettingsBuilder Class Reference

A modifiable type used to create an immutable PersistentStorageSettings. More...

Public Member Functions

 PersistentStorageSettingsBuilder (PersistentStorageSettings data)
 Creates a builder with the values of an existing immutable instance More...
 
PersistentStorageSettings Build ()
 Creates a immutable object (PersistentStorageSettings) from this one More...
 

Properties

bool Enable [get, set]
 Enables durable writer history in a DataWriter and durable reader state in a DataReader. More...
 
string FileName [get, set]
 The file name where the durable writer history or durable reader state will be stored. More...
 
string TraceFileName [get, set]
 The file name where to store the SQL statements executed when loading and storing the durable writer history or durable reader state. More...
 
PersistentJournalKind JournalKind [get, set]
 Sets the journal mode of the persistent storage. More...
 
PersistentSynchronizationKind SynchronizationKind [get, set]
 Sets the level of synchronization with the physical disk. More...
 
bool Vacuum [get, set]
 Sets the auto-vacuum status of the storage. More...
 
bool Restore [get, set]
 Indicates if the persisted writer history or reader state must be restored. More...
 
AllocationSettingsBuilder WriterInstanceCacheAllocation [get, set]
 Configures the resource limits associated with the instance durable writer history cache. More...
 
AllocationSettingsBuilder WriterSampleCacheAllocation [get, set]
 Configures the resource limits associated with the sample durable writer history cache. More...
 
bool WriterMemoryState [get, set]
 Determines how much state will be kept in memory by the durable writer history in order to avoid accessing the persistent storage in disk. More...
 
uint ReaderCheckpointFrequency [get, set]
 Controls how often the reader state is stored into the database. More...
 

Detailed Description

A modifiable type used to create an immutable PersistentStorageSettings.

Constructor & Destructor Documentation

◆ PersistentStorageSettingsBuilder()

Rti.Dds.Core.Policy.PersistentStorageSettingsBuilder.PersistentStorageSettingsBuilder ( PersistentStorageSettings  data)
inline

Creates a builder with the values of an existing immutable instance

Member Function Documentation

◆ Build()

PersistentStorageSettings Rti.Dds.Core.Policy.PersistentStorageSettingsBuilder.Build ( )

Creates a immutable object (PersistentStorageSettings) from this one

Property Documentation

◆ Enable

bool Rti.Dds.Core.Policy.PersistentStorageSettingsBuilder.Enable
getset

Enables durable writer history in a DataWriter and durable reader state in a DataReader.

The full documentation is available in the C API: DDS_PersistentStorageSettings_enable

◆ FileName

string Rti.Dds.Core.Policy.PersistentStorageSettingsBuilder.FileName
getset

The file name where the durable writer history or durable reader state will be stored.

The full documentation is available in the C API: DDS_PersistentStorageSettings_file_name

◆ TraceFileName

string Rti.Dds.Core.Policy.PersistentStorageSettingsBuilder.TraceFileName
getset

The file name where to store the SQL statements executed when loading and storing the durable writer history or durable reader state.

The full documentation is available in the C API: DDS_PersistentStorageSettings_trace_file_name

◆ JournalKind

PersistentJournalKind Rti.Dds.Core.Policy.PersistentStorageSettingsBuilder.JournalKind
getset

Sets the journal mode of the persistent storage.

The full documentation is available in the C API: DDS_PersistentStorageSettings_journal_kind

◆ SynchronizationKind

PersistentSynchronizationKind Rti.Dds.Core.Policy.PersistentStorageSettingsBuilder.SynchronizationKind
getset

Sets the level of synchronization with the physical disk.

The full documentation is available in the C API: DDS_PersistentStorageSettings_synchronization_kind

◆ Vacuum

bool Rti.Dds.Core.Policy.PersistentStorageSettingsBuilder.Vacuum
getset

Sets the auto-vacuum status of the storage.

The full documentation is available in the C API: DDS_PersistentStorageSettings_vacuum

◆ Restore

bool Rti.Dds.Core.Policy.PersistentStorageSettingsBuilder.Restore
getset

Indicates if the persisted writer history or reader state must be restored.

The full documentation is available in the C API: DDS_PersistentStorageSettings_restore

◆ WriterInstanceCacheAllocation

AllocationSettingsBuilder Rti.Dds.Core.Policy.PersistentStorageSettingsBuilder.WriterInstanceCacheAllocation
getset

Configures the resource limits associated with the instance durable writer history cache.

The full documentation is available in the C API: DDS_PersistentStorageSettings_writer_instance_cache_allocation

◆ WriterSampleCacheAllocation

AllocationSettingsBuilder Rti.Dds.Core.Policy.PersistentStorageSettingsBuilder.WriterSampleCacheAllocation
getset

Configures the resource limits associated with the sample durable writer history cache.

The full documentation is available in the C API: DDS_PersistentStorageSettings_writer_sample_cache_allocation

◆ WriterMemoryState

bool Rti.Dds.Core.Policy.PersistentStorageSettingsBuilder.WriterMemoryState
getset

Determines how much state will be kept in memory by the durable writer history in order to avoid accessing the persistent storage in disk.

The full documentation is available in the C API: DDS_PersistentStorageSettings_writer_memory_state

◆ ReaderCheckpointFrequency

uint Rti.Dds.Core.Policy.PersistentStorageSettingsBuilder.ReaderCheckpointFrequency
getset

Controls how often the reader state is stored into the database.

The full documentation is available in the C API: DDS_PersistentStorageSettings_reader_checkpoint_frequency