Module io.netty5.codec.http

Package io.netty5.handler.codec.http

Class HttpResponseEncoder

java.lang.Object

io.netty5.channel.ChannelHandlerAdapter

io.netty5.handler.codec.MessageToMessageEncoder<Object>

io.netty5.handler.codec.http.HttpObjectEncoder<HttpResponse>

io.netty5.handler.codec.http.HttpResponseEncoder

All Implemented Interfaces:

ChannelHandler

public class HttpResponseEncoder
extends HttpObjectEncoder<HttpResponse>

Encodes an HttpResponse or an HttpContent into a Buffer.

Constructor Summary

Constructors

Constructor	Description
HttpResponseEncoder()

Method Summary

Modifier and Type	Method	Description
boolean	acceptOutboundMessage(Object msg)	Returns true if the given message should be handled.
protected void	encodeInitialLine(Buffer buf, HttpResponse response)
protected boolean	isContentAlwaysEmpty(HttpResponse msg)	Determine whether a message has a content or not.
protected void	sanitizeHeadersBeforeEncode(HttpResponse msg, boolean isAlwaysEmpty)	Allows to sanitize headers of the message before encoding these.

Methods inherited from class io.netty5.handler.codec.http.HttpObjectEncoder

crlfBuffer, encodeAndClose, encodeHeaders, zeroCrlfCrlfBuffer

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

encode, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty5.channel.ChannelHandler

bind, channelActive, channelExceptionCaught, channelInactive, channelInboundEvent, channelRead, channelReadComplete, channelRegistered, channelShutdown, channelUnregistered, channelWritabilityChanged, close, connect, deregister, disconnect, flush, handlerAdded, handlerRemoved, isSharable, pendingOutboundBytes, read, register, sendOutboundEvent, shutdown

Constructor Detail

HttpResponseEncoder

public HttpResponseEncoder()

Method Detail

acceptOutboundMessage

public boolean acceptOutboundMessage(Object msg)
                              throws Exception

Description copied from class: MessageToMessageEncoder

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

Overrides:

acceptOutboundMessage in class HttpObjectEncoder<HttpResponse>

Throws:

Exception

encodeInitialLine

protected void encodeInitialLine(Buffer buf,
                                 HttpResponse response)
                          throws Exception

Specified by:

encodeInitialLine in class HttpObjectEncoder<HttpResponse>

Throws:

Exception

sanitizeHeadersBeforeEncode

protected void sanitizeHeadersBeforeEncode(HttpResponse msg,
                                           boolean isAlwaysEmpty)

Description copied from class: HttpObjectEncoder

Allows to sanitize headers of the message before encoding these.

Overrides:

sanitizeHeadersBeforeEncode in class HttpObjectEncoder<HttpResponse>

isContentAlwaysEmpty

protected boolean isContentAlwaysEmpty(HttpResponse msg)

Description copied from class: HttpObjectEncoder

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.

Overrides:

isContentAlwaysEmpty in class HttpObjectEncoder<HttpResponse>

Parameters:

msg - the message to test

Returns:

true to signal the message has no content