Rti.Dds.Core.Policy.CompressionSettings Class Reference

Configures data compression More...

Inherits IEquatable< CompressionSettings >.

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

Static Public Attributes
const uint	BestCompressionLevel = 10
	Specifies the WriterCompressionLevel with the best compression possible for a compression algorithm. More...
const uint	BestSpeedCompressionLevel = 1
	Specifies the WriterCompressionLevel with the best speed possible for a compression algorithm. More...
const uint	DefaultCompressionLevel = BestCompressionLevel
	The default WriterCompressionLevel. More...
const uint	DefaultCompressionThreshold = 0
	The default WriterCompressionThreshold. More...

Properties
CompressionId	CompressionIds [get]
	Mask that represents the compression algorithms enabled. More...
uint	WriterCompressionLevel [get]
	The level of compression to use when compressing data. More...
int	WriterCompressionThreshold [get]
	The threshold, in bytes, above which a serialized sample will be eligible to be compressed. More...
static CompressionSettings	Default [get]
	Singleton containing the default value of a CompressionSettings More...

Detailed Description

Configures data compression

Member Function Documentation

With()

CompressionSettings Rti.Dds.Core.Policy.CompressionSettings.With ( Action< CompressionSettingsBuilder >  build )

inline

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

Parameters

build

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

Returns

A new CompressionSettings with the changes applied by the Action

GetHashCode()

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

inline

Gets the hash code

Equals() [1/2]

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

(

object

other

)

Compares for equality

Equals() [2/2]

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

inline

Compares for equality

Field Documentation

BestCompressionLevel

const uint Rti.Dds.Core.Policy.CompressionSettings.BestCompressionLevel = 10

static

Specifies the WriterCompressionLevel with the best compression possible for a compression algorithm.

BestSpeedCompressionLevel

const uint Rti.Dds.Core.Policy.CompressionSettings.BestSpeedCompressionLevel = 1

static

Specifies the WriterCompressionLevel with the best speed possible for a compression algorithm.

DefaultCompressionLevel

const uint Rti.Dds.Core.Policy.CompressionSettings.DefaultCompressionLevel = BestCompressionLevel

static

The default WriterCompressionLevel.

DefaultCompressionThreshold

const uint Rti.Dds.Core.Policy.CompressionSettings.DefaultCompressionThreshold = 0

static

The default WriterCompressionThreshold.

Property Documentation

CompressionIds

CompressionId Rti.Dds.Core.Policy.CompressionSettings.CompressionIds

get

Mask that represents the compression algorithms enabled.

The full documentation is available in the C API: DDSCompressionSettings_t_compression_ids

WriterCompressionLevel

uint Rti.Dds.Core.Policy.CompressionSettings.WriterCompressionLevel

get

The level of compression to use when compressing data.

The full documentation is available in the C API: DDSCompressionSettings_t_writer_compression_level

WriterCompressionThreshold

int Rti.Dds.Core.Policy.CompressionSettings.WriterCompressionThreshold

get

The threshold, in bytes, above which a serialized sample will be eligible to be compressed.

The full documentation is available in the C API: DDSCompressionSettings_t_writer_compression_threshold

Default

CompressionSettings Rti.Dds.Core.Policy.CompressionSettings.Default

staticget

Singleton containing the default value of a CompressionSettings