Package org.jgroups.protocols

Class COMPRESS

java.lang.Object

org.jgroups.stack.Protocol

org.jgroups.protocols.COMPRESS

All Implemented Interfaces:

Lifecycle

public class COMPRESS
extends Protocol

Compresses the payload of a message. Goal is to reduce the number of messages sent across the wire. Should ideally be layered somewhere above a fragmentation protocol (e.g. FRAG).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	COMPRESS.CompressHeader

Field Summary

Fields

Modifier and Type	Field	Description
protected int	compression_level
protected BlockingQueue<Deflater>	deflater_pool
protected BlockingQueue<Inflater>	inflater_pool
protected int	min_size
protected MessageFactory	msg_factory
protected final LongAdder	num_compressions
protected final LongAdder	num_decompressions
protected int	pool_size

Fields inherited from class org.jgroups.stack.Protocol

after_creation_hook, down_prot, ergonomics, id, local_addr, log, policies, stack, stats, up_prot

Constructor Summary

Constructors

Constructor	Description
COMPRESS()

Method Summary

Modifier and Type	Method	Description
void	destroy()	This method is called on a JChannel.close().
Object	down(Message msg)	We compress the payload if it is larger than min_size.
int	getMinSize()
long	getNumCompressions()
long	getNumUncompressions()
void	init()	Called after a protocol has been created and before the protocol is started.
protected static Message	messageFromByteArray(byte[] uncompressed_payload, MessageFactory msg_factory)
protected static ByteArray	messageToByteArray(Message msg)
void	resetStats()
COMPRESS	setMinSize(int s)
protected Message	uncompress(Message msg, int original_size, boolean needs_deserialization)	Returns a new message as a result of uncompressing msg, or null if msg couldn't be uncompressed
Object	up(Message msg)	If there is no header, we pass the message up.
void	up(MessageBatch batch)	Sends up a multiple messages in a MessageBatch.

Methods inherited from class org.jgroups.stack.Protocol

accept, addPolicy, addr, addr, afterCreationHook, down, down, enableStats, getAddress, getComponents, getDownProtocol, getDownServices, getId, getIdsAbove, getLevel, getLog, getName, getPolicies, getProtocolStack, getSocketFactory, getThreadFactory, getTransport, getUpProtocol, getUpServices, getValue, isErgonomics, level, parse, policies, providedDownServices, providedUpServices, removePolicy, requiredDownServices, requiredUpServices, resetStatistics, setAddress, setDownProtocol, setErgonomics, setId, setLevel, setPolicies, setProtocolStack, setSocketFactory, setUpProtocol, setValue, start, statsEnabled, stop, toString, up

Methods inherited from class java.lang.Object

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

Field Details

compression_level

protected int compression_level

min_size

protected int min_size

pool_size

protected int pool_size

deflater_pool

protected BlockingQueue<Deflater> deflater_pool

inflater_pool

protected BlockingQueue<Inflater> inflater_pool

msg_factory

protected MessageFactory msg_factory

num_compressions

protected final LongAdder num_compressions

num_decompressions

protected final LongAdder num_decompressions

Constructor Details

COMPRESS

public COMPRESS()

Method Details

getMinSize

public int getMinSize()

setMinSize

public COMPRESS setMinSize(int s)

getNumCompressions

public long getNumCompressions()

getNumUncompressions

public long getNumUncompressions()

resetStats

public void resetStats()

Overrides:

resetStats in class Protocol

init

public void init()
          throws Exception

Description copied from class: Protocol

Called after a protocol has been created and before the protocol is started. Attributes are already set. Other protocols are not yet connected and events cannot yet be sent.

Specified by:

init in interface Lifecycle

Overrides:

init in class Protocol

Throws:

Exception - Thrown if protocol cannot be initialized successfully. This will cause the ProtocolStack to fail, so the the channel constructor will throw an exception

destroy

public void destroy()

Description copied from class: Protocol

This method is called on a JChannel.close(). Does some cleanup; after the call, the VM will terminate

Specified by:

destroy in interface Lifecycle

Overrides:

destroy in class Protocol

down

public Object down(Message msg)

We compress the payload if it is larger than min_size. In this case we add a header containing the original size before compression. Otherwise we add no header.

Note that we compress either the entire buffer (if offset/length are not used), or a subset (if offset/length are used)

Overrides:

down in class Protocol

up

public Object up(Message msg)

If there is no header, we pass the message up. Otherwise we uncompress the payload to its original size.

Overrides:

up in class Protocol

up

public void up(MessageBatch batch)

Description copied from class: Protocol

Sends up a multiple messages in a MessageBatch. The sender of the batch is always the same, and so is the destination (null == multicast messages). Messages in a batch can be OOB messages, regular messages, or mixed messages, although the transport itself will create initial MessageBatches that contain only either OOB or regular messages.

The default processing below sends messages up the stack individually, based on a matching criteria (calling Protocol.accept(Message)), and - if true - calls Protocol.up(org.jgroups.Event) for that message and removes the message. If the batch is not empty, it is passed up, or else it is dropped.

Subclasses should check if there are any messages destined for them (e.g. using MessageBatch.iterator(Predicate)), then possibly remove and process them and finally pass the batch up to the next protocol. Protocols can also modify messages in place, e.g. ENCRYPT could decrypt all encrypted messages in the batch, not remove them, and pass the batch up when done.

Overrides:

up in class Protocol

Parameters:

batch - The message batch

uncompress

protected Message uncompress(Message msg,
 int original_size,
 boolean needs_deserialization)

Returns a new message as a result of uncompressing msg, or null if msg couldn't be uncompressed

messageToByteArray

protected static ByteArray messageToByteArray(Message msg)

messageFromByteArray

protected static Message messageFromByteArray(byte[] uncompressed_payload,
 MessageFactory msg_factory)