public abstract class HttpMessageDecoder extends ReplayingDecoder<HttpMessageDecoder.State>
ChannelBuffer
s into HttpMessage
s and
HttpChunk
s.
Name | Meaning |
---|---|
maxInitialLineLength |
The maximum length of the initial line
(e.g. "GET / HTTP/1.0" or "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
(or the length of each chunk) exceeds this value, the content or chunk
will be split into multiple HttpChunk s whose length is
maxChunkSize at maximum. |
maxChunkSize
or
the transfer encoding of the HTTP message is 'chunked', this decoder
generates one HttpMessage
instance and its following
HttpChunk
s per single HTTP message to avoid excessive memory
consumption. For example, the following HTTP message:
GET / HTTP/1.1 Transfer-Encoding: chunked 1a abcdefghijklmnopqrstuvwxyz 10 1234567890abcdef 0 Content-MD5: ... [blank line]triggers
HttpRequestDecoder
to generate 4 objects:
HttpRequest
whose chunked
property is true
,HttpChunk
whose content is 'abcdefghijklmnopqrstuvwxyz'
,HttpChunk
whose content is '1234567890abcdef'
, andHttpChunkTrailer
which marks the end of the content.HttpChunk
s by yourself for your
convenience, insert HttpChunkAggregator
after this decoder in the
ChannelPipeline
. However, please note that your server might not
be as memory efficient as without the aggregator.
Modifier and Type | Class and Description |
---|---|
protected static class |
HttpMessageDecoder.State
The internal state of
HttpMessageDecoder . |
ChannelHandler.Sharable
cumulation, DEFAULT_MAX_COMPOSITEBUFFER_COMPONENTS
Modifier | Constructor and Description |
---|---|
protected |
HttpMessageDecoder()
Creates a new instance with the default
maxInitialLineLength (4096 }, maxHeaderSize (8192) , and
maxChunkSize (8192) . |
protected |
HttpMessageDecoder(int maxInitialLineLength,
int maxHeaderSize,
int maxChunkSize)
Creates a new instance with the specified parameters.
|
Modifier and Type | Method and Description |
---|---|
protected abstract HttpMessage |
createMessage(String[] initialLine) |
protected Object |
decode(ChannelHandlerContext ctx,
Channel channel,
ChannelBuffer buffer,
HttpMessageDecoder.State state)
Decodes the received packets so far into a frame.
|
protected boolean |
isContentAlwaysEmpty(HttpMessage msg) |
protected abstract boolean |
isDecodingRequest() |
checkpoint, checkpoint, cleanup, decode, decodeLast, decodeLast, getState, internalBuffer, messageReceived, setState
actualReadableBytes, afterAdd, afterRemove, appendToCumulation, beforeAdd, beforeRemove, channelClosed, channelDisconnected, exceptionCaught, extractFrame, getMaxCumulationBufferCapacity, getMaxCumulationBufferComponents, isUnfold, newCumulationBuffer, replace, setMaxCumulationBufferCapacity, setMaxCumulationBufferComponents, setUnfold, unfoldAndFireMessageReceived, updateCumulation
channelBound, channelConnected, channelInterestChanged, channelOpen, channelUnbound, childChannelClosed, childChannelOpen, handleUpstream, writeComplete
protected HttpMessageDecoder()
maxInitialLineLength (4096
}, maxHeaderSize (8192)
, and
maxChunkSize (8192)
.protected HttpMessageDecoder(int maxInitialLineLength, int maxHeaderSize, int maxChunkSize)
protected Object decode(ChannelHandlerContext ctx, Channel channel, ChannelBuffer buffer, HttpMessageDecoder.State state) throws Exception
ReplayingDecoder
decode
in class ReplayingDecoder<HttpMessageDecoder.State>
ctx
- the context of this handlerchannel
- the current channelbuffer
- the cumulative buffer of received packets so far.
Note that the buffer might be empty, which means you
should not make an assumption that the buffer contains
at least one byte in your decoder implementation.state
- the current decoder state (null
if unused)Exception
protected boolean isContentAlwaysEmpty(HttpMessage msg)
protected abstract boolean isDecodingRequest()
protected abstract HttpMessage createMessage(String[] initialLine) throws Exception
Exception
Copyright © 2008-2014 The Netty Project. All Rights Reserved.