org.infinispan.server.core

Class AbstractProtocolDecoder<K,V>

java.lang.Object

org.jboss.netty.channel.SimpleChannelUpstreamHandler

org.jboss.netty.handler.codec.frame.FrameDecoder

org.jboss.netty.handler.codec.replay.ReplayingDecoder<DecoderState>

org.infinispan.server.core.AbstractProtocolDecoder<K,V>

All Implemented Interfaces:

Log, ServerConstants, org.jboss.netty.channel.ChannelHandler, org.jboss.netty.channel.ChannelUpstreamHandler, org.jboss.netty.channel.LifeCycleAwareChannelHandler

Direct Known Subclasses:

HotRodDecoder, MemcachedDecoder

public abstract class AbstractProtocolDecoder<K,V>
extends org.jboss.netty.handler.codec.replay.ReplayingDecoder<DecoderState>
implements ServerConstants, Log

Common abstract decoder for Memcached and Hot Rod protocols.

Since:

4.1

Author:

Galder Zamarreño

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.netty.channel.ChannelHandler

org.jboss.netty.channel.ChannelHandler.Sharable

Field Summary

Fields inherited from class org.jboss.netty.handler.codec.frame.FrameDecoder

cumulation, DEFAULT_MAX_COMPOSITEBUFFER_COMPONENTS

Constructor Summary

Constructors

Constructor and Description
AbstractProtocolDecoder(NettyTransport transport)

Method Summary

Methods

Modifier and Type	Method and Description
protected Metadata	buildMetadata()
protected AdvancedCache<K,V>	cache()
void	channelOpen(org.jboss.netty.channel.ChannelHandlerContext ctx, org.jboss.netty.channel.ChannelStateEvent e)
Object	checkpointTo(DecoderState state)
protected abstract Object	createErrorResponse(Throwable t)
protected abstract Object	createGetResponse(K k, CacheEntry entry)
protected abstract RequestHeader	createHeader()
protected abstract Object	createMultiGetResponse(scala.collection.immutable.Map<K,CacheEntry> pairs)
protected abstract Object	createNotExecutedResponse(V prev)
protected abstract Object	createNotExistResponse()
protected abstract scala.Tuple2<Exception,Object>	createServerException(Exception e, org.jboss.netty.buffer.ChannelBuffer b)
protected abstract Object	createStatsResponse()
protected abstract Object	createSuccessResponse(V prev)
protected abstract V	createValue()
protected abstract Object	customDecodeHeader(org.jboss.netty.channel.Channel ch, org.jboss.netty.buffer.ChannelBuffer buffer)
protected abstract Object	customDecodeKey(org.jboss.netty.channel.Channel ch, org.jboss.netty.buffer.ChannelBuffer buffer)
protected abstract Object	customDecodeValue(org.jboss.netty.channel.Channel ch, org.jboss.netty.buffer.ChannelBuffer buffer)
Object	decode(org.jboss.netty.channel.ChannelHandlerContext ctx, org.jboss.netty.channel.Channel ch, org.jboss.netty.buffer.ChannelBuffer buffer, DecoderState state)
Object	decodeLast(org.jboss.netty.channel.ChannelHandlerContext ctx, org.jboss.netty.channel.Channel ch, org.jboss.netty.buffer.ChannelBuffer buffer, DecoderState state)
protected long	defaultLifespanTime()
protected long	defaultMaxIdleTime()
void	exceptionCaught(org.jboss.netty.channel.ChannelHandlerContext ctx, org.jboss.netty.channel.ExceptionEvent e)
protected EntryVersion	generateVersion(Cache<K,V> cache)
protected Object	get(org.jboss.netty.buffer.ChannelBuffer buffer)
protected abstract Cache<K,V>	getCache()
protected AdvancedCache<K,V>	getOptimizedCache(AdvancedCache<K,V> c)
Object	handleModification(org.jboss.netty.channel.Channel ch, org.jboss.netty.buffer.ChannelBuffer buf)
protected RequestHeader	header()
protected K	key()
void	messageReceived(org.jboss.netty.channel.ChannelHandlerContext ctx, org.jboss.netty.channel.MessageEvent e)
protected RequestParameters	params()
protected byte[]	rawValue()
protected abstract scala.Option<Object>	readHeader(org.jboss.netty.buffer.ChannelBuffer b, RequestHeader header)
protected abstract scala.Tuple2<K,Object>	readKey(org.jboss.netty.buffer.ChannelBuffer b) Returns the key read along with a boolean indicating whether the end of the operation was found or not.
protected abstract boolean	readParameters(org.jboss.netty.channel.Channel ch, org.jboss.netty.buffer.ChannelBuffer b)
protected abstract void	readValue(org.jboss.netty.buffer.ChannelBuffer b)
protected long	toMillis(int lifespan) Transforms lifespan pass as seconds into milliseconds following this rule:
void	writeComplete(org.jboss.netty.channel.ChannelHandlerContext ctx, org.jboss.netty.channel.WriteCompletionEvent e)
protected Object	writeResponse(org.jboss.netty.channel.Channel ch, Object response)

Methods inherited from class org.jboss.netty.handler.codec.replay.ReplayingDecoder

checkpoint, checkpoint, cleanup, decode, decodeLast, getState, internalBuffer, setState

Methods inherited from class org.jboss.netty.handler.codec.frame.FrameDecoder

actualReadableBytes, afterAdd, afterRemove, appendToCumulation, beforeAdd, beforeRemove, channelClosed, channelDisconnected, extractFrame, getMaxCumulationBufferCapacity, getMaxCumulationBufferComponents, isUnfold, newCumulationBuffer, replace, setMaxCumulationBufferCapacity, setMaxCumulationBufferComponents, setUnfold, unfoldAndFireMessageReceived, updateCumulation

Methods inherited from class org.jboss.netty.channel.SimpleChannelUpstreamHandler

channelBound, channelConnected, channelInterestChanged, channelUnbound, childChannelClosed, childChannelOpen, handleUpstream

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.server.core.ServerConstants

EXPIRATION_DEFAULT, EXPIRATION_NONE

Methods inherited from interface org.infinispan.server.core.logging.Log

debug, debug, debug, debug, debug, debugf, error, info, info, isDebugEnabled, isTraceEnabled, log, logChannelStillBound, logChannelStillConnected, logErrorBeforeReadingRequest, logExceptionReported, logPostingShutdownRequest, logServerDidNotClose, logServerDidNotUnbind, logSettingMasterThreadsNotSupported, logStartWithArgs, trace, trace, trace, trace, tracef, warn

Constructor Detail

AbstractProtocolDecoder

public AbstractProtocolDecoder(NettyTransport transport)

Method Detail

header

protected RequestHeader header()

params

protected RequestParameters params()

key

protected K key()

rawValue

protected byte[] rawValue()

cache

protected AdvancedCache<K,V> cache()

defaultLifespanTime

protected long defaultLifespanTime()

defaultMaxIdleTime

protected long defaultMaxIdleTime()

decode

public Object decode(org.jboss.netty.channel.ChannelHandlerContext ctx,
            org.jboss.netty.channel.Channel ch,
            org.jboss.netty.buffer.ChannelBuffer buffer,
            DecoderState state)

Specified by:

decode in class org.jboss.netty.handler.codec.replay.ReplayingDecoder<DecoderState>

handleModification

public Object handleModification(org.jboss.netty.channel.Channel ch,
                        org.jboss.netty.buffer.ChannelBuffer buf)

decodeLast

public Object decodeLast(org.jboss.netty.channel.ChannelHandlerContext ctx,
                org.jboss.netty.channel.Channel ch,
                org.jboss.netty.buffer.ChannelBuffer buffer,
                DecoderState state)

Overrides:

decodeLast in class org.jboss.netty.handler.codec.replay.ReplayingDecoder<DecoderState>

writeResponse

protected Object writeResponse(org.jboss.netty.channel.Channel ch,
                   Object response)

