org.apache.qpid.server.protocol.v0_8

Class AMQChannel

java.lang.Object

org.apache.qpid.server.protocol.v0_8.AMQChannel

All Implemented Interfaces:

Comparable<AMQSessionModel>, ChannelMethodProcessor, ServerChannelMethodProcessor, AMQSessionModel<AMQChannel>, AsyncAutoCommitTransaction.FutureRecorder, Deletable<AMQChannel>

public class AMQChannel
extends Object
implements AMQSessionModel<AMQChannel>, AsyncAutoCommitTransaction.FutureRecorder, ServerChannelMethodProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PREFETCH

Constructor Summary

Constructors

Constructor and Description
AMQChannel(AMQPConnection_0_8 connection, int channelId, MessageStore messageStore)

Method Summary

Modifier and Type	Method and Description
void	addConsumerListener(ConsumerListener listener)
void	addDeleteTask(Action<? super AMQChannel> task)
void	addTicker(Ticker ticker)
void	addUnacknowledgedMessage(MessageInstance entry, long deliveryTag, ConsumerImpl consumer) Add a message to the channel-based list of unacknowledged messages
void	block()
void	block(AMQQueue queue)
void	checkTransactionStatus(long openWarn, long openClose, long idleWarn, long idleClose) This method is called from the housekeeping thread to check the status of transactions on this session and react appropriately.
void	close()
void	close(AMQConstant cause, String message)
void	commit(Runnable immediateAction, boolean async)
int	compareTo(AMQSessionModel o)
AMQShortString	consumeFromSource(AMQShortString tag, Collection<MessageSource> sources, boolean acks, FieldTable arguments, boolean exclusive, boolean noLocal) Subscribe to a queue.
String	debugIdentity()
void	ensureConsumersNoticedStateChange()
AccessControlContext	getAccessControllerContext()
AMQPConnection<?>	getAMQPConnection()
boolean	getBlocking()
int	getChannelId()
ClientDeliveryMethod	getClientDeliveryMethod()
String	getClientID()
AMQPConnection_0_8	getConnection()
Object	getConnectionReference()
int	getConsumerCount()
Collection<Consumer<?>>	getConsumers()
UUID	getId()
LogSubject	getLogSubject()
long	getMaxUncommittedInMemorySize()
MessageStore	getMessageStore()
Session<?>	getModelObject()
int	getNextConsumerTag()
long	getNextDeliveryTag()
RecordDeliveryMethod	getRecordDeliveryMethod()
Subject	getSubject()
ConsumerTarget	getSubscription(AMQShortString tag)
long	getTransactionStartTime() Return the time the current transaction started.
long	getTransactionUpdateTime() Return the time of the last activity on the current transaction.
Long	getTxnCommits()
Long	getTxnCount()
Long	getTxnRejects()
Long	getTxnStart()
int	getUnacknowledgedMessageCount()
UnacknowledgedMessageMap	getUnacknowledgedMessageMap() Used only for testing purposes.
VirtualHostImpl	getVirtualHost()
boolean	hasCurrentMessage()
boolean	ignoreAllButCloseOk()
boolean	isClosing()
boolean	isDeliveredTooManyTimes(long deliveryTag)
boolean	isMaxDeliveryCountEnabled(long deliveryTag)
boolean	isSuspended()
boolean	isTransactional()
void	notifyConsumerTargetCurrentStates()
boolean	processPending()
void	publishContentBody(ContentBody contentBody)
void	publishContentHeader(ContentHeaderBody contentHeaderBody)
void	receiveAccessRequest(AMQShortString realm, boolean exclusive, boolean passive, boolean active, boolean write, boolean read)
void	receiveBasicAck(long deliveryTag, boolean multiple)
void	receiveBasicCancel(AMQShortString consumerTag, boolean nowait)
void	receiveBasicConsume(AMQShortString queue, AMQShortString consumerTag, boolean noLocal, boolean noAck, boolean exclusive, boolean nowait, FieldTable arguments)
void	receiveBasicGet(AMQShortString queueName, boolean noAck)
void	receiveBasicNack(long deliveryTag, boolean multiple, boolean requeue)
void	receiveBasicPublish(AMQShortString exchangeName, AMQShortString routingKey, boolean mandatory, boolean immediate)
void	receiveBasicQos(long prefetchSize, int prefetchCount, boolean global)
void	receiveBasicRecover(boolean requeue, boolean sync)
void	receiveBasicReject(long deliveryTag, boolean requeue)
void	receiveChannelClose(int replyCode, AMQShortString replyText, int classId, int methodId)
void	receiveChannelCloseOk()
void	receiveChannelFlow(boolean active)
void	receiveChannelFlowOk(boolean active)
void	receiveConfirmSelect(boolean nowait)
void	receivedComplete()
void	receiveExchangeBound(AMQShortString exchangeName, AMQShortString routingKey, AMQShortString queueName)
void	receiveExchangeDeclare(AMQShortString exchangeName, AMQShortString type, boolean passive, boolean durable, boolean autoDelete, boolean internal, boolean nowait, FieldTable arguments)
void	receiveExchangeDelete(AMQShortString exchangeStr, boolean ifUnused, boolean nowait)
void	receiveMessageContent(QpidByteBuffer data)
void	receiveMessageHeader(BasicContentHeaderProperties properties, long bodySize)
void	receiveQueueBind(AMQShortString queueName, AMQShortString exchange, AMQShortString routingKey, boolean nowait, FieldTable argumentsTable)
void	receiveQueueDeclare(AMQShortString queueStr, boolean passive, boolean durable, boolean exclusive, boolean autoDelete, boolean nowait, FieldTable arguments)
void	receiveQueueDelete(AMQShortString queueName, boolean ifUnused, boolean ifEmpty, boolean nowait)
void	receiveQueuePurge(AMQShortString queueName, boolean nowait)
void	receiveQueueUnbind(AMQShortString queueName, AMQShortString exchange, AMQShortString bindingKey, FieldTable arguments)
void	receiveTxCommit()
void	receiveTxRollback()
void	receiveTxSelect()
void	recordFuture(com.google.common.util.concurrent.ListenableFuture<Void> future, ServerTransaction.Action action)
void	removeConsumerListener(ConsumerListener listener)
void	removeDeleteTask(Action<? super AMQChannel> task)
void	removeTicker(Ticker ticker)
void	requeue(long deliveryTag) Requeue a single message
void	setCredit(long prefetchSize, int prefetchCount)
void	setLocalTransactional() Sets this channel to be part of a local transaction
void	setModelObject(Session<?> session)
void	setPublishFrame(MessagePublishInfo info, MessageDestination e)
void	setSuspended(boolean suspended) Called from the ChannelFlowHandler to suspend this Channel
void	sync()
String	toString()
void	transportStateChanged()
void	unblock()
void	unblock(AMQQueue queue)
boolean	unsubscribeConsumer(AMQShortString consumerTag) Unsubscribe a consumer from a queue.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PREFETCH

public static final int DEFAULT_PREFETCH

See Also:

Constant Field Values

Constructor Detail

AMQChannel

public AMQChannel(AMQPConnection_0_8 connection,
                  int channelId,
                  MessageStore messageStore)

Method Detail

getAccessControllerContext

public AccessControlContext getAccessControllerContext()

setLocalTransactional

public void setLocalTransactional()

Sets this channel to be part of a local transaction

isTransactional

public boolean isTransactional()

receivedComplete

public void receivedComplete()

getTxnCommits

public Long getTxnCommits()

Specified by:

getTxnCommits in interface AMQSessionModel<AMQChannel>

getTxnRejects

public Long getTxnRejects()

Specified by:

getTxnRejects in interface AMQSessionModel<AMQChannel>

getTxnCount

public Long getTxnCount()

Specified by:

getTxnCount in interface AMQSessionModel<AMQChannel>

getTxnStart

public Long getTxnStart()

Specified by:

getTxnStart in interface AMQSessionModel<AMQChannel>

getChannelId

public int getChannelId()

Specified by:

getChannelId in interface AMQSessionModel<AMQChannel>

setPublishFrame

public void setPublishFrame(MessagePublishInfo info,
                            MessageDestination e)

publishContentHeader

public void publishContentHeader(ContentHeaderBody contentHeaderBody)

publishContentBody

public void publishContentBody(ContentBody contentBody)

getNextDeliveryTag

public long getNextDeliveryTag()

getNextConsumerTag

public int getNextConsumerTag()

getSubscription

public ConsumerTarget getSubscription(AMQShortString tag)

consumeFromSource

public AMQShortString consumeFromSource(AMQShortString tag,
                                        Collection<MessageSource> sources,
                                        boolean acks,
                                        FieldTable arguments,
                                        boolean exclusive,
                                        boolean noLocal)
                                 throws MessageSource.ExistingConsumerPreventsExclusive,
                                        MessageSource.ExistingExclusiveConsumer,
                                        AMQInvalidArgumentException,
                                        MessageSource.ConsumerAccessRefused,
                                        ConsumerTagInUseException

Subscribe to a queue. We register all subscriptions in the channel so that if the channel is closed we can clean up all subscriptions, even if the client does not explicitly unsubscribe from all queues.

Parameters:

tag - the tag chosen by the client (if null, server will generate one)

sources - the queues to subscribe to

acks - Are acks enabled for this subscriber

arguments - Filters to apply to this subscriber

exclusive - Flag requesting exclusive access to the queue

Returns:

the consumer tag. This is returned to the subscriber and used in subsequent unsubscribe requests

Throws:

MessageSource.ExistingConsumerPreventsExclusive

MessageSource.ExistingExclusiveConsumer

AMQInvalidArgumentException

MessageSource.ConsumerAccessRefused

ConsumerTagInUseException

unsubscribeConsumer

public boolean unsubscribeConsumer(AMQShortString consumerTag)

Unsubscribe a consumer from a queue.

Parameters:

consumerTag -

Returns:

true if the consumerTag had a mapped queue that could be unregistered.

close

public void close()

Specified by:

close in interface AMQSessionModel<AMQChannel>

close

public void close(AMQConstant cause,
                  String message)

Specified by:

close in interface AMQSessionModel<AMQChannel>

addUnacknowledgedMessage

public void addUnacknowledgedMessage(MessageInstance entry,
                                     long deliveryTag,
                                     ConsumerImpl consumer)

Add a message to the channel-based list of unacknowledged messages

Parameters:

entry - the record of the message on the queue that was delivered

deliveryTag - the delivery tag used when delivering the message (see protocol spec for description of the delivery tag)

consumer - The consumer that is to acknowledge this message.

debugIdentity

public String debugIdentity()

requeue

public void requeue(long deliveryTag)

Requeue a single message

Parameters:

deliveryTag - The message to requeue

isMaxDeliveryCountEnabled

public boolean isMaxDeliveryCountEnabled(long deliveryTag)

isDeliveredTooManyTimes

public boolean isDeliveredTooManyTimes(long deliveryTag)

getUnacknowledgedMessageMap

public UnacknowledgedMessageMap getUnacknowledgedMessageMap()

Used only for testing purposes.

Returns:

the map of unacknowledged messages

setSuspended

public void setSuspended(boolean suspended)

Called from the ChannelFlowHandler to suspend this Channel

Parameters:

suspended - boolean, should this Channel be suspended

isSuspended

public boolean isSuspended()

commit

public void commit(Runnable immediateAction,
                   boolean async)

toString

public String toString()

Overrides:

toString in class Object

isClosing

public boolean isClosing()

getConnection

public AMQPConnection_0_8 getConnection()

setCredit

public void setCredit(long prefetchSize,
                      int prefetchCount)

getMessageStore

public MessageStore getMessageStore()

getClientDeliveryMethod

public ClientDeliveryMethod getClientDeliveryMethod()

getRecordDeliveryMethod

public RecordDeliveryMethod getRecordDeliveryMethod()

getId

public UUID getId()

Specified by:

getId in interface AMQSessionModel<AMQChannel>

getAMQPConnection

public AMQPConnection<?> getAMQPConnection()

Specified by:

getAMQPConnection in interface AMQSessionModel<AMQChannel>

getClientID

public String getClientID()

Specified by:

getClientID in interface AMQSessionModel<AMQChannel>

getLogSubject

public LogSubject getLogSubject()

Specified by:

getLogSubject in interface AMQSessionModel<AMQChannel>

compareTo

public int compareTo(AMQSessionModel o)

Specified by:

compareTo in interface Comparable<AMQSessionModel>

addDeleteTask

public void addDeleteTask(Action<? super AMQChannel> task)

Specified by:

addDeleteTask in interface Deletable<AMQChannel>

removeDeleteTask

public void removeDeleteTask(Action<? super AMQChannel> task)

Specified by:

removeDeleteTask in interface Deletable<AMQChannel>

getSubject

public Subject getSubject()

hasCurrentMessage

public boolean hasCurrentMessage()

getMaxUncommittedInMemorySize

public long getMaxUncommittedInMemorySize()

block

public void block()

Specified by:

block in interface AMQSessionModel<AMQChannel>

unblock

public void unblock()

Specified by:

unblock in interface AMQSessionModel<AMQChannel>

block

public void block(AMQQueue queue)

Specified by:

block in interface AMQSessionModel<AMQChannel>

unblock

public void unblock(AMQQueue queue)

Specified by:

unblock in interface AMQSessionModel<AMQChannel>

transportStateChanged

public void transportStateChanged()

Specified by:

transportStateChanged in interface AMQSessionModel<AMQChannel>

getConnectionReference

public Object getConnectionReference()

Specified by:

getConnectionReference in interface AMQSessionModel<AMQChannel>

getUnacknowledgedMessageCount

public int getUnacknowledgedMessageCount()

Specified by:

getUnacknowledgedMessageCount in interface AMQSessionModel<AMQChannel>

getBlocking

public boolean getBlocking()

Specified by:

getBlocking in interface AMQSessionModel<AMQChannel>

getVirtualHost

public VirtualHostImpl getVirtualHost()

checkTransactionStatus

public void checkTransactionStatus(long openWarn,
                                   long openClose,
                                   long idleWarn,
                                   long idleClose)

Description copied from interface: AMQSessionModel

This method is called from the housekeeping thread to check the status of transactions on this session and react appropriately. If a transaction is open for too long or idle for too long then a warning is logged or the connection is closed, depending on the configuration. An open transaction is one that has recent activity. The transaction age is counted from the time the transaction was started. An idle transaction is one that has had no activity, such as publishing or acknowledging messages.

Specified by:

checkTransactionStatus in interface AMQSessionModel<AMQChannel>

Parameters:

openWarn - time in milliseconds before alerting on open transaction

openClose - time in milliseconds before closing connection with open transaction

idleWarn - time in milliseconds before alerting on idle transaction

idleClose - time in milliseconds before closing connection with idle transaction

recordFuture

public void recordFuture(com.google.common.util.concurrent.ListenableFuture<Void> future,
                         ServerTransaction.Action action)

Specified by:

recordFuture in interface AsyncAutoCommitTransaction.FutureRecorder

sync

public void sync()

getConsumerCount

public int getConsumerCount()

Specified by:

getConsumerCount in interface AMQSessionModel<AMQChannel>

getConsumers

public Collection<Consumer<?>> getConsumers()

Specified by:

getConsumers in interface AMQSessionModel<AMQChannel>

addConsumerListener

public void addConsumerListener(ConsumerListener listener)

Specified by:

addConsumerListener in interface AMQSessionModel<AMQChannel>

removeConsumerListener

public void removeConsumerListener(ConsumerListener listener)

Specified by:

removeConsumerListener in interface AMQSessionModel<AMQChannel>

setModelObject

public void setModelObject(Session<?> session)

Specified by:

setModelObject in interface AMQSessionModel<AMQChannel>

getModelObject

public Session<?> getModelObject()

Specified by:

getModelObject in interface AMQSessionModel<AMQChannel>

getTransactionStartTime

public long getTransactionStartTime()

Description copied from interface: AMQSessionModel

Return the time the current transaction started.

Specified by:

getTransactionStartTime in interface AMQSessionModel<AMQChannel>

Returns:

the time this transaction started or 0 if not in a transaction

getTransactionUpdateTime

public long getTransactionUpdateTime()

Description copied from interface: AMQSessionModel

Return the time of the last activity on the current transaction.

Specified by:

getTransactionUpdateTime in interface AMQSessionModel<AMQChannel>

Returns:

the time of the last activity or 0 if not in a transaction

receiveAccessRequest

public void receiveAccessRequest(AMQShortString realm,
                                 boolean exclusive,
                                 boolean passive,
                                 boolean active,
                                 boolean write,
                                 boolean read)

Specified by:

receiveAccessRequest in interface ServerChannelMethodProcessor

receiveBasicAck

public void receiveBasicAck(long deliveryTag,
                            boolean multiple)

Specified by:

receiveBasicAck in interface ChannelMethodProcessor

Specified by:

receiveBasicAck in interface ServerChannelMethodProcessor

receiveBasicCancel

public void receiveBasicCancel(AMQShortString consumerTag,
                               boolean nowait)

Specified by:

receiveBasicCancel in interface ServerChannelMethodProcessor

receiveBasicConsume

public void receiveBasicConsume(AMQShortString queue,
                                AMQShortString consumerTag,
                                boolean noLocal,
                                boolean noAck,
                                boolean exclusive,
                                boolean nowait,
                                FieldTable arguments)

Specified by:

receiveBasicConsume in interface ServerChannelMethodProcessor

receiveBasicGet

public void receiveBasicGet(AMQShortString queueName,
                            boolean noAck)

Specified by:

receiveBasicGet in interface ServerChannelMethodProcessor

receiveBasicPublish

public void receiveBasicPublish(AMQShortString exchangeName,
                                AMQShortString routingKey,
                                boolean mandatory,
                                boolean immediate)

Specified by:

receiveBasicPublish in interface ServerChannelMethodProcessor

receiveBasicQos

public void receiveBasicQos(long prefetchSize,
                            int prefetchCount,
                            boolean global)

Specified by:

receiveBasicQos in interface ServerChannelMethodProcessor

receiveBasicRecover

public void receiveBasicRecover(boolean requeue,
                                boolean sync)

Specified by:

receiveBasicRecover in interface ServerChannelMethodProcessor

receiveBasicReject

public void receiveBasicReject(long deliveryTag,
                               boolean requeue)

Specified by:

receiveBasicReject in interface ServerChannelMethodProcessor

receiveChannelClose

public void receiveChannelClose(int replyCode,
                                AMQShortString replyText,
                                int classId,
                                int methodId)

Specified by:

receiveChannelClose in interface ChannelMethodProcessor

receiveChannelCloseOk

public void receiveChannelCloseOk()

Specified by:

receiveChannelCloseOk in interface ChannelMethodProcessor

receiveMessageContent

public void receiveMessageContent(QpidByteBuffer data)

Specified by:

receiveMessageContent in interface ChannelMethodProcessor

receiveMessageHeader

public void receiveMessageHeader(BasicContentHeaderProperties properties,
                                 long bodySize)

Specified by:

receiveMessageHeader in interface ChannelMethodProcessor

ignoreAllButCloseOk

public boolean ignoreAllButCloseOk()

Specified by:

ignoreAllButCloseOk in interface ChannelMethodProcessor

receiveBasicNack

