Ocean::IO::Compression Class Reference

This class implements individual compression algorithms. More...

#include <Compression.h>

Public Types
using	Buffer = std::vector<uint8_t>
	Definition of a vector holding bytes.

Static Public Member Functions
static bool	gzipCompress (const void *buffer, const size_t bufferSize, Buffer &compressedBuffer)
	Compresses a buffer with gzip.
static bool	gzipDecompress (const void *compressedBuffer, const size_t compressedBufferSize, Buffer &uncompressedBuffer)
	Decompresses a buffer which has been compressed with gzip.

Detailed Description

This class implements individual compression algorithms.

Member Typedef Documentation

Buffer

using Ocean::IO::Compression::Buffer = std::vector<uint8_t>

Definition of a vector holding bytes.

Member Function Documentation

gzipCompress()

bool Ocean::IO::Compression::gzipCompress ( const void * buffer, const size_t bufferSize, Buffer & compressedBuffer )

static

Compresses a buffer with gzip.

Parameters

buffer	The buffer to compress
bufferSize	The size of the buffer, in bytes
compressedBuffer	The compressed buffer

Returns

True, if succeeded

gzipDecompress()

bool Ocean::IO::Compression::gzipDecompress ( const void * compressedBuffer, const size_t compressedBufferSize, Buffer & uncompressedBuffer )

static

Decompresses a buffer which has been compressed with gzip.

Parameters

compressedBuffer	The compressed buffer
compressedBufferSize	The size of the uncompressed buffer, in bytes
uncompressedBuffer	The uncompressed buffer

Returns

True, if succeeded

---

The documentation for this class was generated from the following file:

• Compression.h