Compression Settings

<<extension>> Compression settings that can be applied to data that is sent and received by DataWriters and DataReaders. More...

Data Structures
struct	DDS_CompressionSettings_t
	<<extension>> Settings related to compressing user data. More...

Macros
#define	DDS_COMPRESSION_ID_MASK_NONE   ((DDS_CompressionIdMask) (0))
	<<extension>> DDS_CompressionIdMask used to disable user-data compression for an endpoint. More...
#define	DDS_COMPRESSION_ID_MASK_ALL
	<<extension>> DDS_CompressionIdMask mask with all the suported built-in compression algorithms enabled. More...
#define	DDS_COMPRESSION_LEVEL_BEST_COMPRESSION   (10)
	<<extension>> The best compression ratio possible for a compression algorithm. More...
#define	DDS_COMPRESSION_LEVEL_BEST_SPEED   (1)
	<<extension>> The best compression speed possible for a compression algorithm. More...
#define	DDS_COMPRESSION_LEVEL_DEFAULT   DDS_COMPRESSION_LEVEL_BEST_COMPRESSION
	<<extension>> Default level of compression. More...
#define	DDS_COMPRESSION_THRESHOLD_DEFAULT   8192
	<<extension>> Default threshold from which a serialized sample will be eligible to be compressed. More...
#define	DDS_COMPRESSION_ID_MASK_PUBLICATION_DEFAULT   DDS_COMPRESSION_ID_MASK_NONE
	<<extension>> DDS_CompressionIdMask mask with the default value for publication. More...
#define	DDS_COMPRESSION_ID_MASK_SUBSCRIPTION_DEFAULT
	<<extension>> DDS_CompressionIdMask mask with the default value for subscription. More...

Typedefs
typedef DDS_UnsignedLong	DDS_CompressionId_t
	<<extension>> A four-byte signed integer that identifies a single compression algorithm. More...
typedef DDS_UnsignedLong	DDS_CompressionIdMask
	<<extension>> A four-byte signed integer that identifies a mask of the compression IDs that the algorithms enabled. More...

Variables
const DDS_CompressionId_t	DDS_COMPRESSION_ID_ZLIB
	<<extension>> Corresponds to the ID of the compression algorithm ZLIB. This is the only built-in compression algorithm that is supported when batching is enabled. More...
const DDS_CompressionId_t	DDS_COMPRESSION_ID_BZIP2
	<<extension>> Corresponds to the ID of the compression algorithm BZIP2. More...
const DDS_CompressionId_t	DDS_COMPRESSION_ID_LZ4
	<<extension>> Corresponds to the ID of the compression algorithm LZ4. More...

Detailed Description

<<extension>> Compression settings that can be applied to data that is sent and received by DataWriters and DataReaders.

Macro Definition Documentation

DDS_COMPRESSION_ID_MASK_NONE

#define DDS_COMPRESSION_ID_MASK_NONE   ((DDS_CompressionIdMask) (0))

<<extension>> DDS_CompressionIdMask used to disable user-data compression for an endpoint.

DDS_COMPRESSION_ID_MASK_ALL

#define DDS_COMPRESSION_ID_MASK_ALL

Value:

        ((DDS_CompressionIdMask) \
                (DDS_COMPRESSION_ID_ZLIB_BIT | DDS_COMPRESSION_ID_BZIP2_BIT \
                        | DDS_COMPRESSION_ID_LZ4_BIT))

<<extension>> DDS_CompressionIdMask mask with all the suported built-in compression algorithms enabled.

DDS_COMPRESSION_LEVEL_BEST_COMPRESSION

#define DDS_COMPRESSION_LEVEL_BEST_COMPRESSION   (10)

<<extension>> The best compression ratio possible for a compression algorithm.

See also

DDS_CompressionSettings_t::writer_compression_level

DDS_COMPRESSION_LEVEL_BEST_SPEED

#define DDS_COMPRESSION_LEVEL_BEST_SPEED   (1)

<<extension>> The best compression speed possible for a compression algorithm.

See also

DDS_CompressionSettings_t::writer_compression_level

DDS_COMPRESSION_LEVEL_DEFAULT

#define DDS_COMPRESSION_LEVEL_DEFAULT   DDS_COMPRESSION_LEVEL_BEST_COMPRESSION

<<extension>> Default level of compression.

See also

DDS_CompressionSettings_t::writer_compression_level

DDS_COMPRESSION_THRESHOLD_DEFAULT

#define DDS_COMPRESSION_THRESHOLD_DEFAULT   8192

<<extension>> Default threshold from which a serialized sample will be eligible to be compressed.

See also

DDS_CompressionSettings_t::writer_compression_threshold

This value has been decided after some performance tests, it's a prudent value that will ensure, in most cases with all of the algorithms, that we are going to compress the sample.

DDS_COMPRESSION_ID_MASK_PUBLICATION_DEFAULT

#define DDS_COMPRESSION_ID_MASK_PUBLICATION_DEFAULT   DDS_COMPRESSION_ID_MASK_NONE

<<extension>> DDS_CompressionIdMask mask with the default value for publication.

See also

DDS_CompressionSettings_t::compression_ids

DDS_COMPRESSION_ID_MASK_SUBSCRIPTION_DEFAULT

DDS_COMPRESSION_ID_MASK_SUBSCRIPTION_DEFAULT

#define DDS_COMPRESSION_ID_MASK_SUBSCRIPTION_DEFAULT

Value:

    (DDS_COMPRESSION_ID_ZLIB_BIT | DDS_COMPRESSION_ID_BZIP2_BIT \
        | DDS_COMPRESSION_ID_LZ4_BIT)

<<extension>> DDS_CompressionIdMask mask with the default value for subscription.

See also

DDS_CompressionSettings_t::compression_ids

DDS_COMPRESSION_ID_MASK_PUBLICATION_DEFAULT

Typedef Documentation

DDS_CompressionId_t

typedef DDS_UnsignedLong DDS_CompressionId_t

<<extension>> A four-byte signed integer that identifies a single compression algorithm.

DDS_CompressionIdMask

typedef DDS_UnsignedLong DDS_CompressionIdMask

<<extension>> A four-byte signed integer that identifies a mask of the compression IDs that the algorithms enabled.

Variable Documentation

DDS_COMPRESSION_ID_ZLIB

const DDS_CompressionId_t DDS_COMPRESSION_ID_ZLIB

extern

<<extension>> Corresponds to the ID of the compression algorithm ZLIB. This is the only built-in compression algorithm that is supported when batching is enabled.

DDS_COMPRESSION_ID_BZIP2

const DDS_CompressionId_t DDS_COMPRESSION_ID_BZIP2

extern

<<extension>> Corresponds to the ID of the compression algorithm BZIP2.

DDS_COMPRESSION_ID_LZ4

const DDS_CompressionId_t DDS_COMPRESSION_ID_LZ4

extern

<<extension>> Corresponds to the ID of the compression algorithm LZ4.