Compression.pidl File Reference

#include "tao/OctetSeq.pidl"

Classes
exception	CompressionException
exception	FactoryAlreadyRegistered
exception	UnknownCompressorId
struct	CompressorIdLevel

Typedefs
typedef unsigned short	CompressorId
typedef unsigned short	CompressionLevel
typedef float	CompressionRatio
typedef sequence < CompressorIdLevel >	CompressorIdLevelList
typedef CORBA::OctetSeq	Buffer
typedef sequence < CompressorFactory >	CompressorFactorySeq

Functions
void	decompress (in Buffer source, inout Buffer target) raises (CompressionException)
Compressor	get_compressor (in CompressionLevel compression_level)
void	unregister_factory (in CompressorId compressor_id) raises (UnknownCompressorId)
CompressorFactory	get_factory (in CompressorId compressor_id) raises (UnknownCompressorId)
Compressor	get_compressor (in CompressorId compressor_id, in CompressionLevel compression_level) raises (UnknownCompressorId)
CompressorFactorySeq	get_factories ()

Variables
module	Compression
const CompressorId	COMPRESSORID_NONE = 0
const CompressorId	COMPRESSORID_GZIP = 1
const CompressorId	COMPRESSORID_PKZIP = 2
const CompressorId	COMPRESSORID_BZIP2 = 3
const CompressorId	COMPRESSORID_ZLIB = 4
const CompressorId	COMPRESSORID_LZMA = 5
const CompressorId	COMPRESSORID_LZO = 6
const CompressorId	COMPRESSORID_RZIP = 7
const CompressorId	COMPRESSORID_7X = 8
const CompressorId	COMPRESSORID_XAR = 9
const CompressorId	COMPRESSORID_RLE = 10
local interface	CompressorFactory
local interface	Compressor
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
local interface	CompressionManager

Detailed Description

Id:

Compression.pidl 95512 2012-01-27 09:51:15Z johnnyw

Typedef Documentation

typedef CORBA::OctetSeq Buffer

typedef unsigned short CompressionLevel

CompressionLevel type.

typedef float CompressionRatio

CompressionRatio type.

typedef sequence<CompressorFactory> CompressorFactorySeq

typedef unsigned short CompressorId

CompressorId type.

typedef sequence<CompressorIdLevel> CompressorIdLevelList

Function Documentation

void 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

Compressor get_compressor

(

in CompressionLevel

compression_level

)

Create a Compressor instance with the given compression level.

Compressor get_compressor	(	in CompressorId	compressor_id,
		in CompressionLevel	compression_level
	)		raises (UnknownCompressorId)

Create a Compressor with the given compression_level from the CompressorFactory with the given CompressorId

CompressorFactorySeq get_factories

(

)

Create a Compressor with the given CompressorIdLevel List all registered CompressorFactories

CompressorFactory get_factory

(

in CompressorId

compressor_id

)

raises (UnknownCompressorId)

Retrieve a CompressorFactory with the given CompressorId from the CompressionManager

void unregister_factory

(

in CompressorId

compressor_id

)

raises (UnknownCompressorId)

Unregister a CompressorFactory with the given CompressorId from the CompressionManager

Variable Documentation

readonly attribute unsigned long long 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).

module Compression

Initial value:

{
    typeprefix Compression "omg.org"

readonly attribute CompressionLevel compression_level

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

readonly attribute CompressionRatio 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).

local interface CompressionManager

Initial value:

{
        
        void register_factory(in CompressorFactory compressor_factory) raises(FactoryAlreadyRegistered)

Per-ORB interface to register and unregister CompressorFactories. Initial reference: "CompressionManager"

local interface Compressor

Initial value:

{
        
        void compress(in Buffer source, inout Buffer target) raises (CompressionException)

Compressor - abstraction of a compressor and decompressor.

readonly attribute CompressorFactory compressor_factory

The CompressorFactory associated with this Compressor.

local interface CompressorFactory

Initial value:

{
        
        readonly attribute CompressorId compressor_id

const CompressorId COMPRESSORID_7X = 8

const CompressorId COMPRESSORID_BZIP2 = 3

const CompressorId COMPRESSORID_GZIP = 1

const CompressorId COMPRESSORID_LZMA = 5

const CompressorId COMPRESSORID_LZO = 6

const CompressorId COMPRESSORID_NONE = 0

const CompressorId COMPRESSORID_PKZIP = 2

const CompressorId COMPRESSORID_RLE = 10

const CompressorId COMPRESSORID_RZIP = 7

const CompressorId COMPRESSORID_XAR = 9

const CompressorId COMPRESSORID_ZLIB = 4

readonly attribute unsigned long long 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).