ActiveMQProducerKernel.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_ACTIVEMQPRODUCERKERNEL_H_
#define _ACTIVEMQ_CORE_KERNELS_ACTIVEMQPRODUCERKERNEL_H_

#include <cms/MessageProducer.h>
#include <cms/Message.h>
#include <cms/Destination.h>
#include <cms/DeliveryMode.h>
#include <cms/MessageTransformer.h>

#include <activemq/util/Config.h>
#include <activemq/util/MemoryUsage.h>
#include <activemq/util/LongSequenceGenerator.h>
#include <activemq/commands/ProducerInfo.h>
#include <activemq/commands/ProducerAck.h>
#include <activemq/exceptions/ActiveMQException.h>

#include <memory>

namespace activemq {
namespace core {
namespace kernels {

    using decaf::lang::Pointer;

    class ActiveMQSessionKernel;

    class AMQCPP_API ActiveMQProducerKernel : public cms::MessageProducer {
    private:

        // Disable sending timestamps
        bool disableTimestamps;

        // Disable adding a Message Id
        bool disableMessageId;

        // The default delivery Mode of this Producer
        int defaultDeliveryMode;

        // The default priority Level to send at
        int defaultPriority;

        // The default time to live value for messages in milliseconds
        long long defaultTimeToLive;

        // The default Send Timeout for this Producer.
        long long sendTimeout;

        // Session that this producer sends to.
        ActiveMQSessionKernel* session;

        // This Producers protocol specific info object
        Pointer<commands::ProducerInfo> producerInfo;

        // Boolean that indicates if the consumer has been closed
        bool closed;

        // Memory Usage Class, created only if the Producer is tracking its usage.
        std::auto_ptr<util::MemoryUsage> memoryUsage;

        // The Destination assigned at creation, NULL if not assigned.
        Pointer<cms::Destination> destination;

        // Generator of Message Sequence Id numbers for this producer.
        util::LongSequenceGenerator messageSequence;

        // Used to tranform Message before sending them to the CMS bus.
        cms::MessageTransformer* transformer;

    private:

        ActiveMQProducerKernel(const ActiveMQProducerKernel&);
        ActiveMQProducerKernel& operator=(const ActiveMQProducerKernel&);

    public:

        ActiveMQProducerKernel(ActiveMQSessionKernel* session,
                               const Pointer<commands::ProducerId>& producerId,
                               const Pointer<commands::ActiveMQDestination>& destination,
                               long long sendTimeout);

        virtual ~ActiveMQProducerKernel();

    public:  // cms::MessageProducer methods.

        virtual void close();

        virtual void send(cms::Message* message);

        virtual void send(cms::Message* message, cms::AsyncCallback* callback);

        virtual void send(cms::Message* message, int deliveryMode, int priority, long long timeToLive);

        virtual void send(cms::Message* message, int deliveryMode, int priority, long long timeToLive, cms::AsyncCallback* callback);

        virtual void send(const cms::Destination* destination, cms::Message* message);

        virtual void send(const cms::Destination* destination, cms::Message* message, cms::AsyncCallback* callback);

        virtual void send(const cms::Destination* destination, cms::Message* message,
                          int deliveryMode, int priority, long long timeToLive);

        virtual void send(const cms::Destination* destination, cms::Message* message,
                          int deliveryMode, int priority, long long timeToLive, cms::AsyncCallback* callback);

        virtual void setMessageTransformer(cms::MessageTransformer* transformer) {
            this->transformer = transformer;
        }

        virtual cms::MessageTransformer* getMessageTransformer() const {
            return this->transformer;
        }

        virtual void setDeliveryMode(int mode) {
            this->defaultDeliveryMode = mode;
        }

        virtual int getDeliveryMode() const {
            return this->defaultDeliveryMode;
        }

        virtual void setDisableMessageID(bool value) {
            this->disableMessageId = value;
        }

        virtual bool getDisableMessageID() const {
            return this->disableMessageId;
        }

        virtual void setDisableMessageTimeStamp(bool value) {
            this->disableTimestamps = value;
        }

        virtual bool getDisableMessageTimeStamp() const {
            return this->disableTimestamps;
        }

        virtual void setPriority(int priority) {
            this->defaultPriority = priority;
        }

        virtual int getPriority() const {
            return this->defaultPriority;
        }

        virtual void setTimeToLive(long long time) {
            this->defaultTimeToLive = time;
        }

        virtual long long getTimeToLive() const {
            return this->defaultTimeToLive;
        }

        virtual void setSendTimeout(long long time) {
            this->sendTimeout = time;
        }

        virtual long long getSendTimeout() const {
            return this->sendTimeout;
        }

        bool isClosed() const {
            return this->closed;
        }

        const Pointer<commands::ProducerInfo>& getProducerInfo() const {
            this->checkClosed();
            return this->producerInfo;
        }

        const Pointer<commands::ProducerId>& getProducerId() const {
            this->checkClosed();
            return this->producerInfo->getProducerId();
        }

        virtual void onProducerAck(const commands::ProducerAck& ack);

        void dispose();

        long long getNextMessageSequence() {
            return this->messageSequence.getNextSequenceId();
        }

    private:

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

    };

}}}

#endif /* _ACTIVEMQ_CORE_KERNELS_ACTIVEMQPRODUCERKERNEL_H_ */