de.carne.nio.compression

Class Compression

java.lang.Object

de.carne.nio.compression.Compression

Direct Known Subclasses:

Decoder, Encoder

public abstract class Compression
extends java.lang.Object

Basic interface for compression engines.

Constructor Summary

Constructors

Constructor and Description
Compression()

Method Summary

Modifier and Type	Method and Description
protected long	beginProcessing() Record the start time every time engine processing begins.
protected void	endProcessing(long beginTime, long in, long out) Record the processing time and input/ouput bytes time every time engine processing ends.
abstract java.lang.String	name() Get the compression name.
long	processingTime() Get the time (in milliseconds) spent in this engine since it's creation respectively the last call to reset().
long	rateIn() Get the input processing rate (in bytes per second) of this engine based upon the consumed bytes totalIn() and the processing time processingTime().
long	rateOut() Get the output processing rate (in bytes per second) of this engine based upon the emitted bytes totalOut() and the processing time processingTime().
void	reset() Reset the compression engine to it's initial state.
long	totalIn() Get the number of bytes consumed by this engine since it's creation respectively the last call to reset().
long	totalOut() Get the number of bytes emitted by this engine since it's creation respectively the last call to reset().

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Compression

public Compression()

Method Detail

name

public abstract java.lang.String name()

Get the compression name.

Returns:

The he compression name.

reset

public void reset()

Reset the compression engine to it's initial state.

processingTime

public final long processingTime()

Get the time (in milliseconds) spent in this engine since it's creation respectively the last call to reset().

Returns:

The time (in milliseconds) spent in this engine since the last call to reset().

totalIn

public final long totalIn()

Get the number of bytes consumed by this engine since it's creation respectively the last call to reset().

Returns:

The number of bytes consumed by this engine since the last call to reset().

rateIn

public final long rateIn()

Get the input processing rate (in bytes per second) of this engine based upon the consumed bytes totalIn() and the processing time processingTime().

Returns:

The input processing rate.

totalOut

public final long totalOut()

Get the number of bytes emitted by this engine since it's creation respectively the last call to reset().

Returns:

The number of bytes emitted by this engine since the last call to reset().

rateOut

public final long rateOut()

Get the output processing rate (in bytes per second) of this engine based upon the emitted bytes totalOut() and the processing time processingTime().

Returns:

The output processing rate.

beginProcessing

protected final long beginProcessing()

Record the start time every time engine processing begins.

Derived class have to call this function to make sure engine statistics are properly tracked.

Returns:

The recorded start time, which should be submitted to the endProcessing(long, long, long) call when engine processing ends.

endProcessing

protected final void endProcessing(long beginTime,
                                   long in,
                                   long out)

Record the processing time and input/ouput bytes time every time engine processing ends.

Derived class have to call this function to make sure engine statistics are properly tracked.

Parameters:

beginTime - The begin time as returned by beginProcessing().

in - The number of consumed bytes.

out - The number of emitted bytes.