All Implemented Interfaces:

ChannelHandler, ChannelOutboundHandler

Direct Known Subclasses:

HttpRequestEncoder, HttpResponseEncoder, RtspEncoder, RtspObjectEncoder

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

• Nested Class Summary

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

    ChannelHandler.Sharable

• Constructor Summary

  Constructors

  Constructor and Description
  HttpObjectEncoder ()

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  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) Deprecated.
  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.

  • 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

• 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 aggregation

    Throws:

    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.

    Parameters:

    msg - the message to test

    Returns:

    true to signal the message has no content

  • 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

  • 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