ActiveMQConsumerKernel.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#ifndef _ACTIVEMQ_CORE_KERNELS_ACTIVEMQCONSUMERKERNEL_H_
#define _ACTIVEMQ_CORE_KERNELS_ACTIVEMQCONSUMERKERNEL_H_

#include <cms/MessageConsumer.h>
#include <cms/MessageListener.h>
#include <cms/MessageAvailableListener.h>
#include <cms/Message.h>
#include <cms/CMSException.h>

#include <activemq/util/Config.h>
#include <activemq/exceptions/ActiveMQException.h>
#include <activemq/commands/ConsumerInfo.h>
#include <activemq/commands/MessageAck.h>
#include <activemq/commands/MessageDispatch.h>
#include <activemq/core/Dispatcher.h>
#include <activemq/core/RedeliveryPolicy.h>
#include <activemq/core/MessageDispatchChannel.h>

#include <decaf/util/concurrent/atomic/AtomicBoolean.h>
#include <decaf/lang/Pointer.h>
#include <decaf/util/concurrent/Mutex.h>

namespace activemq {
namespace core {
namespace kernels {

    using decaf::lang::Pointer;
    using decaf::util::concurrent::atomic::AtomicBoolean;

    class ActiveMQSessionKernel;
    class ActiveMQConsumerKernelConfig;

    class AMQCPP_API ActiveMQConsumerKernel : public cms::MessageConsumer, public Dispatcher {
    private:

        ActiveMQConsumerKernelConfig* internal;

        ActiveMQSessionKernel* session;

        Pointer<commands::ConsumerInfo> consumerInfo;

    private:

        ActiveMQConsumerKernel(const ActiveMQConsumerKernel&);
        ActiveMQConsumerKernel& operator=(const ActiveMQConsumerKernel&);

    public:

        ActiveMQConsumerKernel(ActiveMQSessionKernel* session,
                               const Pointer<commands::ConsumerId>& id,
                               const Pointer<commands::ActiveMQDestination>& destination,
                               const std::string& name,
                               const std::string& selector,
                               int prefetch,
                               int maxPendingMessageCount,
                               bool noLocal,
                               bool browser,
                               bool dispatchAsync,
                               cms::MessageListener* listener);

        virtual ~ActiveMQConsumerKernel();

    public:  // Interface Implementation

        virtual void start();

        virtual void stop();

        virtual void close();

        virtual cms::Message* receive();

        virtual cms::Message* receive(int millisecs);

        virtual cms::Message* receiveNoWait();

        virtual void setMessageListener(cms::MessageListener* listener);

        virtual cms::MessageListener* getMessageListener() const;

        virtual void setMessageAvailableListener(cms::MessageAvailableListener* listener);

        virtual cms::MessageAvailableListener* getMessageAvailableListener() const;

        virtual std::string getMessageSelector() const;

        virtual void acknowledge(const Pointer<commands::MessageDispatch>& dispatch);

        virtual void setMessageTransformer(cms::MessageTransformer* transformer);

        virtual cms::MessageTransformer* getMessageTransformer() const;

    public:  // Dispatcher Methods

        virtual void dispatch( const Pointer<MessageDispatch>& message );

    public:  // ActiveMQConsumerKernel Methods

        void acknowledge();

        void commit();

        void rollback();

        void doClose();

        void dispose();

        const Pointer<commands::ConsumerInfo>& getConsumerInfo() const;

        const Pointer<commands::ConsumerId>& getConsumerId() const;

        bool isClosed() const;

        bool isSynchronizationRegistered() const ;

        void setSynchronizationRegistered(bool value);

        bool iterate();

        void deliverAcks();

        void clearMessagesInProgress();

        void inProgressClearRequired();

        long long getLastDeliveredSequenceId() const;

        void setLastDeliveredSequenceId(long long value);

        int getMessageAvailableCount() const;

        void setRedeliveryPolicy(RedeliveryPolicy* policy);

        RedeliveryPolicy* getRedeliveryPolicy() const;

        void setFailureError(decaf::lang::Exception* error);

        decaf::lang::Exception* getFailureError() const;

        void setPrefetchSize(int prefetchSize);

        bool isInUse(Pointer<commands::ActiveMQDestination> destination) const;

    protected:

        Pointer<MessageDispatch> dequeue(long long timeout);

        void beforeMessageIsConsumed(const Pointer<commands::MessageDispatch>& dispatch);

        void afterMessageIsConsumed(const Pointer<commands::MessageDispatch>& dispatch, bool messageExpired);

    private:

        // Creates a deliverable cms::Message from a received MessageDispatch, transforming if needed
        // and configuring appropriate ack handlers.
        Pointer<cms::Message> createCMSMessage(Pointer<commands::MessageDispatch> dispatch);

        // Using options from the Destination URI override any settings that are
        // defined for this consumer.
        void applyDestinationOptions(const Pointer<commands::ConsumerInfo>& info);

        // If supported sends a message pull request to the service provider asking
        // for the delivery of a new message.  This is used in the case where the
        // service provider has been configured with a zero prefetch or is only
        // capable of delivering messages on a pull basis.  No request is made if
        // there are already messages in the unconsumed queue since there's no need
        // for a server round-trip in that instance.
        void sendPullRequest(long long timeout);

        // Checks for the closed state and throws if so.
        void checkClosed() const;

        // Sends an ack as needed in order to keep them coming in if the current
        // ack mode allows the consumer to receive up to the prefetch limit before
        // an real ack is sent.
        void ackLater(const Pointer<commands::MessageDispatch>& message, int ackType);

        // Create an Ack Message that acks all messages that have been delivered so far.
        Pointer<commands::MessageAck> makeAckForAllDeliveredMessages(int type);

        // Should Acks be sent on each dispatched message
        bool isAutoAcknowledgeEach() const;

        // Can Acks be batched for less network overhead.
        bool isAutoAcknowledgeBatch() const;

    };

}}}

#endif /* _ACTIVEMQ_CORE_KERNELS_ACTIVEMQCONSUMERKERNEL_H_ */