#include <src/main/activemq/core/ActiveMQConsumer.h>

Inheritance diagram for activemq::core::ActiveMQConsumer:

Public Member Functions
	ActiveMQConsumer (const Pointer< activemq::core::kernels::ActiveMQConsumerKernel > &kernel)
	Create a new ActiveMQConsumer that contains the pointer to the Kernel that implement the real MessageConsumer functionality. More...

virtual	~ActiveMQConsumer ()

virtual void	start ()
	Starts the service. More...

virtual void	stop ()
	Stops this service. More...

virtual void	close ()
	Closes this object and deallocates the appropriate resources. More...

virtual cms::Message *	receive ()
	Synchronously Receive a Message. More...

virtual cms::Message *	receive (int millisecs)
	Synchronously Receive a Message, time out after defined interval. More...

virtual cms::Message *	receiveNoWait ()
	Receive a Message, does not wait if there isn't a new message to read, returns NULL if nothing read. More...

virtual void	setMessageListener (cms::MessageListener *listener)
	Sets the MessageListener that this class will send notifs on. More...

virtual cms::MessageListener *	getMessageListener () const
	Gets the MessageListener that this class will send mew Message notification events to. More...

virtual void	setMessageAvailableListener (cms::MessageAvailableListener *listener)
	Sets the MessageAvailableListener that this class will send events to if the consumer is in synchronous consumption mode and a new Message has arrived. More...

virtual cms::MessageAvailableListener *	getMessageAvailableListener () const
	Gets the MessageAvailableListener that this class will send mew Message notification events to. More...

virtual std::string	getMessageSelector () const
	Gets this message consumer's message selector expression. More...

virtual void	setMessageTransformer (cms::MessageTransformer *transformer)
	Set an MessageTransformer instance that is applied to all cms::Message objects before they are dispatched to client code. More...

virtual cms::MessageTransformer *	getMessageTransformer () const
	Gets the currently configured MessageTransformer for this MessageConsumer. More...

const Pointer < commands::ConsumerInfo > &	getConsumerInfo () const
	Get the Consumer information for this consumer. More...

const Pointer < commands::ConsumerId > &	getConsumerId () const
	Get the Consumer Id for this consumer. More...

bool	isClosed () const

int	getMessageAvailableCount () const

void	setRedeliveryPolicy (RedeliveryPolicy *policy)
	Sets the RedeliveryPolicy this Consumer should use when a rollback is performed on a transacted Consumer. More...

RedeliveryPolicy *	getRedeliveryPolicy () const
	Gets a pointer to this Consumer's Redelivery Policy object, the Consumer retains ownership of this pointer so the caller should not delete it. More...

decaf::lang::Exception *	getFailureError () const
	Gets the error that caused this Consumer to be in a Failed state, or NULL if there is no Error. More...

long long	getOptimizedAckScheduledAckInterval () const
	Time in Milliseconds before an automatic acknowledge is done for any outstanding delivered Messages. More...

void	setOptimizedAckScheduledAckInterval (long long value)
	Sets the time in Milliseconds to schedule an automatic acknowledge of outstanding messages when optimize acknowledge is enabled. More...

bool	isOptimizeAcknowledge () const

void	setOptimizeAcknowledge (bool value)
	Enable or disable optimized acknowledge for this consumer. More...

Public Member Functions inherited from cms::MessageConsumer
virtual	~MessageConsumer ()

Public Member Functions inherited from cms::Closeable
virtual	~Closeable ()

Public Member Functions inherited from cms::Startable
virtual	~Startable ()

Public Member Functions inherited from cms::Stoppable
virtual	~Stoppable ()

Constructor & Destructor Documentation

activemq::core::ActiveMQConsumer::ActiveMQConsumer ( const Pointer< activemq::core::kernels::ActiveMQConsumerKernel > & kernel )

Create a new ActiveMQConsumer that contains the pointer to the Kernel that implement the real MessageConsumer functionality.

Parameters

ActiveMQConsumerKernel This Consumer's functionality kernel.

virtual activemq::core::ActiveMQConsumer::~ActiveMQConsumer ( )

virtual

Member Function Documentation

virtual void activemq::core::ActiveMQConsumer::close ( )

virtual

Closes this object and deallocates the appropriate resources.

The object is generally no longer usable after calling close.

Exceptions

CMSException - If an error occurs while the resource is being closed.

Implements cms::Closeable.

const Pointer<commands::ConsumerId>& activemq::core::ActiveMQConsumer::getConsumerId ( ) const

Get the Consumer Id for this consumer.

Returns: Reference to a Consumer Id Object

const Pointer<commands::ConsumerInfo>& activemq::core::ActiveMQConsumer::getConsumerInfo ( ) const

Get the Consumer information for this consumer.

Returns: Reference to a Consumer Info Object

decaf::lang::Exception* activemq::core::ActiveMQConsumer::getFailureError ( ) const

Gets the error that caused this Consumer to be in a Failed state, or NULL if there is no Error.

Returns: pointer to the error that faulted this Consumer or NULL.

int activemq::core::ActiveMQConsumer::getMessageAvailableCount ( ) const

Returns: the number of Message's this consumer is waiting to Dispatch.

virtual cms::MessageAvailableListener* activemq::core::ActiveMQConsumer::getMessageAvailableListener ( ) const

virtual

Gets the MessageAvailableListener that this class will send mew Message notification events to.

Returns: The listener of message events received by this consumer.

Exceptions

CMSException - If an internal error occurs.

Implements cms::MessageConsumer.

virtual cms::MessageListener* activemq::core::ActiveMQConsumer::getMessageListener ( ) const

virtual

Gets the MessageListener that this class will send mew Message notification events to.

Returns: The listener of messages received by this consumer

Exceptions

CMSException - If an internal error occurs.

Implements cms::MessageConsumer.

virtual std::string activemq::core::ActiveMQConsumer::getMessageSelector ( ) const

virtual

Gets this message consumer's message selector expression.

Returns: This Consumer's selector expression or "".

Exceptions

CMSException - If an internal error occurs.

Implements cms::MessageConsumer.

virtual cms::MessageTransformer* activemq::core::ActiveMQConsumer::getMessageTransformer ( ) const

virtual

Gets the currently configured MessageTransformer for this MessageConsumer.

Returns: the pointer to the currently set cms::MessageTransformer.

Implements cms::MessageConsumer.

long long activemq::core::ActiveMQConsumer::getOptimizedAckScheduledAckInterval ( ) const

Time in Milliseconds before an automatic acknowledge is done for any outstanding delivered Messages.

A value less than one means no task is scheduled.

Returns: time in milliseconds for the scheduled ack task.

RedeliveryPolicy* activemq::core::ActiveMQConsumer::getRedeliveryPolicy ( ) const

Gets a pointer to this Consumer's Redelivery Policy object, the Consumer retains ownership of this pointer so the caller should not delete it.

Returns: a Pointer to a RedeliveryPolicy that is in use by this Consumer.

bool activemq::core::ActiveMQConsumer::isClosed ( ) const

Returns: if this Consumer has been closed.

bool activemq::core::ActiveMQConsumer::isOptimizeAcknowledge ( ) const

Returns: true if this consumer is using optimize acknowledge mode.

virtual cms::Message* activemq::core::ActiveMQConsumer::receive ( )

virtual

Synchronously Receive a Message.

Returns: new message which the caller owns and must delete.

Exceptions

CMSException - If an internal error occurs.

Implements cms::MessageConsumer.

virtual cms::Message* activemq::core::ActiveMQConsumer::receive ( int millisecs )

virtual

Synchronously Receive a Message, time out after defined interval.

Returns null if nothing read.

Returns: new message which the caller owns and must delete.

Exceptions

CMSException - If an internal error occurs.

Implements cms::MessageConsumer.

virtual cms::Message* activemq::core::ActiveMQConsumer::receiveNoWait ( )

virtual

Receive a Message, does not wait if there isn't a new message to read, returns NULL if nothing read.

Returns: new message which the caller owns and must delete.

Exceptions

CMSException - If an internal error occurs.

Implements cms::MessageConsumer.

virtual void activemq::core::ActiveMQConsumer::setMessageAvailableListener ( cms::MessageAvailableListener * listener )

virtual

Sets the MessageAvailableListener that this class will send events to if the consumer is in synchronous consumption mode and a new Message has arrived.

Parameters

listener The listener of new message events fired by this consumer.

Exceptions

CMSException - If an internal error occurs.

Implements cms::MessageConsumer.

virtual void activemq::core::ActiveMQConsumer::setMessageListener ( cms::MessageListener * listener )

virtual

Sets the MessageListener that this class will send notifs on.

Parameters

listener The listener of messages received by this consumer.

Exceptions

CMSException - If an internal error occurs.

Implements cms::MessageConsumer.

virtual void activemq::core::ActiveMQConsumer::setMessageTransformer ( cms::MessageTransformer * transformer )

virtual

Set an MessageTransformer instance that is applied to all cms::Message objects before they are dispatched to client code.

The CMS code never takes ownership of the MessageTransformer pointer which implies that the client code must ensure that the object remains valid for the lifetime of the CMS object to which the MessageTransformer has been assigned.

Parameters

transformer Pointer to the cms::MessageTransformer to apply on each cms:;Message dispatch.

Implements cms::MessageConsumer.

void activemq::core::ActiveMQConsumer::setOptimizeAcknowledge ( bool value )

Enable or disable optimized acknowledge for this consumer.

Parameters

value True if optimize acknowledge is enabled, false otherwise.

void activemq::core::ActiveMQConsumer::setOptimizedAckScheduledAckInterval ( long long value )

Sets the time in Milliseconds to schedule an automatic acknowledge of outstanding messages when optimize acknowledge is enabled.

A value less than one means disable any scheduled tasks.

Parameters

value The time interval to send scheduled acks.

void activemq::core::ActiveMQConsumer::setRedeliveryPolicy ( RedeliveryPolicy * policy )

Sets the RedeliveryPolicy this Consumer should use when a rollback is performed on a transacted Consumer.

The Consumer takes ownership of the passed pointer. The Consumer's redelivery policy can never be null, a call to this method with a NULL pointer is ignored.

Parameters

policy Pointer to a Redelivery Policy object that his Consumer will use.

virtual void activemq::core::ActiveMQConsumer::start ( )

virtual

Starts the service.

Exceptions

CMSException if an internal error occurs while starting.

Implements cms::Startable.

virtual void activemq::core::ActiveMQConsumer::stop ( )

virtual

Stops this service.

Exceptions

CMSException - if an internal error occurs while stopping the Service.

Implements cms::Stoppable.

The documentation for this class was generated from the following file:

src/main/activemq/core/ActiveMQConsumer.h

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation