HttpContentEncoder (Netty API Reference (4.1.22.Final))

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

All Implemented Interfaces:

ChannelHandler ， ChannelInboundHandler ， ChannelOutboundHandler

已知直接子类：

HttpContentCompressor
```
public abstract class HttpContentEncoder
extends MessageToMessageCodec<HttpRequest,HttpObject>
```
编码出站HttpResponse和HttpContent的内容。原始内容将被由beginEncode(HttpResponse, String)创建的EmbeddedChannel编码的新内容替换。编码完成后， 'Content-Encoding'标头的值将设置为目标内容编码，由beginEncode(HttpResponse, String)返回。此外， 'Content-Length'标题更新为编码内容的长度。如果在相应的无支持或允许编码HttpRequest的"Accept-Encoding"头， beginEncode(HttpResponse, String)应返回null使得没有编码发生（即直通）。
请注意，这是一个抽象类。您必须扩展此类并正确实施beginEncode(HttpResponse, String)以使此类功能正常。例如，请参阅源代码HttpContentCompressor 。

该处理程序必须放置在管道中的HttpObjectEncoder之后，以便此处理程序可以在HttpObjectEncoder将它们转换为ByteBuf之前拦截HTTP响应。

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`HttpContentEncoder.Result`

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

构造方法摘要

构造方法
Constructor and Description
`HttpContentEncoder()`

方法摘要

所有方法接口方法抽象方法具体的方法
Modifier and Type	Method and Description
`boolean`	`acceptOutboundMessage(java.lang.Object msg)` 当且仅当指定的消息可以由此编解码器编码时返回 `true` 。
`protected abstract HttpContentEncoder.Result`	`beginEncode(HttpResponse headers, java.lang.String acceptEncoding)` 准备编码HTTP消息内容。
`void`	`channelInactive(ChannelHandlerContext ctx)` 致电`ChannelHandlerContext.fireChannelInactive()`转发到`ChannelPipeline`中的下一个`ChannelInboundHandler` 。
`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)` 子类可以忽略这个方法。

Methods inherited from class io.netty.handler.codec.MessageToMessageCodec
acceptInboundMessage, channelRead, write

Methods inherited from class io.netty.channel.ChannelDuplexHandler
bind, close, connect, deregister, disconnect, flush, read

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter
channelActive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter
ensureNotSharable, handlerAdded, 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

- 构造方法详细信息
  - HttpContentEncoder
```
public HttpContentEncoder()
```
- 方法详细信息
  - acceptOutboundMessage
```
public boolean acceptOutboundMessage(java.lang.Object msg)
                              throws java.lang.Exception
```
    从类复制的描述： MessageToMessageCodec
    
    当且仅当指定的消息可以由此编解码器编码时返回 true 。
    
    重写：
    
    acceptOutboundMessage在课堂上 MessageToMessageCodec<HttpRequest,HttpObject>
    
    参数
    
    msg - 消息
    
    异常
    
    java.lang.Exception
  - decode
```
protected void decode(ChannelHandlerContext ctx,
                      HttpRequest msg,
                      java.util.List<java.lang.Object> out)
               throws java.lang.Exception
```
    Specified by:
    
    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
```
    Specified by:
    
    encode在课堂 MessageToMessageCodec<HttpRequest,HttpObject>
    
    异常
    
    java.lang.Exception
    
    另请参见：
    
    MessageToMessageEncoder.encode(ChannelHandlerContext, Object, List)
  - beginEncode
```
protected abstract HttpContentEncoder.Result beginEncode(HttpResponse headers,
                                                         java.lang.String acceptEncoding)
                                                  throws java.lang.Exception
```
    准备编码HTTP消息内容。
    
    参数
    
    headers - 标题
    
    acceptEncoding - "Accept-Encoding"标题的值
    
    结果
    
    准备的结果，其由确定的目标内容编码和将内容编码为目标内容编码的新的EmbeddedChannel组成。 null如果acceptEncoding不被支持或拒绝，因此内容应按原样处理（即不编码）。
    
    异常
    
    java.lang.Exception
  - handlerRemoved
```
public void handlerRemoved(ChannelHandlerContext ctx)
                    throws java.lang.Exception
```
    从类复制的描述： ChannelHandlerAdapter
    
    子类可以忽略这个方法。
    
    Specified by:
    
    handlerRemoved在界面 ChannelHandler
    
    重写：
    
    handlerRemoved ChannelHandlerAdapter
    
    异常
    
    java.lang.Exception
  - channelInactive
```
public void channelInactive(ChannelHandlerContext ctx)
                     throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireChannelInactive()转发到ChannelPipeline中的下一个ChannelInboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    channelInactive在界面 ChannelInboundHandler
    
    重写：
    
    channelInactive在课堂上 ChannelInboundHandlerAdapter
    
    异常
    
    java.lang.Exception

Class HttpContentEncoder

Nested Class Summary

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

构造方法摘要

方法摘要

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

Methods inherited from class io.netty.channel.ChannelDuplexHandler

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.channel.ChannelHandler

构造方法详细信息

HttpContentEncoder

方法详细信息

acceptOutboundMessage

decode

encode

beginEncode

handlerRemoved

channelInactive