org.apache.activemq.artemis.core.client.impl

Class ClientConsumerImpl

java.lang.Object

org.apache.activemq.artemis.core.client.impl.ClientConsumerImpl

All Implemented Interfaces:

AutoCloseable, ClientConsumer, ClientConsumerInternal

public final class ClientConsumerImpl
extends Object
implements ClientConsumerInternal

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.activemq.artemis.api.core.SimpleString	FORCED_DELIVERY_MESSAGE

Constructor Summary

Constructors

Constructor and Description

ClientConsumerImpl(ClientSessionInternal session, ConsumerContext consumerContext, org.apache.activemq.artemis.api.core.SimpleString queueName, org.apache.activemq.artemis.api.core.SimpleString filterString, boolean browseOnly, int clientWindowSize, int ackBatchSize, TokenBucketLimiter rateLimiter, Executor executor, Executor flowControlExecutor, SessionContext sessionContext, ClientSession.QueueQuery queueInfo, ClassLoader contextClassLoader)

Method Summary

Modifier and Type	Method and Description
void	acknowledge(ClientMessage message)
void	cleanUp()
void	clear(boolean waitForOnMessage)
void	clearAtFailover()
void	close() Closes the consumer.
void	flowControl(int messageBytes, boolean discountSlowConsumer) LargeMessageBuffer will call flowcontrol here, while other handleMessage will also be calling flowControl.
void	flushAcks()
int	getBufferSize()
int	getClientWindowSize()
ConsumerContext	getConsumerContext() The server's ID associated with this consumer.
org.apache.activemq.artemis.api.core.SimpleString	getFilterString()
Exception	getLastException() Returns the last exception thrown by a call to this consumer's MessageHandler.
MessageHandler	getMessageHandler() Returns the MessageHandler associated to this consumer.
ClientSession.QueueQuery	getQueueInfo()
org.apache.activemq.artemis.api.core.SimpleString	getQueueName()
void	handleLargeMessage(ClientLargeMessageInternal clientLargeMessage, long largeMessageSize)
void	handleLargeMessageContinuation(byte[] chunk, int flowControlSize, boolean isContinues)
void	handleMessage(ClientMessageInternal message)
void	individualAcknowledge(ClientMessage message)
boolean	isBrowseOnly()
boolean	isClosed() Returns whether the consumer is closed or not.
Thread	prepareForClose(FutureLatch future) To be used by MDBs to stop any more handling of messages.
ClientMessage	receive() Receives a message from a queue.
ClientMessage	receive(long timeout) Receives a message from a queue.
ClientMessage	receiveImmediate() Receives a message from a queue.
ClientConsumerImpl	setMessageHandler(MessageHandler theHandler) Sets the MessageHandler for this consumer to consume messages asynchronously.
void	start()
void	stop(boolean waitForOnMessage)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

FORCED_DELIVERY_MESSAGE

public static final org.apache.activemq.artemis.api.core.SimpleString FORCED_DELIVERY_MESSAGE

Constructor Detail

ClientConsumerImpl

public ClientConsumerImpl(ClientSessionInternal session,
                          ConsumerContext consumerContext,
                          org.apache.activemq.artemis.api.core.SimpleString queueName,
                          org.apache.activemq.artemis.api.core.SimpleString filterString,
                          boolean browseOnly,
                          int clientWindowSize,
                          int ackBatchSize,
                          TokenBucketLimiter rateLimiter,
                          Executor executor,
                          Executor flowControlExecutor,
                          SessionContext sessionContext,
                          ClientSession.QueueQuery queueInfo,
                          ClassLoader contextClassLoader)

Method Detail

getConsumerContext

public ConsumerContext getConsumerContext()

Description copied from interface: ClientConsumer

The server's ID associated with this consumer. ActiveMQ Artemis implements this as a long but this could be protocol dependent.

Specified by:

getConsumerContext in interface ClientConsumer

Returns:

receive

