io.netty.handler.codec.http

类 HttpObjectEncoder<H extends HttpMessage>

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>

所有已实现的接口:

ChannelHandler, ChannelOutboundHandler

直接已知子类:

HttpRequestEncoder, HttpResponseEncoder, RtspEncoder, RtspObjectEncoder

public abstract class HttpObjectEncoder<H extends HttpMessage>
extends MessageToMessageEncoder<java.lang.Object>

Encodes an HttpMessage or an HttpContent into a ByteBuf.

Extensibility

Please note that this encoder is designed to be extended to implement a protocol derived from HTTP, such as RTSP and ICAP. To implement the encoder of such a derived protocol, extend this class and implement all abstract methods properly.

嵌套类概要

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

ChannelHandler.Sharable

构造器概要

构造器

构造器和说明
HttpObjectEncoder()

方法概要

限定符和类型	方法和说明
boolean	acceptOutboundMessage(java.lang.Object msg) Returns true if the given message should be handled.
protected void	encode(ChannelHandlerContext ctx, java.lang.Object msg, java.util.List<java.lang.Object> out) Encode from one message to an other.
protected static void	encodeAscii(java.lang.String s, ByteBuf buf) 已过时。
protected void	encodeHeaders(HttpHeaders headers, ByteBuf buf) Encode the HttpHeaders into a ByteBuf.
protected abstract void	encodeInitialLine(ByteBuf buf, H message)
protected boolean	isContentAlwaysEmpty(H msg) Determine whether a message has a content or not.
protected void	sanitizeHeadersBeforeEncode(H msg, boolean isAlwaysEmpty) Allows to sanitize headers of the message before encoding these.
void	write(ChannelHandlerContext ctx, java.lang.Object msg, ChannelPromise promise) Calls ChannelOutboundInvoker.write(Object, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.

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

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

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

ensureNotSharable, exceptionCaught, handlerAdded, handlerRemoved, isSharable

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

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

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

exceptionCaught, handlerAdded, handlerRemoved

构造器详细资料

HttpObjectEncoder

public HttpObjectEncoder()

方法详细资料

write

public void write(ChannelHandlerContext ctx,
                  java.lang.Object msg,
                  ChannelPromise promise)
           throws java.lang.Exception

从类复制的说明: ChannelOutboundHandlerAdapter

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

指定者:

write 在接口中 ChannelOutboundHandler

覆盖:

write 在类中 MessageToMessageEncoder<java.lang.Object>

参数:

ctx - the ChannelHandlerContext for which the write operation is made

msg - the message to write

promise - the ChannelPromise to notify once the operation completes

抛出:

java.lang.Exception - thrown if an error occurs

encode

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

从类复制的说明: MessageToMessageEncoder

Encode from one message to an other. This method will be called for each written message that can be handled by this encoder.

指定者:

encode 在类中 MessageToMessageEncoder<java.lang.Object>

参数:

ctx - the ChannelHandlerContext which this MessageToMessageEncoder belongs to

msg - the message to encode to an other one

out - the List into which the encoded msg should be added needs to do some kind of aggregation

抛出:

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

encodeHeaders

protected void encodeHeaders(HttpHeaders headers,
                             ByteBuf buf)

Encode the HttpHeaders into a ByteBuf.

sanitizeHeadersBeforeEncode

protected void sanitizeHeadersBeforeEncode(H msg,
                                           boolean isAlwaysEmpty)

Allows to sanitize headers of the message before encoding these.

isContentAlwaysEmpty

protected boolean isContentAlwaysEmpty(H msg)

Determine whether a message has a content or not. Some message may have headers indicating a content without having an actual content, e.g the response to an HEAD or CONNECT request.

参数:

msg - the message to test

返回:

true to signal the message has no content

acceptOutboundMessage

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

从类复制的说明: MessageToMessageEncoder

Returns true if the given message should be handled. If false it will be passed to the next ChannelOutboundHandler in the ChannelPipeline.

覆盖:

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