Top Description Fields Constructors Methods
io.netty5.handler.codec.http

public Class HttpRequestDecoder

extends HttpObjectDecoder
Class Inheritance
Known Direct Subclasses
io.netty5.handler.codec.http.HttpServerCodec.HttpServerRequestDecoder
Imports
io.netty5.buffer.Buffer, io.netty5.channel.ChannelHandlerContext, .ChannelPipeline
Decodes Buffers into HttpRequests and HttpContents.

Parameters that prevents excessive memory consumption

NameMeaning
maxInitialLineLength The maximum length of the initial line (e.g. "GET / HTTP/1.0") If the length of the initial line exceeds this value, a TooLongHttpLineException will be raised.
maxHeaderSize The maximum length of all headers. If the sum of the length of each header exceeds this value, a TooLongHttpHeaderException 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 request will be converted to 'chunked' and the content will be split into multiple HttpContents. If the transfer encoding of the HTTP request 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.

Field Summary

Inherited from io.netty5.handler.codec.http.HttpObjectDecoder:
DEFAULT_ALLOW_DUPLICATE_CONTENT_LENGTHSDEFAULT_CHUNKED_SUPPORTEDDEFAULT_INITIAL_BUFFER_SIZEDEFAULT_MAX_HEADER_SIZEDEFAULT_MAX_INITIAL_LINE_LENGTHDEFAULT_VALIDATE_HEADERSvalidateHeaders

Constructor Summary

AccessConstructor and Description
public
HttpRequestDecoder()

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

public
HttpRequestDecoder(int maxInitialLineLength, int maxHeaderSize)

Creates a new instance with the specified parameters.

public
HttpRequestDecoder(int maxInitialLineLength, int maxHeaderSize, boolean validateHeaders)

public
HttpRequestDecoder(int maxInitialLineLength, int maxHeaderSize, boolean validateHeaders, int initialBufferSize)

public
HttpRequestDecoder(int maxInitialLineLength, int maxHeaderSize, boolean validateHeaders, int initialBufferSize, boolean allowDuplicateContentLengths)

Method Summary

Modifier and TypeMethod and Description
protected HttpMessage
createInvalidMessage(ChannelHandlerContext ctx)

Implements abstract io.netty5.handler.codec.http.HttpObjectDecoder.createInvalidMessage.

protected HttpMessage
createMessage(String[] initialLine)

Implements abstract io.netty5.handler.codec.http.HttpObjectDecoder.createMessage.

protected boolean
isDecodingRequest()

Implements abstract io.netty5.handler.codec.http.HttpObjectDecoder.isDecodingRequest.

Inherited from io.netty5.handler.codec.http.HttpObjectDecoder:
channelInboundEventdecodedecodeLasthandleTransferEncodingChunkedWithContentLengthisContentAlwaysEmptyisSwitchingToNonHttp1Protocolreset

Constructor Detail

HttpRequestDecoderback to summary
public HttpRequestDecoder()

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

HttpRequestDecoderback to summary
public HttpRequestDecoder(int maxInitialLineLength, int maxHeaderSize)

Creates a new instance with the specified parameters.

HttpRequestDecoderback to summary
public HttpRequestDecoder(int maxInitialLineLength, int maxHeaderSize, boolean validateHeaders)
HttpRequestDecoderback to summary
public HttpRequestDecoder(int maxInitialLineLength, int maxHeaderSize, boolean validateHeaders, int initialBufferSize)
HttpRequestDecoderback to summary
public HttpRequestDecoder(int maxInitialLineLength, int maxHeaderSize, boolean validateHeaders, int initialBufferSize, boolean allowDuplicateContentLengths)

Method Detail

createInvalidMessageback to summary
protected HttpMessage createInvalidMessage(ChannelHandlerContext ctx)

Implements abstract io.netty5.handler.codec.http.HttpObjectDecoder.createInvalidMessage.

Annotations
@Override
createMessageback to summary
protected HttpMessage createMessage(String[] initialLine) throws Exception

Implements abstract io.netty5.handler.codec.http.HttpObjectDecoder.createMessage.

Annotations
@Override
isDecodingRequestback to summary
protected boolean isDecodingRequest()

Implements abstract io.netty5.handler.codec.http.HttpObjectDecoder.isDecodingRequest.

Annotations
@Override