Class RedisArrayAggregator

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.MessageToMessageDecoder<RedisMessage>

io.netty.handler.codec.redis.RedisArrayAggregator

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler

@UnstableApi
public final class RedisArrayAggregator
extends MessageToMessageDecoder<RedisMessage>

Aggregates RedisMessage parts into ArrayRedisMessage. This decoder should be used together with RedisDecoder.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	RedisArrayAggregator.AggregateState

Nested classes/interfaces inherited from interface ChannelHandler

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	DEFAULT_MAX_ARRAY_LENGTH
private final Deque<RedisArrayAggregator.AggregateState>	depths
private final int	maxElements
private final int	maxNestedArrayDepth

Constructor Summary

Constructors

Constructor	Description
RedisArrayAggregator()	Deprecated. Use RedisArrayAggregator(int, int) instead to define a max size of the array to aggregate.
RedisArrayAggregator(int maxElements, int maxNestedArrayDepth)	Create a new instance that will aggregate an ArrayHeaderRedisMessage and its subsequent elements into an ArrayRedisMessage.

Method Summary

Modifier and Type	Method	Description
void	channelInactive(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
protected void	decode(ChannelHandlerContext ctx, RedisMessage msg, List<Object> out)	Decode from one message to an other.
private RedisMessage	decodeRedisArrayHeader(ArrayHeaderRedisMessage header)
void	handlerRemoved(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.
private void	releaseAndClearDepths()

Methods inherited from class MessageToMessageDecoder

acceptInboundMessage, channelRead, channelReadComplete

Methods inherited from class ChannelInboundHandlerAdapter

channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class ChannelHandlerAdapter

ensureNotSharable, handlerAdded, isSharable

Methods inherited from class Object

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

Methods inherited from interface ChannelHandler

handlerAdded

Field Details

DEFAULT_MAX_ARRAY_LENGTH

private static final int DEFAULT_MAX_ARRAY_LENGTH

maxNestedArrayDepth

private final int maxNestedArrayDepth

depths

private final Deque<RedisArrayAggregator.AggregateState> depths

maxElements

private final int maxElements

Constructor Details

RedisArrayAggregator

@Deprecated
public RedisArrayAggregator()

Deprecated.

Use RedisArrayAggregator(int, int) instead to define a max size of the array to aggregate.

Create a new instance that will aggregate an ArrayHeaderRedisMessage and its subsequent elements into an ArrayRedisMessage.

This constructor specifies a maximum number of elements of 1.000.000, but this default can be increased with the "io.netty.handler.codec.redis.maxArrayLength" system property.

RedisArrayAggregator

public RedisArrayAggregator(int maxElements,
 int maxNestedArrayDepth)

Create a new instance that will aggregate an ArrayHeaderRedisMessage and its subsequent elements into an ArrayRedisMessage.

A CodecException will be thrown if the array header specify a length greater than the given number of max elements.

Parameters:

maxElements - The maximum number of elements to aggregate in a single message.

maxNestedArrayDepth - the maximum depth of the nested array before an exception will be thrown

Method Details

decode

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

Description copied from class: MessageToMessageDecoder

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

Specified by:

decode in class MessageToMessageDecoder<RedisMessage>

Parameters:

ctx - the ChannelHandlerContext which this MessageToMessageDecoder belongs to

msg - the message to decode to an other one

out - the List to which decoded messages should be added

Throws:

Exception - is thrown if an error occurs

decodeRedisArrayHeader

private RedisMessage decodeRedisArrayHeader(ArrayHeaderRedisMessage header)

handlerRemoved

public void handlerRemoved(ChannelHandlerContext ctx)
                    throws Exception

Description copied from class: ChannelHandlerAdapter

Do nothing by default, sub-classes may override this method.

Specified by:

handlerRemoved in interface ChannelHandler

Overrides:

handlerRemoved in class ChannelHandlerAdapter

Throws:

Exception

releaseAndClearDepths

private void releaseAndClearDepths()

channelInactive

public void channelInactive(ChannelHandlerContext ctx)
                     throws Exception

Description copied from class: ChannelInboundHandlerAdapter

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

Specified by:

channelInactive in interface ChannelInboundHandler

Overrides:

channelInactive in class ChannelInboundHandlerAdapter

Throws:

Exception