io.netty.handler.codec.http

Class HttpMessageEncoder

java.lang.Object

io.netty.channel.ChannelOperationHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

io.netty.channel.ChannelOutboundMessageHandlerAdapter<I>

io.netty.handler.codec.MessageToByteEncoder<Object>

io.netty.handler.codec.http.HttpMessageEncoder

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelOperationHandler, io.netty.channel.ChannelOutboundHandler, io.netty.channel.ChannelOutboundMessageHandler<Object>

Direct Known Subclasses:

HttpRequestEncoder, HttpResponseEncoder, RtspMessageEncoder

public abstract class HttpMessageEncoder
extends io.netty.handler.codec.MessageToByteEncoder<Object>

Encodes an HttpMessage or an HttpChunk 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

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpMessageEncoder() Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	encode(io.netty.channel.ChannelHandlerContext ctx, Object msg, io.netty.buffer.ByteBuf out)
protected abstract void	encodeInitialLine(io.netty.buffer.ByteBuf buf, HttpMessage message)
boolean	isEncodable(Object msg)

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

flush

Methods inherited from class io.netty.channel.ChannelOutboundMessageHandlerAdapter

newOutboundBuffer

Methods inherited from class io.netty.channel.ChannelOperationHandlerAdapter

afterAdd, afterRemove, beforeAdd, beforeRemove, bind, close, connect, deregister, disconnect, exceptionCaught, userEventTriggered

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.ChannelOperationHandler

bind, close, connect, deregister, disconnect

Methods inherited from interface io.netty.channel.ChannelHandler

afterAdd, afterRemove, beforeAdd, beforeRemove, exceptionCaught, userEventTriggered

Constructor Detail

HttpMessageEncoder

protected HttpMessageEncoder()

Creates a new instance.

Method Detail

isEncodable

public boolean isEncodable(Object msg)
                    throws Exception

Overrides:

isEncodable in class io.netty.handler.codec.MessageToByteEncoder<Object>

Throws:

Exception

encode

public void encode(io.netty.channel.ChannelHandlerContext ctx,
          Object msg,
          io.netty.buffer.ByteBuf out)
            throws Exception

Specified by:

encode in class io.netty.handler.codec.MessageToByteEncoder<Object>

Throws:

Exception

encodeInitialLine

protected abstract void encodeInitialLine(io.netty.buffer.ByteBuf buf,
                     HttpMessage message)
                                   throws Exception

Throws:

Exception