buildMetadata

protected Metadata buildMetadata()

getOptimizedCache

protected AdvancedCache<K,V> getOptimizedCache(AdvancedCache<K,V> c)

get

protected Object get(org.jboss.netty.buffer.ChannelBuffer buffer)

exceptionCaught

public void exceptionCaught(org.jboss.netty.channel.ChannelHandlerContext ctx,
                   org.jboss.netty.channel.ExceptionEvent e)

Overrides:

exceptionCaught in class org.jboss.netty.handler.codec.frame.FrameDecoder

channelOpen

public void channelOpen(org.jboss.netty.channel.ChannelHandlerContext ctx,
               org.jboss.netty.channel.ChannelStateEvent e)

Overrides:

channelOpen in class org.jboss.netty.channel.SimpleChannelUpstreamHandler

checkpointTo

public Object checkpointTo(DecoderState state)

createHeader

protected abstract RequestHeader createHeader()

readHeader

protected abstract scala.Option<Object> readHeader(org.jboss.netty.buffer.ChannelBuffer b,
                              RequestHeader header)

getCache

protected abstract Cache<K,V> getCache()

readKey

protected abstract scala.Tuple2<K,Object> readKey(org.jboss.netty.buffer.ChannelBuffer b)

Returns the key read along with a boolean indicating whether the end of the operation was found or not. This allows client to differentiate between extra parameters or pipelined sequence of operations.

readParameters

protected abstract boolean readParameters(org.jboss.netty.channel.Channel ch,
                     org.jboss.netty.buffer.ChannelBuffer b)

readValue

protected abstract void readValue(org.jboss.netty.buffer.ChannelBuffer b)

createValue

protected abstract V createValue()

createSuccessResponse

protected abstract Object createSuccessResponse(V prev)

createNotExecutedResponse

protected abstract Object createNotExecutedResponse(V prev)

createNotExistResponse

protected abstract Object createNotExistResponse()

createGetResponse

protected abstract Object createGetResponse(K k,
                       CacheEntry entry)

createMultiGetResponse

protected abstract Object createMultiGetResponse(scala.collection.immutable.Map<K,CacheEntry> pairs)

createErrorResponse

protected abstract Object createErrorResponse(Throwable t)

createStatsResponse

protected abstract Object createStatsResponse()

customDecodeHeader

protected abstract Object customDecodeHeader(org.jboss.netty.channel.Channel ch,
                        org.jboss.netty.buffer.ChannelBuffer buffer)

customDecodeKey

protected abstract Object customDecodeKey(org.jboss.netty.channel.Channel ch,
                     org.jboss.netty.buffer.ChannelBuffer buffer)

customDecodeValue

protected abstract Object customDecodeValue(org.jboss.netty.channel.Channel ch,
                       org.jboss.netty.buffer.ChannelBuffer buffer)

createServerException

protected abstract scala.Tuple2<Exception,Object> createServerException(Exception e,
                                                   org.jboss.netty.buffer.ChannelBuffer b)

generateVersion

protected EntryVersion generateVersion(Cache<K,V> cache)

toMillis

protected long toMillis(int lifespan)

Transforms lifespan pass as seconds into milliseconds following this rule:

If lifespan is bigger than number of seconds in 30 days, then it is considered unix time. After converting it to milliseconds, we substract the current time in and the result is returned.

Otherwise it's just considered number of seconds from now and it's returned in milliseconds unit.

writeComplete

public void writeComplete(org.jboss.netty.channel.ChannelHandlerContext ctx,
                 org.jboss.netty.channel.WriteCompletionEvent e)

Overrides:

writeComplete in class org.jboss.netty.channel.SimpleChannelUpstreamHandler

messageReceived

public void messageReceived(org.jboss.netty.channel.ChannelHandlerContext ctx,
                   org.jboss.netty.channel.MessageEvent e)

Overrides:

messageReceived in class org.jboss.netty.handler.codec.replay.ReplayingDecoder<DecoderState>