Rti.Dds.Core.Policy.PersistentStorageSettings Class Reference

Configures durable writer history and durable reader state. More...

Inherits IEquatable< PersistentStorageSettings >.

Public Member Functions
PersistentStorageSettings	With (Action< PersistentStorageSettingsBuilder > build)
	Creates a new PersistentStorageSettings with a set of changes specified in an Action More...
override bool	Equals (object other)
	Compares for equality More...
override int	GetHashCode ()
	Gets the hash code More...
bool	Equals (PersistentStorageSettings other)
	Compares for equality More...

Properties
bool	Enable [get]
	Enables durable writer history in a DataWriter and durable reader state in a DataReader. More...
string	FileName [get]
	The file name where the durable writer history or durable reader state will be stored. More...
string	TraceFileName [get]
	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]
	Sets the journal mode of the persistent storage. More...
PersistentSynchronizationKind	SynchronizationKind [get]
	Sets the level of synchronization with the physical disk. More...
bool	Vacuum [get]
	Sets the auto-vacuum status of the storage. More...
bool	Restore [get]
	Indicates if the persisted writer history or reader state must be restored. More...
AllocationSettings	WriterInstanceCacheAllocation [get]
	Configures the resource limits associated with the instance durable writer history cache. More...
AllocationSettings	WriterSampleCacheAllocation [get]
	Configures the resource limits associated with the sample durable writer history cache. More...
bool	WriterMemoryState [get]
	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]
	Controls how often the reader state is stored into the database. More...
static PersistentStorageSettings	Default [get]
	Singleton containing the default value of a PersistentStorageSettings More...

Detailed Description

Configures durable writer history and durable reader state.

The full documentation is available in the C API: DDS_PersistentStorageSettings

Member Function Documentation

With()

PersistentStorageSettings Rti.Dds.Core.Policy.PersistentStorageSettings.With ( Action< PersistentStorageSettingsBuilder >  build )

inline

Creates a new PersistentStorageSettings with a set of changes specified in an Action

Parameters

build

An Action (typically a lambda function) that receives a modifiable object with the values of this PersistentStorageSettings

Returns

A new PersistentStorageSettings with the changes applied by the Action

Equals() [1/2]

override bool Rti.Dds.Core.Policy.PersistentStorageSettings.Equals

(

object

other

)

Compares for equality

GetHashCode()

override int Rti.Dds.Core.Policy.PersistentStorageSettings.GetHashCode ( )

inline

Gets the hash code

Equals() [2/2]

bool Rti.Dds.Core.Policy.PersistentStorageSettings.Equals ( PersistentStorageSettings  other )

inline

Compares for equality

Property Documentation

Enable

bool Rti.Dds.Core.Policy.PersistentStorageSettings.Enable

get

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.PersistentStorageSettings.FileName

get

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.PersistentStorageSettings.TraceFileName

get

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.PersistentStorageSettings.JournalKind

get

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.PersistentStorageSettings.SynchronizationKind

get

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.PersistentStorageSettings.Vacuum

get

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.PersistentStorageSettings.Restore

get

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

AllocationSettings Rti.Dds.Core.Policy.PersistentStorageSettings.WriterInstanceCacheAllocation

get

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

AllocationSettings Rti.Dds.Core.Policy.PersistentStorageSettings.WriterSampleCacheAllocation

get

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.PersistentStorageSettings.WriterMemoryState

get

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.PersistentStorageSettings.ReaderCheckpointFrequency

get

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

Default

PersistentStorageSettings Rti.Dds.Core.Policy.PersistentStorageSettings.Default

staticget

Singleton containing the default value of a PersistentStorageSettings