public ClientMessage receive(long timeout)
                      throws org.apache.activemq.artemis.api.core.ActiveMQException

Description copied from interface: ClientConsumer

Receives a message from a queue.

This call will block until a message is received or the given timeout expires.

Calling this method on a closed consumer will throw an ActiveMQException.

Specified by:

receive in interface ClientConsumer

Parameters:

timeout - time (in milliseconds) to wait to receive a message

Returns:

a message or null if the time out expired

Throws:

org.apache.activemq.artemis.api.core.ActiveMQException - if an exception occurs while waiting to receive a message

receive

public ClientMessage receive()
                      throws org.apache.activemq.artemis.api.core.ActiveMQException

Description copied from interface: ClientConsumer

Receives a message from a queue.

This call will block indefinitely until a message is received.

Calling this method on a closed consumer will throw an ActiveMQException.

Specified by:

receive in interface ClientConsumer

Returns:

a ClientMessage

Throws:

org.apache.activemq.artemis.api.core.ActiveMQException - if an exception occurs while waiting to receive a message

receiveImmediate

public ClientMessage receiveImmediate()
                               throws org.apache.activemq.artemis.api.core.ActiveMQException

Description copied from interface: ClientConsumer

Receives a message from a queue. This call will force a network trip to ActiveMQ Artemis server to ensure that there are no messages in the queue which can be delivered to this consumer.

This call will never wait indefinitely for a message, it will return null if no messages are available for this consumer.

Note however that there is a performance cost as an additional network trip to the server may required to check the queue status.

Calling this method on a closed consumer will throw an ActiveMQException.

Specified by:

receiveImmediate in interface ClientConsumer

Returns:

a message or null if there are no messages in the queue for this consumer

Throws:

org.apache.activemq.artemis.api.core.ActiveMQException - if an exception occurs while waiting to receive a message

getMessageHandler

public MessageHandler getMessageHandler()
                                 throws org.apache.activemq.artemis.api.core.ActiveMQException

Description copied from interface: ClientConsumer

Returns the MessageHandler associated to this consumer.

Calling this method on a closed consumer will throw an ActiveMQException.

Specified by:

getMessageHandler in interface ClientConsumer

Returns:

the MessageHandler associated to this consumer or null

Throws:

org.apache.activemq.artemis.api.core.ActiveMQException - if an exception occurs while getting the MessageHandler

setMessageHandler

public ClientConsumerImpl setMessageHandler(MessageHandler theHandler)
                                     throws org.apache.activemq.artemis.api.core.ActiveMQException

Description copied from interface: ClientConsumer

Sets the MessageHandler for this consumer to consume messages asynchronously.

Calling this method on a closed consumer will throw a ActiveMQException.

Specified by:

setMessageHandler in interface ClientConsumer

Parameters:

theHandler - a MessageHandler

Throws:

org.apache.activemq.artemis.api.core.ActiveMQException - if an exception occurs while setting the MessageHandler

close

public void close()
           throws org.apache.activemq.artemis.api.core.ActiveMQException

Description copied from interface: ClientConsumer

Closes the consumer.

Once this consumer is closed, it can not receive messages, whether synchronously or asynchronously.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ClientConsumer

Throws:

org.apache.activemq.artemis.api.core.ActiveMQException

prepareForClose

public Thread prepareForClose(FutureLatch future)
                       throws org.apache.activemq.artemis.api.core.ActiveMQException

To be used by MDBs to stop any more handling of messages.

Specified by:

prepareForClose in interface ClientConsumerInternal

Parameters:

future - the future to run once the onMessage Thread has completed

Throws:

org.apache.activemq.artemis.api.core.ActiveMQException

cleanUp

public void cleanUp()

Specified by:

cleanUp in interface ClientConsumerInternal

isClosed

public boolean isClosed()

Description copied from interface: ClientConsumer

Returns whether the consumer is closed or not.

Specified by:

isClosed in interface ClientConsumer

