Netty5/Codec 5.0.0.Alpha5 · io.netty5.handler.codec.MessageAggregator

Modifier and Type	Field and Description
private boolean	aggregating
private FutureContextListener<ChannelHandlerContext, Void>	continueResponseWriteListener
private ChannelHandlerContext	ctx
private A	currentMessage
private boolean	handlingOversizedMessage
private final int	maxContentLength

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.netty5.handler.codec.MessageToMessageDecoder.acceptInboundMessage. Returns `true` if the given message should be handled.
protected abstract void	aggregate(BufferAllocator allocator, A aggregated, C content) Aggregated the passed `content` in the passed `aggregate`.
protected abstract A	beginAggregation(BufferAllocator allocator, S start) Creates a new aggregated message from the specified start message.
public void	channelInactive(ChannelHandlerContext ctx) Overrides default io.netty5.channel.ChannelHandler.channelInactive. The `Channel` of the `ChannelHandlerContext` was registered is now inactive and reached its end of lifetime.
public void	channelReadComplete(ChannelHandlerContext ctx) Overrides default io.netty5.channel.ChannelHandler.channelReadComplete. Invoked when the last message read by the current read operation has been consumed by `channelRead(ChannelHandlerContext, Object)`.
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 another one msg) Overrides io.netty5.handler.codec.MessageToMessageDecoder.decode. Decode from one message to another.
protected void	finishAggregation(BufferAllocator allocator, A aggregated) Invoked when the specified `aggregated` message is about to be passed to the next handler in the pipeline.
private void	finishAggregation0(BufferAllocator allocator, A aggregated)
protected void	handleOversizedMessage(ChannelHandlerContext the `ChannelHandlerContext` ctx, Object the accumulated message up to this point. oversized) Invoked when an incoming request exceeds the maximum content length.
public void	handlerAdded(ChannelHandlerContext ctx) Overrides default io.netty5.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 default io.netty5.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, Object oversized)
protected abstract boolean	isAggregated(Object 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	isLastContentMessage(C msg) Returns `true` if and only if the specified message is the last content message.
protected abstract int	Returns: Length in bytes of the passed message. lengthForAggregation(A to calculate length. msg) Returns the length in bytes of the passed message.
protected abstract int	Returns: Length in bytes of the passed message. lengthForContent(C to calculate length. msg) Returns the length in bytes of the passed message.
public final int	maxContentLength() Returns the maximum allowed length of the aggregated message in bytes.
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()
protected abstract C	tryContentMessage(Object msg) If the passed `msg` is a content message then cast and return the same, else return `null`.
protected abstract S	tryStartMessage(Object msg) If the passed `msg` is a start message then cast and return the same, else return `null`.
private static void	validateMaxContentLength(int maxContentLength)

Inherited from io.netty5.handler.codec.MessageToMessageDecoder:: channelRead decodeAndClose

aggregating	back to summary
private boolean aggregating

continueResponseWriteListener	back to summary
private FutureContextListener<ChannelHandlerContext, Void> continueResponseWriteListener

ctx	back to summary
private ChannelHandlerContext ctx

currentMessage	back to summary
private A currentMessage

handlingOversizedMessage	back to summary
private boolean handlingOversizedMessage

maxContentLength	back to summary
private final int maxContentLength

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.netty5.handler.codec.MessageToMessageDecoder.acceptInboundMessage. Doc from io.netty5.handler.codec.MessageToMessageDecoder.acceptInboundMessage. Returns `true` if the given message should be handled. If `false` it will be passed to the next `ChannelHandler` in the `ChannelPipeline`. Annotations @Override

public boolean acceptInboundMessage(Object msg) throws Exception

Overrides io.netty5.handler.codec.MessageToMessageDecoder.acceptInboundMessage.

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

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

Annotations

@Override

aggregate	back to summary
protected abstract void aggregate(BufferAllocator allocator, A aggregated, C content) throws Exception Aggregated the passed `content` in the passed `aggregate`.

beginAggregation	back to summary
protected abstract A beginAggregation(BufferAllocator allocator, S start) throws Exception Creates a new aggregated message from the specified start message.

channelInactive back to summary

channelInactive	back to summary
public void channelInactive(ChannelHandlerContext ctx) throws Exception Overrides default io.netty5.channel.ChannelHandler.channelInactive. Doc from io.netty5.channel.ChannelHandler.channelInactive. The `Channel` of the `ChannelHandlerContext` was registered is now inactive and reached its end of lifetime. Annotations @Override

public void channelInactive(ChannelHandlerContext ctx) throws Exception

Overrides default io.netty5.channel.ChannelHandler.channelInactive.

Doc from io.netty5.channel.ChannelHandler.channelInactive.

The Channel of the ChannelHandlerContext was registered is now inactive and reached its end of lifetime.

Annotations

@Override

channelReadComplete back to summary

channelReadComplete	back to summary
public void channelReadComplete(ChannelHandlerContext ctx) throws Exception Overrides default io.netty5.channel.ChannelHandler.channelReadComplete. Doc from io.netty5.channel.ChannelHandler.channelReadComplete. Invoked when the last message read by the current read operation has been consumed by `channelRead(ChannelHandlerContext, Object)`. If `ChannelOption#AUTO_READ` is off, no further attempt to read an inbound data from the current `Channel` will be made until `ChannelOutboundInvoker#read(ReadBufferAllocator)` is called. Annotations @Override

public void channelReadComplete(ChannelHandlerContext ctx) throws Exception

Overrides default io.netty5.channel.ChannelHandler.channelReadComplete.

Doc from io.netty5.channel.ChannelHandler.channelReadComplete.

Invoked when the last message read by the current read operation has been consumed by channelRead(ChannelHandlerContext, Object). If ChannelOption#AUTO_READ is off, no further attempt to read an inbound data from the current Channel will be made until ChannelOutboundInvoker#read(ReadBufferAllocator) is called.

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) throws Exception Overrides io.netty5.handler.codec.MessageToMessageDecoder.decode. Doc from io.netty5.handler.codec.MessageToMessageDecoder.decode. Decode from one message to another. This method will be called for each written message that can be handled by this decoder. The message will be disposed of after this call. Subclasses that wish to sometimes pass messages through, should instead override the `decodeAndClose(ChannelHandlerContext, Object)` method. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToMessageDecoder` belongs to msg:I the message to decode to another one Annotations @Override Exceptions Exception: is thrown if an error occurs

protected void decode(final ChannelHandlerContext ctx, I msg) throws Exception

Overrides io.netty5.handler.codec.MessageToMessageDecoder.decode.

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

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

The message will be disposed of after this call.

Subclasses that wish to sometimes pass messages through, should instead override the decodeAndClose(ChannelHandlerContext, Object) method.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext which this MessageToMessageDecoder belongs to
msg:I: the message to decode to another one

Annotations

@Override

Exceptions

Exception:: is thrown if an error occurs

finishAggregation	back to summary
protected void finishAggregation(BufferAllocator allocator, A 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(BufferAllocator allocator, A aggregated) throws Exception

handleOversizedMessage back to summary

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

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

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

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext
oversized:Object: the accumulated message up to this point.

handlerAdded back to summary

handlerAdded	back to summary
public void handlerAdded(ChannelHandlerContext ctx) throws Exception Overrides default io.netty5.channel.ChannelHandler.handlerAdded. Doc from io.netty5.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 default io.netty5.channel.ChannelHandler.handlerAdded.

Doc from io.netty5.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 default io.netty5.channel.ChannelHandler.handlerRemoved. Doc from io.netty5.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 default io.netty5.channel.ChannelHandler.handlerRemoved.

Doc from io.netty5.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 `tryContentMessage(Object)` returns a `non null` value. 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 tryContentMessage(Object) returns a non null value.

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, Object oversized) throws Exception

isAggregated	back to summary
protected abstract boolean isAggregated(Object 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.

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();

lengthForAggregation	back to summary
protected abstract int lengthForAggregation(A msg) Returns the length in bytes of the passed message. Parameters msg:A to calculate length. Returns:int Length in bytes of the passed message.

lengthForAggregation

back to summary

protected abstract int lengthForAggregation(A msg)

Returns the length in bytes of the passed message.

Parameters

msg:A: to calculate length.

Returns:int

Length in bytes of the passed message.

lengthForContent	back to summary
protected abstract int lengthForContent(C msg) Returns the length in bytes of the passed message. Parameters msg:C to calculate length. Returns:int Length in bytes of the passed message.

lengthForContent

back to summary

protected abstract int lengthForContent(C msg)

Returns the length in bytes of the passed message.

Parameters

msg:C: to calculate length.

Returns:int

Length in bytes of the passed message.

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

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() throws Exception

tryContentMessage	back to summary
protected abstract C tryContentMessage(Object msg) If the passed `msg` is a content message then cast and return the same, else return `null`.

tryStartMessage	back to summary
protected abstract S tryStartMessage(Object msg) If the passed `msg` is a start message then cast and return the same, else return `null`.

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

public abstract Class MessageAggregator<I, S, C extends java.lang.AutoCloseable, A extends java.lang.AutoCloseable>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail