Compression::Compressor Interface Reference

import"Compression.pidl";

Inheritance diagram for Compression::Compressor:

Collaboration diagram for Compression::Compressor:

Public Member Functions
void	compress (in Buffer source, inout Buffer target) raises (CompressionException)
void	decompress (in Buffer source, inout Buffer target) raises (CompressionException)

Public Attributes
readonly attribute CompressorFactory	compressor_factory
readonly attribute CompressionLevel	compression_level
readonly attribute unsigned long long	compressed_bytes
readonly attribute unsigned long long	uncompressed_bytes
readonly attribute CompressionRatio	compression_ratio

Detailed Description

Compressor - abstraction of a compressor and decompressor.

Member Function Documentation

void Compression::Compressor::compress	(	in Buffer	source,
		inout Buffer	target
	)
raises	(	CompressionException
	)

Operation that compresses data contained in the source Buffer into the target Buffer. If an error occurs during the compression, it throws CompressionException

void Compression::Compressor::decompress	(	in Buffer	source,
		inout Buffer	target
	)
raises	(	CompressionException
	)

Operation that decompresses data contained in the source Buffer into the target Buffer. If an error occurs during the decompression, it throws CompressionException

Member Data Documentation

readonly attribute unsigned long long Compression::Compressor::compressed_bytes

The total number of compressed bytes read and written by Compressors that were created by this CompressorFactory (i.e. the "target" side of Compressor::compress and the "source" side of Compressor::decompress operations).

readonly attribute CompressionLevel Compression::Compressor::compression_level

The (implementation and algorithm specific) compression level associated with this Compressor.

readonly attribute CompressionRatio Compression::Compressor::compression_ratio

The average compression achieved by Compressors that were created by this CompressorFactory, usually a value between 0 and >=1. (i.e. compressed_bytes divided by uncompressed_bytes).

readonly attribute CompressorFactory Compression::Compressor::compressor_factory

The CompressorFactory associated with this Compressor.

readonly attribute unsigned long long Compression::Compressor::uncompressed_bytes

The total number of uncompressed bytes read and written by Compressors that were created by this CompressorFactory (i.e. the "source" side of Compressor::compress and the "target" side of Compressor::decompress operations).

---

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

• Compression.pidl