Returns:

true if this consumer is closed, false else

stop

public void stop(boolean waitForOnMessage)
          throws org.apache.activemq.artemis.api.core.ActiveMQException

Specified by:

stop in interface ClientConsumerInternal

Throws:

org.apache.activemq.artemis.api.core.ActiveMQException

clearAtFailover

public void clearAtFailover()

Specified by:

clearAtFailover in interface ClientConsumerInternal

start

public void start()

Specified by:

start in interface ClientConsumerInternal

getLastException

public Exception getLastException()

Description copied from interface: ClientConsumer

Returns the last exception thrown by a call to this consumer's MessageHandler.

Specified by:

getLastException in interface ClientConsumer

Returns:

the last exception thrown by a call to this consumer's MessageHandler or null

getQueueInfo

public ClientSession.QueueQuery getQueueInfo()

Specified by:

getQueueInfo in interface ClientConsumerInternal

getFilterString

public org.apache.activemq.artemis.api.core.SimpleString getFilterString()

Specified by:

getFilterString in interface ClientConsumerInternal

getQueueName

public org.apache.activemq.artemis.api.core.SimpleString getQueueName()

Specified by:

getQueueName in interface ClientConsumerInternal

isBrowseOnly

public boolean isBrowseOnly()

Specified by:

isBrowseOnly in interface ClientConsumerInternal

handleMessage

public void handleMessage(ClientMessageInternal message)
                   throws Exception

Specified by:

handleMessage in interface ClientConsumerInternal

Throws:

Exception

handleLargeMessage

public void handleLargeMessage(ClientLargeMessageInternal clientLargeMessage,
                               long largeMessageSize)
                        throws Exception

Specified by:

handleLargeMessage in interface ClientConsumerInternal

Throws:

Exception

handleLargeMessageContinuation

public void handleLargeMessageContinuation(byte[] chunk,
                                           int flowControlSize,
                                           boolean isContinues)
                                    throws Exception

Specified by:

handleLargeMessageContinuation in interface ClientConsumerInternal

Throws:

Exception

clear

public void clear(boolean waitForOnMessage)
           throws org.apache.activemq.artemis.api.core.ActiveMQException

Specified by:

clear in interface ClientConsumerInternal

Throws:

org.apache.activemq.artemis.api.core.ActiveMQException

getClientWindowSize

public int getClientWindowSize()

Specified by:

getClientWindowSize in interface ClientConsumerInternal

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface ClientConsumerInternal

acknowledge

public void acknowledge(ClientMessage message)
                 throws org.apache.activemq.artemis.api.core.ActiveMQException

Specified by:

acknowledge in interface ClientConsumerInternal

Throws:

org.apache.activemq.artemis.api.core.ActiveMQException

individualAcknowledge

public void individualAcknowledge(ClientMessage message)
                           throws org.apache.activemq.artemis.api.core.ActiveMQException

Specified by:

individualAcknowledge in interface ClientConsumerInternal

Throws:

org.apache.activemq.artemis.api.core.ActiveMQException

flushAcks

public void flushAcks()
               throws org.apache.activemq.artemis.api.core.ActiveMQException

Specified by:

flushAcks in interface ClientConsumerInternal

Throws:

org.apache.activemq.artemis.api.core.ActiveMQException

flowControl

public void flowControl(int messageBytes,
                        boolean discountSlowConsumer)
                 throws org.apache.activemq.artemis.api.core.ActiveMQException

LargeMessageBuffer will call flowcontrol here, while other handleMessage will also be calling flowControl. So, this operation needs to be atomic.

Specified by:

flowControl in interface ClientConsumerInternal

Parameters:

discountSlowConsumer - When dealing with slowConsumers, we need to discount one credit that was pre-sent when the first receive was called. For largeMessage that is only done at the latest packet

Throws:

org.apache.activemq.artemis.api.core.ActiveMQException

toString

public String toString()

Overrides:

toString in class Object