Package org.apache.qpid.server.protocol.v0_8

Class AMQDecoder<T extends MethodProcessor>

java.lang.Object

org.apache.qpid.server.protocol.v0_8.AMQDecoder<T>

Direct Known Subclasses:

ServerDecoder

public abstract class AMQDecoder<T extends MethodProcessor>
extends Object

AMQDecoder delegates the decoding of AMQP either to a data block decoder, or in the case of new connections, to a protocol initiation decoder. It is a cumulative decoder, which means that it can accumulate data to decode in the buffer until there is enough data to decode.

One instance of this class is created per session, so any changes or configuration done at run time to the decoder will only affect decoding of the protocol session data to which is it bound.

TODO If protocol initiation decoder not needed, then don't create it. Probably not a big deal, but it adds to the per-session overhead.

Field Summary

Fields

Modifier and Type	Field	Description
static int	FRAME_HEADER_SIZE
static int	FRAME_MIN_SIZE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AMQDecoder(boolean expectProtocolInitiation, T methodProcessor)	Creates a new AMQP decoder.

Method Summary

Modifier and Type	Method	Description
protected int	decodable(QpidByteBuffer in)
protected int	decode(QpidByteBuffer buf)
T	getMethodProcessor()
protected AMQFrameDecodingException	newUnknownMethodException(int classId, int methodId, ProtocolVersion protocolVersion)
protected int	processAMQPFrames(QpidByteBuffer buf)
protected void	processFrame(int channel, byte type, long bodySize, QpidByteBuffer in)
protected void	processInput(QpidByteBuffer in)
protected abstract void	processMethod(int channelId, QpidByteBuffer in)
void	setExpectProtocolInitiation(boolean expectProtocolInitiation)	Sets the protocol initiation flag, that determines whether decoding is handled by the data decoder of the protocol initiation decoder.
void	setMaxFrameSize(int frameMax)

Methods inherited from class java.lang.Object

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

Field Detail

FRAME_HEADER_SIZE

public static final int FRAME_HEADER_SIZE

See Also:

Constant Field Values

FRAME_MIN_SIZE

public static final int FRAME_MIN_SIZE

See Also:

Constant Field Values

Constructor Detail

AMQDecoder

protected AMQDecoder(boolean expectProtocolInitiation,
                     T methodProcessor)

Creates a new AMQP decoder.

Parameters:

expectProtocolInitiation - true if this decoder needs to handle protocol initiation.

methodProcessor - method processor

Method Detail

setExpectProtocolInitiation

public void setExpectProtocolInitiation(boolean expectProtocolInitiation)

Sets the protocol initiation flag, that determines whether decoding is handled by the data decoder of the protocol initiation decoder. This method is expected to be called with false once protocol initiation completes.

Parameters:

expectProtocolInitiation - true to use the protocol initiation decoder, false to use the data decoder.

setMaxFrameSize

public void setMaxFrameSize(int frameMax)

getMethodProcessor

public T getMethodProcessor()

decode

protected final int decode(QpidByteBuffer buf)
                    throws AMQFrameDecodingException

Throws:

AMQFrameDecodingException

processAMQPFrames

protected int processAMQPFrames(QpidByteBuffer buf)
                         throws AMQFrameDecodingException

Throws:

AMQFrameDecodingException

decodable

protected int decodable(QpidByteBuffer in)
                 throws AMQFrameDecodingException

Throws:

AMQFrameDecodingException

processInput

protected void processInput(QpidByteBuffer in)
                     throws AMQFrameDecodingException,
                            AMQProtocolVersionException

Throws:

AMQFrameDecodingException

AMQProtocolVersionException

processFrame

protected void processFrame(int channel,
                            byte type,
                            long bodySize,
                            QpidByteBuffer in)
                     throws AMQFrameDecodingException

Throws:

AMQFrameDecodingException

processMethod

protected abstract void processMethod(int channelId,
                                      QpidByteBuffer in)
                               throws AMQFrameDecodingException

Throws:

AMQFrameDecodingException

newUnknownMethodException

protected AMQFrameDecodingException newUnknownMethodException(int classId,
                                                              int methodId,
                                                              ProtocolVersion protocolVersion)