io.netty.handler.codec.compression

Class BrotliEncoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

io.netty.handler.codec.MessageToByteEncoder<ByteBuf>

io.netty.handler.codec.compression.BrotliEncoder

All Implemented Interfaces:

ChannelHandler, ChannelOutboundHandler

@ChannelHandler.Sharable
public final class BrotliEncoder
extends MessageToByteEncoder<ByteBuf>

Compress a ByteBuf with the brotli format. See brotli.

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
BrotliEncoder() Create a new BrotliEncoder Instance with Encoder.Parameters#setQuality(int) set to 4 and Encoder.Parameters#setMode(Encoder.Mode) set to Encoder.Mode#TEXT
BrotliEncoder(Encoder.Parameters parameters) Create a new BrotliEncoder Instance

Method Summary

Modifier and Type	Method and Description
protected ByteBuf	allocateBuffer(ChannelHandlerContext ctx, ByteBuf msg, boolean preferDirect) Allocate a ByteBuf which will be used as argument of #encode(ChannelHandlerContext, I, ByteBuf).
protected void	encode(ChannelHandlerContext ctx, ByteBuf msg, ByteBuf out) Encode a message into a ByteBuf.

Methods inherited from class io.netty.handler.codec.MessageToByteEncoder

acceptOutboundMessage, isPreferDirect, write

Methods inherited from class io.netty.channel.ChannelOutboundHandlerAdapter

bind, close, connect, deregister, disconnect, flush, read

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, exceptionCaught, handlerAdded, handlerRemoved, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelHandler

exceptionCaught, handlerAdded, handlerRemoved

Constructor Detail

BrotliEncoder

public BrotliEncoder()

Create a new BrotliEncoder Instance with Encoder.Parameters#setQuality(int) set to 4 and Encoder.Parameters#setMode(Encoder.Mode) set to Encoder.Mode#TEXT

BrotliEncoder

public BrotliEncoder(Encoder.Parameters parameters)

Create a new BrotliEncoder Instance

Parameters:

parameters - Encoder.Parameters Instance

Method Detail

encode

protected void encode(ChannelHandlerContext ctx,
                      ByteBuf msg,
                      ByteBuf out)
               throws Exception

Description copied from class: MessageToByteEncoder

Encode a message into a ByteBuf. This method will be called for each written message that can be handled by this encoder.

Specified by:

encode in class MessageToByteEncoder<ByteBuf>

Parameters:

ctx - the ChannelHandlerContext which this MessageToByteEncoder belongs to

msg - the message to encode

out - the ByteBuf into which the encoded message will be written

Throws:

Exception - is thrown if an error occurs

allocateBuffer

protected ByteBuf allocateBuffer(ChannelHandlerContext ctx,
                                 ByteBuf msg,
                                 boolean preferDirect)
                          throws Exception

Description copied from class: MessageToByteEncoder

Allocate a ByteBuf which will be used as argument of #encode(ChannelHandlerContext, I, ByteBuf). Sub-classes may override this method to return ByteBuf with a perfect matching initialCapacity.

Overrides:

allocateBuffer in class MessageToByteEncoder<ByteBuf>

Throws:

Exception