HttpObjectEncoder (Netty API Reference (4.1.22.Final))

java.lang.Object
- io.netty.channel.ChannelHandlerAdapter
- - io.netty.channel.ChannelOutboundHandlerAdapter
  - - io.netty.handler.codec.MessageToMessageEncoder<java.lang.Object>
    - - io.netty.handler.codec.http.HttpObjectEncoder<H>

All Implemented Interfaces:

ChannelHandler ， ChannelOutboundHandler

已知直接子类：

HttpRequestEncoder ， HttpResponseEncoder ， RtspEncoder ， RtspObjectEncoder
```
public abstract class HttpObjectEncoder<H extends HttpMessage>
extends MessageToMessageEncoder<java.lang.Object>
```
将HttpMessage或HttpContent编码为ByteBuf 。
可扩展性
请注意，此编码器设计用于扩展以实现从HTTP派生的协议，例如RTSP和ICAP 。为了实现这种衍生协议的编码器，扩展这个类并适当地实现所有的抽象方法。

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

构造方法摘要

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

方法摘要

所有方法静态方法接口方法抽象方法具体的方法弃用的方法
Modifier and Type	Method and Description
`boolean`	`acceptOutboundMessage(java.lang.Object msg)` 如果应该处理给定的消息，则返回 `true` 。
`protected void`	`encode(ChannelHandlerContext ctx, java.lang.Object msg, java.util.List<java.lang.Object> out)` 从一条消息编码到另一条消息。
`protected static void`	`encodeAscii(java.lang.String s, ByteBuf buf)` 已过时。
`protected void`	`encodeHeaders(HttpHeaders headers, ByteBuf buf)` 将`HttpHeaders`编码为`ByteBuf` 。
`protected abstract void`	`encodeInitialLine(ByteBuf buf, H message)`
`protected boolean`	`isContentAlwaysEmpty(H msg)` 确定消息是否包含内容。
`protected void`	`sanitizeHeadersBeforeEncode(H msg, boolean isAlwaysEmpty)` 允许在编码这些消息之前清理消息的标题。

Methods inherited from class io.netty.handler.codec.MessageToMessageEncoder
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

- 构造方法详细信息
  - HttpObjectEncoder
```
public HttpObjectEncoder()
```
- 方法详细信息
  - encode
```
protected void encode(ChannelHandlerContext ctx,
                      java.lang.Object msg,
                      java.util.List<java.lang.Object> out)
               throws java.lang.Exception
```
    从类复制的描述： MessageToMessageEncoder
    
    从一条消息编码到另一条消息。这个方法将被编码器处理的每个书面信息调用。
    
    Specified by:
    
    encode在课堂上 MessageToMessageEncoder<java.lang.Object>
    
    参数
    
    ctx - 这MessageToMessageEncoder所属的ChannelHandlerContext
    
    msg - 要编码到另一个的消息
    
    out - 应该添加编码味精的 List需要做某种聚合
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - encodeHeaders
```
protected void encodeHeaders(HttpHeaders headers,
                             ByteBuf buf)
```
    将HttpHeaders编码为ByteBuf 。
  - sanitizeHeadersBeforeEncode
```
protected void sanitizeHeadersBeforeEncode(H msg,
                                           boolean isAlwaysEmpty)
```
    允许在编码这些消息之前清理消息的标题。
  - isContentAlwaysEmpty
```
protected boolean isContentAlwaysEmpty(H msg)
```
    确定消息是否包含内容。一些消息可能具有指示内容而不具有实际内容的标题，例如对HEAD或CONNECT请求的响应。
    
    参数
    
    msg - 要测试的消息
    
    结果
    
    true以表示消息没有内容
  - acceptOutboundMessage
```
public boolean acceptOutboundMessage(java.lang.Object msg)
                              throws java.lang.Exception
```
    从类复制的描述： MessageToMessageEncoder
    
    如果应该处理给定的消息，则返回true 。如果false它将被传递到ChannelPipeline中的下一个ChannelOutboundHandler 。
    
    重写：
    
    acceptOutboundMessage在课堂上 MessageToMessageEncoder<java.lang.Object>
    
    异常
    
    java.lang.Exception
  - encodeAscii
```
@Deprecated
protected static void encodeAscii(java.lang.String s,
                                              ByteBuf buf)
```
    已过时。
  - encodeInitialLine
```
protected abstract void encodeInitialLine(ByteBuf buf,
                                          H message)
                                   throws java.lang.Exception
```
    异常
    
    java.lang.Exception

Class HttpObjectEncoder<H extends HttpMessage>

可扩展性

Nested Class Summary

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

构造方法摘要

方法摘要

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

Methods inherited from class io.netty.channel.ChannelOutboundHandlerAdapter

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.channel.ChannelHandler

构造方法详细信息

HttpObjectEncoder

方法详细信息

encode

encodeHeaders

sanitizeHeadersBeforeEncode

isContentAlwaysEmpty

acceptOutboundMessage

encodeAscii

encodeInitialLine