public void receiveBasicNack(long deliveryTag,
                             boolean multiple,
                             boolean requeue)

Specified by:

receiveBasicNack in interface ChannelMethodProcessor

receiveChannelFlow

public void receiveChannelFlow(boolean active)

Specified by:

receiveChannelFlow in interface ChannelMethodProcessor

receiveChannelFlowOk

public void receiveChannelFlowOk(boolean active)

Specified by:

receiveChannelFlowOk in interface ChannelMethodProcessor

receiveExchangeBound

public void receiveExchangeBound(AMQShortString exchangeName,
                                 AMQShortString routingKey,
                                 AMQShortString queueName)

Specified by:

receiveExchangeBound in interface ServerChannelMethodProcessor

receiveExchangeDeclare

public void receiveExchangeDeclare(AMQShortString exchangeName,
                                   AMQShortString type,
                                   boolean passive,
                                   boolean durable,
                                   boolean autoDelete,
                                   boolean internal,
                                   boolean nowait,
                                   FieldTable arguments)

Specified by:

receiveExchangeDeclare in interface ServerChannelMethodProcessor

receiveExchangeDelete

public void receiveExchangeDelete(AMQShortString exchangeStr,
                                  boolean ifUnused,
                                  boolean nowait)

Specified by:

receiveExchangeDelete in interface ServerChannelMethodProcessor

receiveQueueBind

public void receiveQueueBind(AMQShortString queueName,
                             AMQShortString exchange,
                             AMQShortString routingKey,
                             boolean nowait,
                             FieldTable argumentsTable)

Specified by:

receiveQueueBind in interface ServerChannelMethodProcessor

receiveQueueDeclare

public void receiveQueueDeclare(AMQShortString queueStr,
                                boolean passive,
                                boolean durable,
                                boolean exclusive,
                                boolean autoDelete,
                                boolean nowait,
                                FieldTable arguments)

Specified by:

receiveQueueDeclare in interface ServerChannelMethodProcessor

receiveQueueDelete

public void receiveQueueDelete(AMQShortString queueName,
                               boolean ifUnused,
                               boolean ifEmpty,
                               boolean nowait)

Specified by:

receiveQueueDelete in interface ServerChannelMethodProcessor

receiveQueuePurge

public void receiveQueuePurge(AMQShortString queueName,
                              boolean nowait)

Specified by:

receiveQueuePurge in interface ServerChannelMethodProcessor

receiveQueueUnbind

public void receiveQueueUnbind(AMQShortString queueName,
                               AMQShortString exchange,
                               AMQShortString bindingKey,
                               FieldTable arguments)

Specified by:

receiveQueueUnbind in interface ServerChannelMethodProcessor

receiveTxSelect

public void receiveTxSelect()

Specified by:

receiveTxSelect in interface ServerChannelMethodProcessor

receiveTxCommit

public void receiveTxCommit()

Specified by:

receiveTxCommit in interface ServerChannelMethodProcessor

receiveTxRollback

public void receiveTxRollback()

Specified by:

receiveTxRollback in interface ServerChannelMethodProcessor

receiveConfirmSelect

public void receiveConfirmSelect(boolean nowait)

Specified by:

receiveConfirmSelect in interface ServerChannelMethodProcessor

processPending

public boolean processPending()

Specified by:

processPending in interface AMQSessionModel<AMQChannel>

addTicker

public void addTicker(Ticker ticker)

Specified by:

addTicker in interface AMQSessionModel<AMQChannel>

removeTicker

public void removeTicker(Ticker ticker)

Specified by:

removeTicker in interface AMQSessionModel<AMQChannel>

notifyConsumerTargetCurrentStates

public void notifyConsumerTargetCurrentStates()

Specified by:

notifyConsumerTargetCurrentStates in interface AMQSessionModel<AMQChannel>

ensureConsumersNoticedStateChange

public void ensureConsumersNoticedStateChange()

Specified by:

ensureConsumersNoticedStateChange in interface AMQSessionModel<AMQChannel>