io.netty.handler.codec.http

类 HttpContentEncoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelDuplexHandler

io.netty.handler.codec.MessageToMessageCodec<HttpRequest,HttpObject>

io.netty.handler.codec.http.HttpContentEncoder

所有已实现的接口:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler

直接已知子类:

HttpContentCompressor

public abstract class HttpContentEncoder
extends MessageToMessageCodec<HttpRequest,HttpObject>

Encodes the content of the outbound HttpResponse and HttpContent. The original content is replaced with the new content encoded by the EmbeddedChannel, which is created by beginEncode(HttpResponse, String). Once encoding is finished, the value of the 'Content-Encoding' header is set to the target content encoding, as returned by beginEncode(HttpResponse, String). Also, the 'Content-Length' header is updated to the length of the encoded content. If there is no supported or allowed encoding in the corresponding HttpRequest's "Accept-Encoding" header, beginEncode(HttpResponse, String) should return null so that no encoding occurs (i.e. pass-through).

Please note that this is an abstract class. You have to extend this class and implement beginEncode(HttpResponse, String) properly to make this class functional. For example, refer to the source code of HttpContentCompressor.

This handler must be placed after HttpObjectEncoder in the pipeline so that this handler can intercept HTTP responses before HttpObjectEncoder converts them into ByteBufs.

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	HttpContentEncoder.Result

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

ChannelHandler.Sharable

构造器概要

构造器

构造器和说明
HttpContentEncoder()

方法概要

限定符和类型	方法和说明
boolean	acceptOutboundMessage(java.lang.Object msg) Returns true if and only if the specified message can be encoded by this codec.
protected abstract HttpContentEncoder.Result	beginEncode(HttpResponse httpResponse, java.lang.String acceptEncoding) Prepare to encode the HTTP message content.
void	channelInactive(ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
protected void	decode(ChannelHandlerContext ctx, HttpRequest msg, java.util.List<java.lang.Object> out)
protected void	encode(ChannelHandlerContext ctx, HttpObject msg, java.util.List<java.lang.Object> out)
void	handlerRemoved(ChannelHandlerContext ctx) Do nothing by default, sub-classes may override this method.

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

acceptInboundMessage, channelRead, write

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

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

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

channelActive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

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

ensureNotSharable, handlerAdded, isSharable

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

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

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

exceptionCaught, handlerAdded

构造器详细资料

HttpContentEncoder

public HttpContentEncoder()

方法详细资料

acceptOutboundMessage

public boolean acceptOutboundMessage(java.lang.Object msg)
                              throws java.lang.Exception

从类复制的说明: MessageToMessageCodec

Returns true if and only if the specified message can be encoded by this codec.

覆盖:

acceptOutboundMessage 在类中 MessageToMessageCodec<HttpRequest,HttpObject>

参数:

msg - the message

抛出:

java.lang.Exception

decode

protected void decode(ChannelHandlerContext ctx,
                      HttpRequest msg,
                      java.util.List<java.lang.Object> out)
               throws java.lang.Exception

指定者:

decode 在类中 MessageToMessageCodec<HttpRequest,HttpObject>

抛出:

java.lang.Exception

另请参阅:

MessageToMessageDecoder.decode(ChannelHandlerContext, Object, List)

encode

protected void encode(ChannelHandlerContext ctx,
                      HttpObject msg,
                      java.util.List<java.lang.Object> out)
               throws java.lang.Exception

指定者:

encode 在类中 MessageToMessageCodec<HttpRequest,HttpObject>

抛出:

java.lang.Exception

另请参阅:

MessageToMessageEncoder.encode(ChannelHandlerContext, Object, List)

beginEncode

protected abstract HttpContentEncoder.Result beginEncode(HttpResponse httpResponse,
                                                         java.lang.String acceptEncoding)
                                                  throws java.lang.Exception

Prepare to encode the HTTP message content.

参数:

httpResponse - the http response

acceptEncoding - the value of the "Accept-Encoding" header

返回:

the result of preparation, which is composed of the determined target content encoding and a new EmbeddedChannel that encodes the content into the target content encoding. null if acceptEncoding is unsupported or rejected and thus the content should be handled as-is (i.e. no encoding).

抛出:

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

channelInactive

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

从类复制的说明: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

指定者:

channelInactive 在接口中 ChannelInboundHandler

覆盖:

channelInactive 在类中 ChannelInboundHandlerAdapter

抛出:

java.lang.Exception