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 intoRedisMessage
objects following RESP (REdis Serialization Protocol).RedisMessage
parts can be aggregated toRedisMessage
usingRedisArrayAggregator
or processed directly.
-
-
Nested Class Summary
-
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 inherited from class io.netty.handler.codec.ByteToMessageDecoder
COMPOSITE_CUMULATOR, MERGE_CUMULATOR
-
-
Constructor Summary
Constructors Constructor Description RedisDecoder()
Creates a new instance with defaultmaxInlineMessageLength
andmessagePool
and inline command decoding disabled.RedisDecoder(boolean decodeInlineCommands)
Creates a new instance with defaultmaxInlineMessageLength
andmessagePool
.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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
decode(ChannelHandlerContext ctx, ByteBuf in, java.util.List<java.lang.Object> out)
Decode the from oneByteBuf
to an other.-
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
-
-
-
-
Constructor Detail
-
RedisDecoder
public RedisDecoder()
Creates a new instance with defaultmaxInlineMessageLength
andmessagePool
and inline command decoding disabled.
-
RedisDecoder
public RedisDecoder(boolean decodeInlineCommands)
Creates a new instance with defaultmaxInlineMessageLength
andmessagePool
.- Parameters:
decodeInlineCommands
- iftrue
, 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
- iftrue
, inline commands will be decoded.
-
-
Method Detail
-
decode
protected void decode(ChannelHandlerContext ctx, ByteBuf in, java.util.List<java.lang.Object> out) throws java.lang.Exception
Description copied from class:ByteToMessageDecoder
Decode the from oneByteBuf
to an other. This method will be called till either the inputByteBuf
has nothing to read when return from this method or till nothing was read from the inputByteBuf
.- Specified by:
decode
in classByteToMessageDecoder
- Parameters:
ctx
- theChannelHandlerContext
which thisByteToMessageDecoder
belongs toin
- theByteBuf
from which to read dataout
- theList
to which decoded messages should be added- Throws:
java.lang.Exception
- is thrown if an error occurs
-
-