Package org.jgroups.protocols

Class 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).
    Author:
    Bela Ban

    • Field Detail

      • compression_level

        protected int compression_level

      • min_size

        protected int min_size

      • pool_size

        protected int pool_size

      • deflater_pool

        protected java.util.concurrent.BlockingQueue<java.util.zip.Deflater> deflater_pool

      • inflater_pool

        protected java.util.concurrent.BlockingQueue<java.util.zip.Inflater> inflater_pool

      • num_compressions

        protected final java.util.concurrent.atomic.LongAdder num_compressions

      • num_decompressions

        protected final java.util.concurrent.atomic.LongAdder num_decompressions

    • Constructor Detail

      • COMPRESS

        public COMPRESS()

    • Method Detail

      • getMinSize

        public int getMinSize()

      • setMinSize

        public COMPRESS setMinSize​(int s)

      • getNumCompressions

        public long getNumCompressions()

      • getNumUncompressions

        public long getNumUncompressions()

      • init

        public void init()
          throws java.lang.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:
        java.lang.Exception - Thrown if protocol cannot be initialized successfully. This will cause the ProtocolStack to fail, so the the channel constructor will throw an exception

      • down

        public java.lang.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 java.lang.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)