org.apache.cassandra.transport.frame

Interface FrameBodyTransformer

All Known Implementing Classes:

ChecksummingTransformer, CompressingTransformer

public interface 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.
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.
io.netty.buffer.ByteBuf	transformOutbound(io.netty.buffer.ByteBuf inputBuf) Accepts an input buffer representing the frame body of an outbound message and applies a transformation.

Method Detail

transformInbound

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

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.

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

transformOutbound

io.netty.buffer.ByteBuf transformOutbound(io.netty.buffer.ByteBuf inputBuf)
                                   throws java.io.IOException

Accepts an input buffer representing the frame body of an outbound message and applies a transformation. Example transformations include compression and splitting into checksummed chunks.

Parameters:

inputBuf - the frame body from an outgoing message

Returns:

the new frame body bytes

Throws:

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

getOutboundHeaderFlags

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. E.g. it may add perform chunking & checksumming to the frame body, compress it, or both.

Returns:

EnumSet containing the header flags to set on messages transformed