io.netty.handler.codec.http

Class 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>

All Implemented Interfaces:

ChannelHandler, ChannelOutboundHandler

Direct Known Subclasses:

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.

Nested Class Summary

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

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static byte[]	CRLF
private static ByteBuf	CRLF_BUF
private static int	ST_CONTENT_CHUNK
private static int	ST_CONTENT_NON_CHUNK
private static int	ST_INIT
private int	state
private static byte[]	ZERO_CRLF
private static byte[]	ZERO_CRLF_CRLF
private static ByteBuf	ZERO_CRLF_CRLF_BUF

Constructor Summary

Constructors

Constructor and Description
HttpObjectEncoder()

Method Summary

Modifier and Type	Method and Description
boolean	acceptOutboundMessage(java.lang.Object msg) Returns true if the given message should be handled.
private static long	contentLength(java.lang.Object msg)
protected void	encode(ChannelHandlerContext ctx, java.lang.Object msg, java.util.List<java.lang.Object> out) Encode from one message to an other.
private static java.lang.Object	encodeAndRetain(java.lang.Object msg)
protected static void	encodeAscii(java.lang.String s, ByteBuf buf) Deprecated.
private void	encodeChunkedContent(ChannelHandlerContext ctx, java.lang.Object msg, long contentLength, java.util.List<java.lang.Object> out)
protected void	encodeHeaders(HttpHeaders headers, ByteBuf buf) Encode the HttpHeaders into a ByteBuf.
protected abstract void	encodeInitialLine(ByteBuf buf, H message)

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

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

Field Detail

CRLF

static final byte[] CRLF

ZERO_CRLF

private static final byte[] ZERO_CRLF

ZERO_CRLF_CRLF

private static final byte[] ZERO_CRLF_CRLF

CRLF_BUF

private static final ByteBuf CRLF_BUF

ZERO_CRLF_CRLF_BUF

private static final ByteBuf ZERO_CRLF_CRLF_BUF

ST_INIT

private static final int ST_INIT

See Also:

Constant Field Values

ST_CONTENT_NON_CHUNK

private static final int ST_CONTENT_NON_CHUNK

See Also:

Constant Field Values

ST_CONTENT_CHUNK

private static final int ST_CONTENT_CHUNK

See Also:

Constant Field Values

state

private int state

Constructor Detail

HttpObjectEncoder

public HttpObjectEncoder()

Method Detail

encode

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

Description copied from class: MessageToMessageEncoder

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

Specified by:

encode in class MessageToMessageEncoder<java.lang.Object>

Parameters:

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 aggragation

Throws:

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

encodeHeaders

protected void encodeHeaders(HttpHeaders headers,
                             ByteBuf buf)

Encode the HttpHeaders into a ByteBuf.

encodeChunkedContent

private void encodeChunkedContent(ChannelHandlerContext ctx,
                                  java.lang.Object msg,
                                  long contentLength,
                                  java.util.List<java.lang.Object> out)

acceptOutboundMessage

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

Description copied from class: MessageToMessageEncoder

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

Overrides:

acceptOutboundMessage in class MessageToMessageEncoder<java.lang.Object>

Throws:

java.lang.Exception

encodeAndRetain

private static java.lang.Object encodeAndRetain(java.lang.Object msg)

contentLength

private static long contentLength(java.lang.Object msg)

encodeAscii

@Deprecated
protected static void encodeAscii(java.lang.String s,
                                              ByteBuf buf)

Deprecated.

encodeInitialLine

protected abstract void encodeInitialLine(ByteBuf buf,
                                          H message)
                                   throws java.lang.Exception

Throws:

java.lang.Exception