Class AbstractBinaryMemcacheDecoder<M extends BinaryMemcacheMessage>
java.lang.Object
io.netty.channel.ChannelHandlerAdapter
io.netty.channel.ChannelInboundHandlerAdapter
io.netty.handler.codec.ByteToMessageDecoder
io.netty.handler.codec.memcache.AbstractMemcacheObjectDecoder
io.netty.handler.codec.memcache.binary.AbstractBinaryMemcacheDecoder<M>
- All Implemented Interfaces:
ChannelHandler
,ChannelInboundHandler
- Direct Known Subclasses:
BinaryMemcacheRequestDecoder
,BinaryMemcacheResponseDecoder
@UnstableApi
public abstract class AbstractBinaryMemcacheDecoder<M extends BinaryMemcacheMessage>
extends AbstractMemcacheObjectDecoder
Decoder for both
BinaryMemcacheRequest
and BinaryMemcacheResponse
.
The difference in the protocols (header) is implemented by the subclasses.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) static enum
Contains all states this decoder can possibly be in.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
FieldsFields inherited from class io.netty.handler.codec.ByteToMessageDecoder
COMPOSITE_CUMULATOR, MERGE_CUMULATOR
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Create a newAbstractBinaryMemcacheDecoder
with default settings.protected
AbstractBinaryMemcacheDecoder
(int chunkSize) Create a newAbstractBinaryMemcacheDecoder
with custom settings. -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract M
Helper method to create a upstream message when the incoming parsing did fail.void
When the channel goes inactive, release all frames to prevent data leaks.protected void
decode
(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) Decode the from oneByteBuf
to an other.protected abstract M
decodeHeader
(ByteBuf in) Decode and return the parsedBinaryMemcacheMessage
.private MemcacheContent
invalidChunk
(Exception cause) Helper method to create a content chunk indicating a invalid decoding result.private M
invalidMessage
(Exception cause) Helper method to create a message indicating a invalid decoding result.protected void
Prepare for next decoding iteration.Methods inherited from class io.netty.handler.codec.ByteToMessageDecoder
actualReadableBytes, callDecode, 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
-
DEFAULT_MAX_CHUNK_SIZE
public static final int DEFAULT_MAX_CHUNK_SIZE- See Also:
-
chunkSize
private final int chunkSize -
currentMessage
-
alreadyReadChunkSize
private int alreadyReadChunkSize -
state
-
-
Constructor Details
-
AbstractBinaryMemcacheDecoder
protected AbstractBinaryMemcacheDecoder()Create a newAbstractBinaryMemcacheDecoder
with default settings. -
AbstractBinaryMemcacheDecoder
protected AbstractBinaryMemcacheDecoder(int chunkSize) Create a newAbstractBinaryMemcacheDecoder
with custom settings.- Parameters:
chunkSize
- the maximum chunk size of the payload.
-
-
Method Details
-
decode
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:
Exception
- is thrown if an error occurs
-
invalidMessage
Helper method to create a message indicating a invalid decoding result.- Parameters:
cause
- the cause of the decoding failure.- Returns:
- a valid message indicating failure.
-
invalidChunk
Helper method to create a content chunk indicating a invalid decoding result.- Parameters:
cause
- the cause of the decoding failure.- Returns:
- a valid content chunk indicating failure.
-
channelInactive
When the channel goes inactive, release all frames to prevent data leaks.- Specified by:
channelInactive
in interfaceChannelInboundHandler
- Overrides:
channelInactive
in classByteToMessageDecoder
- Parameters:
ctx
- handler context- Throws:
Exception
-
resetDecoder
protected void resetDecoder()Prepare for next decoding iteration. -
decodeHeader
Decode and return the parsedBinaryMemcacheMessage
.- Parameters:
in
- the incoming buffer.- Returns:
- the decoded header.
-
buildInvalidMessage
Helper method to create a upstream message when the incoming parsing did fail.- Returns:
- a message indicating a decoding failure.
-