io.netty.handler.codec.compression

类 BrotliEncoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

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

io.netty.handler.codec.compression.BrotliEncoder

所有已实现的接口:

ChannelHandler, ChannelOutboundHandler

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

Compress a ByteBuf with the Brotli compression.

See brotli.

嵌套类概要

从接口继承的嵌套类/接口 io.netty.channel.ChannelHandler

ChannelHandler.Sharable

构造器概要

构造器

构造器和说明
BrotliEncoder() Create a new BrotliEncoder Instance with BrotliOptions.DEFAULT and isSharable() set to true
BrotliEncoder(BrotliOptions brotliOptions) Create a new BrotliEncoder Instance
BrotliEncoder(Encoder.Parameters parameters) Create a new BrotliEncoder Instance and isSharable() set to true
BrotliEncoder(Encoder.Parameters parameters, boolean isSharable) Create a new BrotliEncoder Instance and specify whether this instance will be shared with multiple pipelines or not.

方法概要

限定符和类型	方法和说明
protected ByteBuf	allocateBuffer(ChannelHandlerContext ctx, ByteBuf msg, boolean preferDirect) Allocate a ByteBuf which will be used as argument of #encode(ChannelHandlerContext, I, ByteBuf).
void	close(ChannelHandlerContext ctx, ChannelPromise promise) Calls ChannelOutboundInvoker.close(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
protected void	encode(ChannelHandlerContext ctx, ByteBuf msg, ByteBuf out) Encode a message into a ByteBuf.
void	finish(ChannelHandlerContext ctx) Finish the encoding, close streams and write final ByteBuf to the channel.
void	handlerAdded(ChannelHandlerContext ctx) Do nothing by default, sub-classes may override this method.
void	handlerRemoved(ChannelHandlerContext ctx) Do nothing by default, sub-classes may override this method.
boolean	isSharable() Return true if the implementation is Sharable and so can be added to different ChannelPipelines.

从类继承的方法 io.netty.handler.codec.MessageToByteEncoder

acceptOutboundMessage, isPreferDirect, write

从类继承的方法 io.netty.channel.ChannelOutboundHandlerAdapter

bind, connect, deregister, disconnect, flush, read

从类继承的方法 io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, exceptionCaught

从类继承的方法 java.lang.Object

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

从接口继承的方法 io.netty.channel.ChannelHandler

exceptionCaught

构造器详细资料

BrotliEncoder

public BrotliEncoder()

Create a new BrotliEncoder Instance with BrotliOptions.DEFAULT and isSharable() set to true

BrotliEncoder

public BrotliEncoder(BrotliOptions brotliOptions)

Create a new BrotliEncoder Instance

参数:

brotliOptions - BrotliOptions to use and isSharable() set to true

BrotliEncoder

public BrotliEncoder(Encoder.Parameters parameters)

Create a new BrotliEncoder Instance and isSharable() set to true

参数:

parameters - Encoder.Parameters to use

BrotliEncoder

public BrotliEncoder(Encoder.Parameters parameters,
                     boolean isSharable)

Create a new BrotliEncoder Instance and specify whether this instance will be shared with multiple pipelines or not.

If isSharable() is true then on handlerAdded(ChannelHandlerContext) call, a new Writer will create, and it will be mapped using AttributeMap.attr(AttributeKey) so BrotliEncoder can be shared with multiple pipelines. This works fine but there on every encode(ChannelHandlerContext, ByteBuf, ByteBuf) call, we have to get the Writer associated with the appropriate channel. And this will add a overhead. So it is recommended to set isSharable() to false and create new BrotliEncoder instance for every pipeline.

参数:

parameters - Encoder.Parameters to use

isSharable - Set to true if this instance is shared else set to false

方法详细资料

handlerAdded

public void handlerAdded(ChannelHandlerContext ctx)
                  throws java.lang.Exception

从类复制的说明: ChannelHandlerAdapter

Do nothing by default, sub-classes may override this method.

指定者:

handlerAdded 在接口中 ChannelHandler

覆盖:

handlerAdded 在类中 ChannelHandlerAdapter

抛出:

java.lang.Exception

handlerRemoved

public void handlerRemoved(ChannelHandlerContext ctx)
                    throws java.lang.Exception

从类复制的说明: ChannelHandlerAdapter

Do nothing by default, sub-classes may override this method.

指定者:

handlerRemoved 在接口中 ChannelHandler

覆盖:

handlerRemoved 在类中 ChannelHandlerAdapter

抛出:

java.lang.Exception

encode

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

从类复制的说明: MessageToByteEncoder

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

指定者:

encode 在类中 MessageToByteEncoder<ByteBuf>

参数:

ctx - the ChannelHandlerContext which this MessageToByteEncoder belongs to

msg - the message to encode

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

抛出:

java.lang.Exception - is thrown if an error occurs

allocateBuffer

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

从类复制的说明: 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.

覆盖:

allocateBuffer 在类中 MessageToByteEncoder<ByteBuf>

抛出:

java.lang.Exception

isSharable

public boolean isSharable()

从类复制的说明: ChannelHandlerAdapter

Return true if the implementation is Sharable and so can be added to different ChannelPipelines.

覆盖:

isSharable 在类中 ChannelHandlerAdapter

finish

public void finish(ChannelHandlerContext ctx)
            throws java.io.IOException

Finish the encoding, close streams and write final ByteBuf to the channel.

参数:

ctx - ChannelHandlerContext which we want to close

抛出:

java.io.IOException - If an error occurred during closure

close

public void close(ChannelHandlerContext ctx,
                  ChannelPromise promise)
           throws java.lang.Exception

从类复制的说明: ChannelOutboundHandlerAdapter

Calls ChannelOutboundInvoker.close(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

指定者:

close 在接口中 ChannelOutboundHandler

覆盖:

close 在类中 ChannelOutboundHandlerAdapter

参数:

ctx - the ChannelHandlerContext for which the close operation is made

promise - the ChannelPromise to notify once the operation completes

抛出:

java.lang.Exception - thrown if an error occurs