Netty/Codec 4.1.107.Final · io.netty.handler.codec.MessageAggregator

Modifier and Type	Field and Description
private boolean	aggregating
private ChannelFutureListener	continueResponseWriteListener
private ChannelHandlerContext	ctx
private O	currentMessage
private static final int	DEFAULT_MAX_COMPOSITEBUFFER_COMPONENTS
private boolean	handleIncompleteAggregateDuringClose
private boolean	handlingOversizedMessage
private final int	maxContentLength
private int	maxCumulationBufferComponents

Access	Constructor and Description
protected	MessageAggregator(int the maximum length of the aggregated content. If the length of the aggregated content exceeds this value, `handleOversizedMessage(ChannelHandlerContext, Object)` will be called. maxContentLength) Creates a new instance.
protected	MessageAggregator(int maxContentLength, Class<? extends I> inboundMessageType)

Method Summary

Modifier and Type	Method and Description
public boolean	acceptInboundMessage(Object msg) Overrides io.netty.handler.codec.MessageToMessageDecoder.acceptInboundMessage. Returns `true` if the given message should be handled.
protected void	aggregate(O aggregated, C content) Transfers the information provided by the specified content message to the specified aggregated message.
private static void	appendPartialContent(CompositeByteBuf content, ByteBuf partialContent)
protected abstract O	beginAggregation(S start, ByteBuf content) Creates a new aggregated message from the specified start message and the specified content.
public void	channelInactive(ChannelHandlerContext ctx) Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelInactive. Implements io.netty.channel.ChannelInboundHandler.channelInactive. Calls `ChannelHandlerContext#fireChannelInactive()` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`.
public void	channelReadComplete(ChannelHandlerContext ctx) Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelReadComplete. Implements io.netty.channel.ChannelInboundHandler.channelReadComplete. Calls `ChannelHandlerContext#fireChannelReadComplete()` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`.
protected abstract boolean	Returns: `true` if the channel should be closed after the result of `newContinueResponse(Object, int, ChannelPipeline)` is written. `false` otherwise. closeAfterContinueResponse(Object The return value from `newContinueResponse(Object, int, ChannelPipeline)`. msg) Determine if the channel should be closed after the result of `newContinueResponse(Object, int, ChannelPipeline)` is written.
protected final ChannelHandlerContext	ctx()
protected void	decode(final ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToMessageDecoder` belongs to ctx, I the message to decode to an other one msg, List<Object> the `List` to which decoded messages should be added out) Implements abstract io.netty.handler.codec.MessageToMessageDecoder.decode. Decode from one message to an other.
protected void	finishAggregation(O aggregated) Invoked when the specified `aggregated` message is about to be passed to the next handler in the pipeline.
private void	finishAggregation0(O aggregated)
protected void	handleOversizedMessage(ChannelHandlerContext the `ChannelHandlerContext` ctx, S the accumulated message up to this point, whose type is `S` or `O` oversized) Invoked when an incoming request exceeds the maximum content length.
public void	handlerAdded(ChannelHandlerContext ctx) Overrides io.netty.channel.ChannelHandlerAdapter.handlerAdded. Implements io.netty.channel.ChannelHandler.handlerAdded. Gets called after the `ChannelHandler` was added to the actual context and it's ready to handle events.
public void	handlerRemoved(ChannelHandlerContext ctx) Overrides io.netty.channel.ChannelHandlerAdapter.handlerRemoved. Implements io.netty.channel.ChannelHandler.handlerRemoved. Gets called after the `ChannelHandler` was removed from the actual context and it doesn't handle events anymore.
protected abstract boolean	Returns: `true` if all objects for the current request/response should be ignored or not. `false` otherwise. ignoreContentAfterContinueResponse(Object The return value from `newContinueResponse(Object, int, ChannelPipeline)`. msg) Determine if all objects for the current request/response should be ignored or not.
private void	invokeHandleOversizedMessage(ChannelHandlerContext ctx, S oversized)
protected abstract boolean	isAggregated(I msg) Returns `true` if and only if the specified message is already aggregated.
protected abstract boolean	Returns: `true` if the message `start`'s content length is known, and if it greater than `maxContentLength`. `false` otherwise. isContentLengthInvalid(S The message which may indicate the content length. start, int The maximum allowed content length. maxContentLength) Determine if the message `start`'s content length is known, and if it greater than `maxContentLength`.
protected abstract boolean	isContentMessage(I msg) Returns `true` if and only if the specified message is a content message.
public final boolean	isHandlingOversizedMessage() Deprecated This method will be removed in future releases.
protected abstract boolean	isLastContentMessage(C msg) Returns `true` if and only if the specified message is the last content message.
protected abstract boolean	isStartMessage(I msg) Returns `true` if and only if the specified message is a start message.
public final int	maxContentLength() Returns the maximum allowed length of the aggregated message in bytes.
public final int	maxCumulationBufferComponents() Returns the maximum number of components in the cumulation buffer.
protected abstract Object	Returns: the 'continue response', or `null` if there's no message to send newContinueResponse(S start, int maxContentLength, ChannelPipeline pipeline) Returns the 'continue response' for the specified start message if necessary.
private void	releaseCurrentMessage()
public final void	setMaxCumulationBufferComponents(int maxCumulationBufferComponents) Sets the maximum number of components in the cumulation buffer.
private static void	validateMaxContentLength(int maxContentLength)

Inherited from io.netty.handler.codec.MessageToMessageDecoder:: channelRead

aggregating	back to summary
private boolean aggregating

continueResponseWriteListener	back to summary
private ChannelFutureListener continueResponseWriteListener

ctx	back to summary
private ChannelHandlerContext ctx

currentMessage	back to summary
private O currentMessage

DEFAULT_MAX_COMPOSITEBUFFER_COMPONENTS	back to summary
private static final int DEFAULT_MAX_COMPOSITEBUFFER_COMPONENTS

handleIncompleteAggregateDuringClose	back to summary
private boolean handleIncompleteAggregateDuringClose

handlingOversizedMessage	back to summary
private boolean handlingOversizedMessage

maxContentLength	back to summary
private final int maxContentLength

maxCumulationBufferComponents	back to summary
private int maxCumulationBufferComponents

MessageAggregator	back to summary
protected MessageAggregator(int maxContentLength) Creates a new instance. Parameters maxContentLength:int the maximum length of the aggregated content. If the length of the aggregated content exceeds this value, `handleOversizedMessage(ChannelHandlerContext, Object)` will be called.

MessageAggregator	back to summary
protected MessageAggregator(int maxContentLength, Class<? extends I> inboundMessageType)

Method Detail

acceptInboundMessage back to summary

acceptInboundMessage	back to summary
public boolean acceptInboundMessage(Object msg) throws Exception Overrides io.netty.handler.codec.MessageToMessageDecoder.acceptInboundMessage. Doc from io.netty.handler.codec.MessageToMessageDecoder.acceptInboundMessage. Returns `true` if the given message should be handled. If `false` it will be passed to the next `ChannelInboundHandler` in the `ChannelPipeline`. Annotations @Override

public boolean acceptInboundMessage(Object msg) throws Exception

Overrides io.netty.handler.codec.MessageToMessageDecoder.acceptInboundMessage.

Doc from io.netty.handler.codec.MessageToMessageDecoder.acceptInboundMessage.

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

Annotations

@Override

aggregate back to summary

aggregate	back to summary
protected void aggregate(O aggregated, C content) throws Exception Transfers the information provided by the specified content message to the specified aggregated message. Note that the content of the specified content message has been appended to the content of the specified aggregated message already, so that you don't need to. Use this method to transfer the additional information that the content message provides to `aggregated`.

protected void aggregate(O aggregated, C content) throws Exception

Transfers the information provided by the specified content message to the specified aggregated message. Note that the content of the specified content message has been appended to the content of the specified aggregated message already, so that you don't need to. Use this method to transfer the additional information that the content message provides to aggregated.

appendPartialContent	back to summary
private static void appendPartialContent(CompositeByteBuf content, ByteBuf partialContent)

beginAggregation	back to summary
protected abstract O beginAggregation(S start, ByteBuf content) throws Exception Creates a new aggregated message from the specified start message and the specified content. If the start message implements `ByteBufHolder`, its content is appended to the specified `content`. This aggregator will continue to append the received content to the specified `content`.

channelInactive back to summary

channelInactive	back to summary
public void channelInactive(ChannelHandlerContext ctx) throws Exception Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelInactive. Implements io.netty.channel.ChannelInboundHandler.channelInactive. Doc from io.netty.channel.ChannelInboundHandlerAdapter.channelInactive. Calls `ChannelHandlerContext#fireChannelInactive()` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`. Sub-classes may override this method to change behavior. Annotations @Override

public void channelInactive(ChannelHandlerContext ctx) throws Exception

Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelInactive.

Implements io.netty.channel.ChannelInboundHandler.channelInactive.

Doc from io.netty.channel.ChannelInboundHandlerAdapter.channelInactive.

Calls ChannelHandlerContext#fireChannelInactive() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Annotations

@Override

channelReadComplete back to summary

channelReadComplete	back to summary
public void channelReadComplete(ChannelHandlerContext ctx) throws Exception Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelReadComplete. Implements io.netty.channel.ChannelInboundHandler.channelReadComplete. Doc from io.netty.channel.ChannelInboundHandlerAdapter.channelReadComplete. Calls `ChannelHandlerContext#fireChannelReadComplete()` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`. Sub-classes may override this method to change behavior. Annotations @Override

public void channelReadComplete(ChannelHandlerContext ctx) throws Exception

Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelReadComplete.

Implements io.netty.channel.ChannelInboundHandler.channelReadComplete.

Doc from io.netty.channel.ChannelInboundHandlerAdapter.channelReadComplete.

Calls ChannelHandlerContext#fireChannelReadComplete() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Annotations

@Override

closeAfterContinueResponse back to summary

closeAfterContinueResponse	back to summary
protected abstract boolean closeAfterContinueResponse(Object msg) throws Exception Determine if the channel should be closed after the result of `newContinueResponse(Object, int, ChannelPipeline)` is written. Parameters msg:Object The return value from `newContinueResponse(Object, int, ChannelPipeline)`. Returns:boolean `true` if the channel should be closed after the result of `newContinueResponse(Object, int, ChannelPipeline)` is written. `false` otherwise.

protected abstract boolean closeAfterContinueResponse(Object msg) throws Exception

Determine if the channel should be closed after the result of newContinueResponse(Object, int, ChannelPipeline) is written.

Parameters

msg:Object: The return value from newContinueResponse(Object, int, ChannelPipeline).

Returns:boolean

true if the channel should be closed after the result of newContinueResponse(Object, int, ChannelPipeline) is written. false otherwise.

ctx	back to summary
protected final ChannelHandlerContext ctx()

decode back to summary

decode	back to summary
protected void decode(final ChannelHandlerContext ctx, I msg, List<Object> out) throws Exception Implements abstract io.netty.handler.codec.MessageToMessageDecoder.decode. Doc from io.netty.handler.codec.MessageToMessageDecoder.decode. Decode from one message to an other. This method will be called for each written message that can be handled by this decoder. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToMessageDecoder` belongs to msg:I the message to decode to an other one out:List<Object> the `List` to which decoded messages should be added Annotations @Override Exceptions Exception: is thrown if an error occurs

protected void decode(final ChannelHandlerContext ctx, I msg, List<Object> out) throws Exception

Implements abstract io.netty.handler.codec.MessageToMessageDecoder.decode.

Doc from io.netty.handler.codec.MessageToMessageDecoder.decode.

Decode from one message to an other. This method will be called for each written message that can be handled by this decoder.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext which this MessageToMessageDecoder belongs to
msg:I: the message to decode to an other one
out:List<Object>: the List to which decoded messages should be added

Annotations

@Override

Exceptions

Exception:: is thrown if an error occurs

finishAggregation	back to summary
protected void finishAggregation(O aggregated) throws Exception Invoked when the specified `aggregated` message is about to be passed to the next handler in the pipeline.

finishAggregation0	back to summary
private void finishAggregation0(O aggregated) throws Exception

handleOversizedMessage back to summary

handleOversizedMessage	back to summary
protected void handleOversizedMessage(ChannelHandlerContext ctx, S oversized) throws Exception Invoked when an incoming request exceeds the maximum content length. The default behvaior is to trigger an `exceptionCaught()` event with a `TooLongFrameException`. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` oversized:S the accumulated message up to this point, whose type is `S` or `O`

protected void handleOversizedMessage(ChannelHandlerContext ctx, S oversized) throws Exception

Invoked when an incoming request exceeds the maximum content length. The default behvaior is to trigger an exceptionCaught() event with a TooLongFrameException.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext
oversized:S: the accumulated message up to this point, whose type is S or O

handlerAdded back to summary

handlerAdded	back to summary
public void handlerAdded(ChannelHandlerContext ctx) throws Exception Overrides io.netty.channel.ChannelHandlerAdapter.handlerAdded. Implements io.netty.channel.ChannelHandler.handlerAdded. Doc from io.netty.channel.ChannelHandler.handlerAdded. Gets called after the `ChannelHandler` was added to the actual context and it's ready to handle events. Annotations @Override

public void handlerAdded(ChannelHandlerContext ctx) throws Exception

Overrides io.netty.channel.ChannelHandlerAdapter.handlerAdded.

Implements io.netty.channel.ChannelHandler.handlerAdded.

Doc from io.netty.channel.ChannelHandler.handlerAdded.

Gets called after the ChannelHandler was added to the actual context and it's ready to handle events.

Annotations

@Override

handlerRemoved back to summary

handlerRemoved	back to summary
public void handlerRemoved(ChannelHandlerContext ctx) throws Exception Overrides io.netty.channel.ChannelHandlerAdapter.handlerRemoved. Implements io.netty.channel.ChannelHandler.handlerRemoved. Doc from io.netty.channel.ChannelHandler.handlerRemoved. Gets called after the `ChannelHandler` was removed from the actual context and it doesn't handle events anymore. Annotations @Override

public void handlerRemoved(ChannelHandlerContext ctx) throws Exception

Overrides io.netty.channel.ChannelHandlerAdapter.handlerRemoved.

Implements io.netty.channel.ChannelHandler.handlerRemoved.

Doc from io.netty.channel.ChannelHandler.handlerRemoved.

Gets called after the ChannelHandler was removed from the actual context and it doesn't handle events anymore.

Annotations

@Override

ignoreContentAfterContinueResponse back to summary

ignoreContentAfterContinueResponse	back to summary
protected abstract boolean ignoreContentAfterContinueResponse(Object msg) throws Exception Determine if all objects for the current request/response should be ignored or not. Messages will stop being ignored the next time `isContentMessage(Object)` returns `true`. Parameters msg:Object The return value from `newContinueResponse(Object, int, ChannelPipeline)`. Returns:boolean `true` if all objects for the current request/response should be ignored or not. `false` otherwise.

protected abstract boolean ignoreContentAfterContinueResponse(Object msg) throws Exception

Determine if all objects for the current request/response should be ignored or not. Messages will stop being ignored the next time isContentMessage(Object) returns true.

Parameters

msg:Object: The return value from newContinueResponse(Object, int, ChannelPipeline).

Returns:boolean

true if all objects for the current request/response should be ignored or not. false otherwise.

invokeHandleOversizedMessage	back to summary
private void invokeHandleOversizedMessage(ChannelHandlerContext ctx, S oversized) throws Exception

isAggregated	back to summary
protected abstract boolean isAggregated(I msg) throws Exception Returns `true` if and only if the specified message is already aggregated. If this method returns `true`, this handler will simply forward the message to the next handler as-is.

isContentLengthInvalid back to summary

isContentLengthInvalid	back to summary
protected abstract boolean isContentLengthInvalid(S start, int maxContentLength) throws Exception Determine if the message `start`'s content length is known, and if it greater than `maxContentLength`. Parameters start:S The message which may indicate the content length. maxContentLength:int The maximum allowed content length. Returns:boolean `true` if the message `start`'s content length is known, and if it greater than `maxContentLength`. `false` otherwise.

protected abstract boolean isContentLengthInvalid(S start, int maxContentLength) throws Exception

Determine if the message start's content length is known, and if it greater than maxContentLength.

Parameters

start:S: The message which may indicate the content length.
maxContentLength:int: The maximum allowed content length.

Returns:boolean

true if the message start's content length is known, and if it greater than maxContentLength. false otherwise.

isContentMessage back to summary

isContentMessage	back to summary
protected abstract boolean isContentMessage(I msg) throws Exception Returns `true` if and only if the specified message is a content message. Typically, this method is implemented as a single `return` statement with `instanceof`: return msg instanceof MyContentMessage;

protected abstract boolean isContentMessage(I msg) throws Exception

Returns true if and only if the specified message is a content message. Typically, this method is implemented as a single return statement with instanceof:

return msg instanceof MyContentMessage;

isHandlingOversizedMessage	back to summary
public final boolean isHandlingOversizedMessage() Deprecated This method will be removed in future releases. Annotations @Deprecated

isLastContentMessage back to summary

isLastContentMessage	back to summary
protected abstract boolean isLastContentMessage(C msg) throws Exception Returns `true` if and only if the specified message is the last content message. Typically, this method is implemented as a single `return` statement with `instanceof`: return msg instanceof MyLastContentMessage; or with `instanceof` and boolean field check: return msg instanceof MyContentMessage && msg.isLastFragment();

protected abstract boolean isLastContentMessage(C msg) throws Exception

Returns true if and only if the specified message is the last content message. Typically, this method is implemented as a single return statement with instanceof:

return msg instanceof MyLastContentMessage;

or with instanceof and boolean field check:

return msg instanceof MyContentMessage && msg.isLastFragment();

isStartMessage back to summary

isStartMessage	back to summary
protected abstract boolean isStartMessage(I msg) throws Exception Returns `true` if and only if the specified message is a start message. Typically, this method is implemented as a single `return` statement with `instanceof`: return msg instanceof MyStartMessage;

protected abstract boolean isStartMessage(I msg) throws Exception

Returns true if and only if the specified message is a start message. Typically, this method is implemented as a single return statement with instanceof:

return msg instanceof MyStartMessage;

maxContentLength	back to summary
public final int maxContentLength() Returns the maximum allowed length of the aggregated message in bytes.

maxCumulationBufferComponents	back to summary
public final int maxCumulationBufferComponents() Returns the maximum number of components in the cumulation buffer. If the number of the components in the cumulation buffer exceeds this value, the components of the cumulation buffer are consolidated into a single component, involving memory copies. The default value of this property is 1024.

newContinueResponse back to summary

newContinueResponse	back to summary
protected abstract Object newContinueResponse(S start, int maxContentLength, ChannelPipeline pipeline) throws Exception Returns the 'continue response' for the specified start message if necessary. For example, this method is useful to handle an HTTP 100-continue header. Returns:Object the 'continue response', or `null` if there's no message to send

protected abstract Object newContinueResponse(S start, int maxContentLength, ChannelPipeline pipeline) throws Exception

Returns the 'continue response' for the specified start message if necessary. For example, this method is useful to handle an HTTP 100-continue header.

Returns:Object: the 'continue response', or null if there's no message to send

releaseCurrentMessage	back to summary
private void releaseCurrentMessage()

setMaxCumulationBufferComponents back to summary

setMaxCumulationBufferComponents	back to summary
public final void setMaxCumulationBufferComponents(int maxCumulationBufferComponents) Sets the maximum number of components in the cumulation buffer. If the number of the components in the cumulation buffer exceeds this value, the components of the cumulation buffer are consolidated into a single component, involving memory copies. The default value of this property is 1024 and its minimum allowed value is `2`.

public final void setMaxCumulationBufferComponents(int maxCumulationBufferComponents)

Sets the maximum number of components in the cumulation buffer. If the number of the components in the cumulation buffer exceeds this value, the components of the cumulation buffer are consolidated into a single component, involving memory copies. The default value of this property is 1024 and its minimum allowed value is 2.

validateMaxContentLength	back to summary
private static void validateMaxContentLength(int maxContentLength)

public abstract Class MessageAggregator<I, S, C extends io.netty.buffer.ByteBufHolder, O extends io.netty.buffer.ByteBufHolder>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail