org.apache.qpid.server.protocol.v0_8

Class AMQChannel<T extends AMQProtocolSession<T>>

java.lang.Object

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

All Implemented Interfaces:

Comparable<AMQChannel<T>>, AMQSessionModel<AMQChannel<T>,T>, AsyncAutoCommitTransaction.FutureRecorder, Deletable<AMQChannel<T>>

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PREFETCH

Constructor Summary

Constructors

Constructor and Description
AMQChannel(T session, int channelId, MessageStore messageStore)

Method Summary

Methods

Modifier and Type	Method and Description
void	acknowledgeMessage(long deliveryTag, boolean multiple) Acknowledge one or more messages.
void	addConsumerListener(ConsumerListener listener)
void	addDeleteTask(Action<? super AMQChannel<T>> task)
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)
void	close() Called from the protocol session to close this channel and clean up.
void	close(org.apache.qpid.protocol.AMQConstant cause, String message)
void	commit()
void	commit(Runnable immediateAction, boolean async)
int	compareTo(AMQChannel o)
org.apache.qpid.framing.AMQShortString	consumeFromSource(org.apache.qpid.framing.AMQShortString tag, MessageSource source, boolean acks, org.apache.qpid.framing.FieldTable filters, boolean exclusive, boolean noLocal) Subscribe to a queue.
void	deadLetter(long deliveryTag)
String	debugIdentity()
boolean	getBlocking()
int	getChannelId()
ClientDeliveryMethod	getClientDeliveryMethod()
String	getClientID()
T	getConnectionModel()
Object	getConnectionReference()
int	getConsumerCount()
Collection<Consumer<?>>	getConsumers()
FlowCreditManager	getCreditManager()
AMQQueue	getDefaultQueue()
UUID	getId()
LogSubject	getLogSubject()
MessageStore	getMessageStore()
Session<?>	getModelObject()
int	getNextConsumerTag()
long	getNextDeliveryTag()
AMQProtocolSession	getProtocolSession()
RecordDeliveryMethod	getRecordDeliveryMethod()
Subject	getSubject()
ConsumerImpl	getSubscription(org.apache.qpid.framing.AMQShortString tag)
long	getTransactionStartTime()
long	getTransactionUpdateTime()
Long	getTxnCommits()
Long	getTxnCount()
Long	getTxnRejects()
Long	getTxnStart()
int	getUnacknowledgedMessageCount()
UnacknowledgedMessageMap	getUnacknowledgedMessageMap() Used only for testing purposes.
VirtualHostImpl	getVirtualHost()
boolean	isClosing()
boolean	isDeliveredTooManyTimes(long deliveryTag)
boolean	isMaxDeliveryCountEnabled(long deliveryTag)
boolean	isSuspended()
boolean	isTransactional()
void	publishContentBody(org.apache.qpid.framing.ContentBody contentBody)
void	publishContentHeader(org.apache.qpid.framing.ContentHeaderBody contentHeaderBody)
void	receivedComplete()
void	recordFuture(StoreFuture future, ServerTransaction.Action action)
void	removeConsumerListener(ConsumerListener listener)
void	removeDeleteTask(Action<? super AMQChannel<T>> task)
void	requeue() Called to attempt re-delivery all outstanding unacknowledged messages on the channel.
void	requeue(long deliveryTag) Requeue a single message
void	resend() Called to resend all outstanding unacknowledged messages to this same channel.
void	rollback()
void	rollback(Runnable postRollbackTask)
void	setCredit(long prefetchSize, int prefetchCount)
void	setDefaultQueue(AMQQueue queue)
void	setLocalTransactional() Sets this channel to be part of a local transaction
void	setModelObject(Session<?> session)
void	setPublishFrame(org.apache.qpid.framing.abstraction.MessagePublishInfo info, MessageDestination e)
void	setSuspended(boolean suspended) Called from the ChannelFlowHandler to suspend this Channel
void	sync()
String	toString()
void	unblock()
void	unblock(AMQQueue queue)
boolean	unsubscribeConsumer(org.apache.qpid.framing.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(T session,
          int channelId,
          MessageStore messageStore)
           throws org.apache.qpid.AMQException

Throws:

org.apache.qpid.AMQException

Method Detail

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<T extends AMQProtocolSession<T>>,T extends AMQProtocolSession<T>>

getTxnRejects

public Long getTxnRejects()

Specified by:

getTxnRejects in interface AMQSessionModel<AMQChannel<T extends AMQProtocolSession<T>>,T extends AMQProtocolSession<T>>

getTxnCount

public Long getTxnCount()

Specified by:

getTxnCount in interface AMQSessionModel<AMQChannel<T extends AMQProtocolSession<T>>,T extends AMQProtocolSession<T>>

getTxnStart

public Long getTxnStart()

Specified by:

getTxnStart in interface AMQSessionModel<AMQChannel<T extends AMQProtocolSession<T>>,T extends AMQProtocolSession<T>>

getChannelId

public int getChannelId()

Specified by:

getChannelId in interface AMQSessionModel<AMQChannel<T extends AMQProtocolSession<T>>,T extends AMQProtocolSession<T>>

setPublishFrame

public void setPublishFrame(org.apache.qpid.framing.abstraction.MessagePublishInfo info,
                   MessageDestination e)

publishContentHeader

public void publishContentHeader(org.apache.qpid.framing.ContentHeaderBody contentHeaderBody)
                          throws org.apache.qpid.AMQException

Throws:

org.apache.qpid.AMQException

publishContentBody

public void publishContentBody(org.apache.qpid.framing.ContentBody contentBody)
                        throws org.apache.qpid.AMQException

Throws:

org.apache.qpid.AMQException

getNextDeliveryTag

public long getNextDeliveryTag()

getNextConsumerTag

public int getNextConsumerTag()

getSubscription

public ConsumerImpl getSubscription(org.apache.qpid.framing.AMQShortString tag)

consumeFromSource

public org.apache.qpid.framing.AMQShortString consumeFromSource(org.apache.qpid.framing.AMQShortString tag,
                                                       MessageSource source,
                                                       boolean acks,
                                                       org.apache.qpid.framing.FieldTable filters,
                                                       boolean exclusive,
                                                       boolean noLocal)
                                                         throws org.apache.qpid.AMQException,
                                                                MessageSource.ExistingConsumerPreventsExclusive,
                                                                MessageSource.ExistingExclusiveConsumer,
                                                                AMQInvalidArgumentException,
                                                                MessageSource.ConsumerAccessRefused

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)

source - the queue to subscribe to

acks - Are acks enabled for this subscriber

filters - 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:

org.apache.qpid.AMQException - if something goes wrong

MessageSource.ExistingConsumerPreventsExclusive

MessageSource.ExistingExclusiveConsumer

AMQInvalidArgumentException

MessageSource.ConsumerAccessRefused

unsubscribeConsumer

public boolean unsubscribeConsumer(org.apache.qpid.framing.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()

Called from the protocol session to close this channel and clean up. T

Specified by:

close in interface AMQSessionModel<AMQChannel<T extends AMQProtocolSession<T>>,T extends AMQProtocolSession<T>>

close

public void close(org.apache.qpid.protocol.AMQConstant cause,
         String message)

Specified by:

close in interface AMQSessionModel<AMQChannel<T extends AMQProtocolSession<T>>,T extends AMQProtocolSession<T>>

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()

Called to attempt re-delivery all outstanding unacknowledged messages on the channel. May result in delivery to this same channel or to other subscribers.

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)

resend

public void resend()
            throws org.apache.qpid.AMQException

Called to resend all outstanding unacknowledged messages to this same channel.

Throws:

org.apache.qpid.AMQException - When something goes wrong.

acknowledgeMessage

public void acknowledgeMessage(long deliveryTag,
                      boolean multiple)
                        throws org.apache.qpid.AMQException

Acknowledge one or more messages.

Parameters:

deliveryTag - the last delivery tag

multiple - if true will acknowledge all messages up to an including the delivery tag. if false only acknowledges the single message specified by the delivery tag

Throws:

org.apache.qpid.AMQException - if the delivery tag is unknown (e.g. not outstanding) on this channel

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()
            throws org.apache.qpid.AMQException

Throws:

org.apache.qpid.AMQException

commit

public void commit(Runnable immediateAction,
          boolean async)
            throws org.apache.qpid.AMQException

Throws:

org.apache.qpid.AMQException

rollback

public void rollback()
              throws org.apache.qpid.AMQException

Throws:

org.apache.qpid.AMQException

rollback

public void rollback(Runnable postRollbackTask)
              throws org.apache.qpid.AMQException

Throws:

org.apache.qpid.AMQException

toString

public String toString()

Overrides:

toString in class Object

setDefaultQueue

public void setDefaultQueue(AMQQueue queue)

getDefaultQueue

public AMQQueue getDefaultQueue()

isClosing

public boolean isClosing()

getProtocolSession

public AMQProtocolSession getProtocolSession()

getCreditManager

public FlowCreditManager getCreditManager()

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<T extends AMQProtocolSession<T>>,T extends AMQProtocolSession<T>>

getConnectionModel

public T getConnectionModel()

Specified by:

