org.apache.cassandra.transport.frame.compress

Class CompressingTransformer

java.lang.Object

org.apache.cassandra.transport.frame.compress.CompressingTransformer

All Implemented Interfaces:

FrameBodyTransformer

public abstract class CompressingTransformer
extends java.lang.Object
implements FrameBodyTransformer

Method Summary

Modifier and Type	Method and Description
java.util.EnumSet<Frame.Header.Flag>	getOutboundHeaderFlags() Returns an EnumSet of the flags that should be added to the header for any message whose frame body has been modified by the transformer.
static CompressingTransformer	getTransformer(Compressor compressor)
io.netty.buffer.ByteBuf	transformInbound(io.netty.buffer.ByteBuf inputBuf, java.util.EnumSet<Frame.Header.Flag> flags) Accepts the input buffer representing the frame body of an incoming message and applies a transformation.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.cassandra.transport.frame.FrameBodyTransformer

transformOutbound

Method Detail

getTransformer

public static final CompressingTransformer getTransformer(Compressor compressor)

getOutboundHeaderFlags

public java.util.EnumSet<Frame.Header.Flag> getOutboundHeaderFlags()

Description copied from interface: FrameBodyTransformer

Returns an EnumSet of the flags that should be added to the header for any message whose frame body has been modified by the transformer. E.g. it may add perform chunking & checksumming to the frame body, compress it, or both.

Specified by:

getOutboundHeaderFlags in interface FrameBodyTransformer

Returns:

EnumSet containing the header flags to set on messages transformed

transformInbound

public io.netty.buffer.ByteBuf transformInbound(io.netty.buffer.ByteBuf inputBuf,
                                                java.util.EnumSet<Frame.Header.Flag> flags)
                                         throws java.io.IOException

Description copied from interface: FrameBodyTransformer

Accepts the input buffer representing the frame body of an incoming message and applies a transformation. Example transformations include decompression and recombining checksummed chunks into a single, serialized message body.

Specified by:

transformInbound in interface FrameBodyTransformer

Parameters:

inputBuf - the frame body from an inbound message

Returns:

the new frame body bytes

Throws:

java.io.IOException - if the transformation failed for any reason