io.netty.handler.codec.http

类 HttpResponseDecoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.codec.http.HttpObjectDecoder

io.netty.handler.codec.http.HttpResponseDecoder

所有已实现的接口:

ChannelHandler, ChannelInboundHandler

public class HttpResponseDecoder
extends HttpObjectDecoder

Decodes ByteBufs into HttpResponses and HttpContents.

Parameters that prevents excessive memory consumption

Name	Meaning
maxInitialLineLength	The maximum length of the initial line (e.g. "HTTP/1.0 200 OK") If the length of the initial line exceeds this value, a TooLongFrameException will be raised.
maxHeaderSize	The maximum length of all headers. If the sum of the length of each header exceeds this value, a TooLongFrameException will be raised.
maxChunkSize	The maximum length of the content or each chunk. If the content length exceeds this value, the transfer encoding of the decoded response will be converted to 'chunked' and the content will be split into multiple HttpContents. If the transfer encoding of the HTTP response is 'chunked' already, each chunk will be split into smaller chunks if the length of the chunk exceeds this value. If you prefer not to handle HttpContents in your handler, insert HttpObjectAggregator after this decoder in the ChannelPipeline.

Decoding a response for a HEAD request

Unlike other HTTP requests, the successful response of a HEAD request does not have any content even if there is Content-Length header. Because HttpResponseDecoder is not able to determine if the response currently being decoded is associated with a HEAD request, you must override HttpObjectDecoder.isContentAlwaysEmpty(HttpMessage) to return true for the response of the HEAD request.

If you are writing an HTTP client that issues a HEAD request, please use HttpClientCodec instead of this decoder. It will perform additional state management to handle the responses for HEAD requests correctly.

Decoding a response for a CONNECT request

You also need to do additional state management to handle the response of a CONNECT request properly, like you did for HEAD. One difference is that the decoder should stop decoding completely after decoding the successful 200 response since the connection is not an HTTP connection anymore.

HttpClientCodec also handles this edge case correctly, so you have to use HttpClientCodec if you are writing an HTTP client that issues a CONNECT request.

嵌套类概要

从类继承的嵌套类/接口 io.netty.handler.codec.ByteToMessageDecoder

ByteToMessageDecoder.Cumulator

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

ChannelHandler.Sharable

字段概要

从类继承的字段 io.netty.handler.codec.http.HttpObjectDecoder

validateHeaders

从类继承的字段 io.netty.handler.codec.ByteToMessageDecoder

COMPOSITE_CUMULATOR, MERGE_CUMULATOR

构造器概要

构造器

构造器和说明
HttpResponseDecoder() Creates a new instance with the default maxInitialLineLength (4096), maxHeaderSize (8192), and maxChunkSize (8192).
HttpResponseDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize) Creates a new instance with the specified parameters.
HttpResponseDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean validateHeaders)
HttpResponseDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean validateHeaders, int initialBufferSize)

方法概要

方法

限定符和类型	方法和说明
protected HttpMessage	createInvalidMessage()
protected HttpMessage	createMessage(java.lang.String[] initialLine)
protected boolean	isDecodingRequest()

从类继承的方法 io.netty.handler.codec.http.HttpObjectDecoder

decode, decodeLast, isContentAlwaysEmpty, isSwitchingToNonHttp1Protocol, reset, userEventTriggered

从类继承的方法 io.netty.handler.codec.ByteToMessageDecoder

actualReadableBytes, callDecode, channelInactive, channelRead, channelReadComplete, discardSomeReadBytes, handlerRemoved, handlerRemoved0, internalBuffer, isSingleDecode, setCumulator, setDiscardAfterReads, setSingleDecode

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

channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught

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

ensureNotSharable, handlerAdded, isSharable

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

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

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

handlerAdded

构造器详细资料

HttpResponseDecoder

public HttpResponseDecoder()

Creates a new instance with the default maxInitialLineLength (4096), maxHeaderSize (8192), and maxChunkSize (8192).

HttpResponseDecoder

public HttpResponseDecoder(int maxInitialLineLength,
                   int maxHeaderSize,
                   int maxChunkSize)

Creates a new instance with the specified parameters.

HttpResponseDecoder

public HttpResponseDecoder(int maxInitialLineLength,
                   int maxHeaderSize,
                   int maxChunkSize,
                   boolean validateHeaders)

HttpResponseDecoder

public HttpResponseDecoder(int maxInitialLineLength,
                   int maxHeaderSize,
                   int maxChunkSize,
                   boolean validateHeaders,
                   int initialBufferSize)

方法详细资料

createMessage

protected HttpMessage createMessage(java.lang.String[] initialLine)

指定者:

createMessage 在类中 HttpObjectDecoder

createInvalidMessage

protected HttpMessage createInvalidMessage()

指定者:

createInvalidMessage 在类中 HttpObjectDecoder

isDecodingRequest

protected boolean isDecodingRequest()

指定者:

isDecodingRequest 在类中 HttpObjectDecoder