getConnectionModel in interface AMQSessionModel<AMQChannel<T extends AMQProtocolSession<T>>,T extends AMQProtocolSession<T>>

getClientID

public String getClientID()

Specified by:

getClientID in interface AMQSessionModel<AMQChannel<T extends AMQProtocolSession<T>>,T extends AMQProtocolSession<T>>

getLogSubject

public LogSubject getLogSubject()

Specified by:

getLogSubject in interface AMQSessionModel<AMQChannel<T extends AMQProtocolSession<T>>,T extends AMQProtocolSession<T>>

compareTo

public int compareTo(AMQChannel o)

Specified by:

compareTo in interface Comparable<AMQChannel<T extends AMQProtocolSession<T>>>

addDeleteTask

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

Specified by:

addDeleteTask in interface Deletable<AMQChannel<T extends AMQProtocolSession<T>>>

removeDeleteTask

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

Specified by:

removeDeleteTask in interface Deletable<AMQChannel<T extends AMQProtocolSession<T>>>

getSubject

public Subject getSubject()

block

public void block()

Specified by:

block in interface AMQSessionModel<AMQChannel<T extends AMQProtocolSession<T>>,T extends AMQProtocolSession<T>>

unblock

public void unblock()

Specified by:

unblock in interface AMQSessionModel<AMQChannel<T extends AMQProtocolSession<T>>,T extends AMQProtocolSession<T>>

block

public void block(AMQQueue queue)

Specified by:

block in interface AMQSessionModel<AMQChannel<T extends AMQProtocolSession<T>>,T extends AMQProtocolSession<T>>

unblock

public void unblock(AMQQueue queue)

Specified by:

unblock in interface AMQSessionModel<AMQChannel<T extends AMQProtocolSession<T>>,T extends AMQProtocolSession<T>>

getConnectionReference

public Object getConnectionReference()

Specified by:

getConnectionReference in interface AMQSessionModel<AMQChannel<T extends AMQProtocolSession<T>>,T extends AMQProtocolSession<T>>

getUnacknowledgedMessageCount

public int getUnacknowledgedMessageCount()

Specified by:

getUnacknowledgedMessageCount in interface AMQSessionModel<AMQChannel<T extends AMQProtocolSession<T>>,T extends AMQProtocolSession<T>>

getBlocking

public boolean getBlocking()

Specified by:

getBlocking in interface AMQSessionModel<AMQChannel<T extends AMQProtocolSession<T>>,T extends AMQProtocolSession<T>>

getVirtualHost

public VirtualHostImpl getVirtualHost()

checkTransactionStatus

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

Specified by:

checkTransactionStatus in interface AMQSessionModel<AMQChannel<T extends AMQProtocolSession<T>>,T extends AMQProtocolSession<T>>

deadLetter

public void deadLetter(long deliveryTag)
                throws org.apache.qpid.AMQException

Throws:

org.apache.qpid.AMQException

recordFuture

public void recordFuture(StoreFuture 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<T extends AMQProtocolSession<T>>,T extends AMQProtocolSession<T>>

getConsumers

public Collection<Consumer<?>> getConsumers()

Specified by:

getConsumers in interface AMQSessionModel<AMQChannel<T extends AMQProtocolSession<T>>,T extends AMQProtocolSession<T>>

addConsumerListener

public void addConsumerListener(ConsumerListener listener)

Specified by:

addConsumerListener in interface AMQSessionModel<AMQChannel<T extends AMQProtocolSession<T>>,T extends AMQProtocolSession<T>>

removeConsumerListener

public void removeConsumerListener(ConsumerListener listener)

Specified by:

removeConsumerListener in interface AMQSessionModel<AMQChannel<T extends AMQProtocolSession<T>>,T extends AMQProtocolSession<T>>

setModelObject

public void setModelObject(Session<?> session)

Specified by:

setModelObject in interface AMQSessionModel<AMQChannel<T extends AMQProtocolSession<T>>,T extends AMQProtocolSession<T>>

getModelObject

public Session<?> getModelObject()

Specified by:

getModelObject in interface AMQSessionModel<AMQChannel<T extends AMQProtocolSession<T>>,T extends AMQProtocolSession<T>>

getTransactionStartTime

public long getTransactionStartTime()

Specified by:

getTransactionStartTime in interface AMQSessionModel<AMQChannel<T extends AMQProtocolSession<T>>,T extends AMQProtocolSession<T>>

getTransactionUpdateTime

public long getTransactionUpdateTime()

Specified by:

getTransactionUpdateTime in interface AMQSessionModel<AMQChannel<T extends AMQProtocolSession<T>>,T extends AMQProtocolSession<T>>