Package io.netty.handler.codec.redis

Class RedisDecoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.codec.redis.RedisDecoder

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler

@UnstableApi
public final class RedisDecoder
extends ByteToMessageDecoder

Decodes the Redis protocol into RedisMessage objects following RESP (REdis Serialization Protocol). RedisMessage parts can be aggregated to RedisMessage using RedisArrayAggregator or processed directly.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static enum	RedisDecoder.State
private static final class	RedisDecoder.ToPositiveLongProcessor

Nested classes/interfaces inherited from class io.netty.handler.codec.ByteToMessageDecoder

ByteToMessageDecoder.Cumulator

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	decodeInlineCommands
private final int	maxInlineMessageLength
private final RedisMessagePool	messagePool
private int	remainingBulkLength
private RedisDecoder.State	state
private final RedisDecoder.ToPositiveLongProcessor	toPositiveLongProcessor
private RedisMessageType	type

Fields inherited from class io.netty.handler.codec.ByteToMessageDecoder

COMPOSITE_CUMULATOR, MERGE_CUMULATOR

Constructor Summary

Constructors

Constructor	Description
RedisDecoder()	Creates a new instance with default maxInlineMessageLength and messagePool and inline command decoding disabled.
RedisDecoder(boolean decodeInlineCommands)	Creates a new instance with default maxInlineMessageLength and messagePool.
RedisDecoder(int maxInlineMessageLength, RedisMessagePool messagePool)	Creates a new instance with inline command decoding disabled.
RedisDecoder(int maxInlineMessageLength, RedisMessagePool messagePool, boolean decodeInlineCommands)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected void	decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out)	Decode the from one ByteBuf to an other.
private boolean	decodeBulkString(ByteBuf in, List<Object> out)
private boolean	decodeBulkStringContent(ByteBuf in, List<Object> out)
private boolean	decodeBulkStringEndOfLine(ByteBuf in, List<Object> out)
private boolean	decodeInline(ByteBuf in, List<Object> out)
private boolean	decodeLength(ByteBuf in, List<Object> out)
private boolean	decodeType(ByteBuf in)
private RedisMessage	newInlineRedisMessage(RedisMessageType messageType, ByteBuf content)
private long	parsePositiveNumber(ByteBuf byteBuf)
private long	parseRedisNumber(ByteBuf byteBuf)
private static void	readEndOfLine(ByteBuf in)
private static ByteBuf	readLine(ByteBuf in)
private void	resetDecoder()

Methods inherited from class io.netty.handler.codec.ByteToMessageDecoder

actualReadableBytes, callDecode, channelInactive, channelRead, channelReadComplete, decodeLast, discardSomeReadBytes, handlerRemoved, handlerRemoved0, internalBuffer, isSingleDecode, setCumulator, setDiscardAfterReads, setSingleDecode, userEventTriggered

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelHandler

handlerAdded

Field Details

toPositiveLongProcessor

private final RedisDecoder.ToPositiveLongProcessor toPositiveLongProcessor

decodeInlineCommands

private final boolean decodeInlineCommands

maxInlineMessageLength

private final int maxInlineMessageLength

messagePool

private final RedisMessagePool messagePool

state

private RedisDecoder.State state

type

private RedisMessageType type

remainingBulkLength

private int remainingBulkLength

Constructor Details

RedisDecoder

public RedisDecoder()

Creates a new instance with default maxInlineMessageLength and messagePool and inline command decoding disabled.

RedisDecoder

public RedisDecoder(boolean decodeInlineCommands)

Creates a new instance with default maxInlineMessageLength and messagePool.

Parameters:

decodeInlineCommands - if true, inline commands will be decoded.

RedisDecoder

public RedisDecoder(int maxInlineMessageLength,
 RedisMessagePool messagePool)

Creates a new instance with inline command decoding disabled.

Parameters:

maxInlineMessageLength - the maximum length of inline message.

messagePool - the predefined message pool.

RedisDecoder

public RedisDecoder(int maxInlineMessageLength,
 RedisMessagePool messagePool,
 boolean decodeInlineCommands)

Creates a new instance.

Parameters:

maxInlineMessageLength - the maximum length of inline message.

messagePool - the predefined message pool.

decodeInlineCommands - if true, inline commands will be decoded.

Method Details

decode

protected void decode(ChannelHandlerContext ctx,
 ByteBuf in,
 List<Object> out)
               throws Exception

Description copied from class: ByteToMessageDecoder

Decode the from one ByteBuf to an other. This method will be called till either the input ByteBuf has nothing to read when return from this method or till nothing was read from the input ByteBuf.

Specified by:

decode in class ByteToMessageDecoder

Parameters:

ctx - the ChannelHandlerContext which this ByteToMessageDecoder belongs to

in - the ByteBuf from which to read data

out - the List to which decoded messages should be added

Throws:

Exception - is thrown if an error occurs

resetDecoder

private void resetDecoder()

decodeType

private boolean decodeType(ByteBuf in)
                    throws Exception

Throws:

Exception

decodeInline

private boolean decodeInline(ByteBuf in,
 List<Object> out)
                      throws Exception

Throws:

Exception

decodeLength

private boolean decodeLength(ByteBuf in,
 List<Object> out)
                      throws Exception

Throws:

Exception

decodeBulkString

private boolean decodeBulkString(ByteBuf in,
 List<Object> out)
                          throws Exception

Throws:

Exception

decodeBulkStringEndOfLine

private boolean decodeBulkStringEndOfLine(ByteBuf in,
 List<Object> out)
                                   throws Exception

Throws:

Exception

decodeBulkStringContent

private boolean decodeBulkStringContent(ByteBuf in,
 List<Object> out)
                                 throws Exception

Throws:

Exception

readEndOfLine

private static void readEndOfLine(ByteBuf in)

newInlineRedisMessage

private RedisMessage newInlineRedisMessage(RedisMessageType messageType,
 ByteBuf content)

readLine

private static ByteBuf readLine(ByteBuf in)

parseRedisNumber

private long parseRedisNumber(ByteBuf byteBuf)

parsePositiveNumber

private long parsePositiveNumber(ByteBuf byteBuf)