Session.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 _CMS_SESSION_H_
#define _CMS_SESSION_H_

#include <cms/Config.h>
#include <cms/Closeable.h>
#include <cms/Startable.h>
#include <cms/Stoppable.h>
#include <cms/Message.h>
#include <cms/TextMessage.h>
#include <cms/BytesMessage.h>
#include <cms/MapMessage.h>
#include <cms/StreamMessage.h>
#include <cms/MessageProducer.h>
#include <cms/MessageConsumer.h>
#include <cms/Topic.h>
#include <cms/Queue.h>
#include <cms/QueueBrowser.h>
#include <cms/TemporaryTopic.h>
#include <cms/TemporaryQueue.h>
#include <cms/CMSException.h>

namespace cms{

    class MessageTransformer;

    class CMS_API Session : public Closeable, public Startable, public Stoppable {
    public:

        enum AcknowledgeMode {

            AUTO_ACKNOWLEDGE,

            DUPS_OK_ACKNOWLEDGE,

            CLIENT_ACKNOWLEDGE,

            SESSION_TRANSACTED,

            INDIVIDUAL_ACKNOWLEDGE

        };

    public:

        virtual ~Session();

        virtual void close() = 0;

        virtual void commit() = 0;

        virtual void rollback() = 0;

        virtual void recover() = 0;

        virtual MessageConsumer* createConsumer(const Destination* destination) = 0;

        virtual MessageConsumer* createConsumer(const Destination* destination, const std::string& selector) = 0;

        virtual MessageConsumer* createConsumer(const Destination* destination, const std::string& selector, bool noLocal) = 0;

        virtual MessageConsumer* createDurableConsumer(const Topic* destination, const std::string& name, const std::string& selector, bool noLocal = false) = 0;

        virtual MessageProducer* createProducer(const Destination* destination = NULL) = 0;

        virtual QueueBrowser* createBrowser(const cms::Queue* queue) = 0;

        virtual QueueBrowser* createBrowser(const cms::Queue* queue, const std::string& selector) = 0;

        virtual Queue* createQueue(const std::string& queueName) = 0;

        virtual Topic* createTopic(const std::string& topicName) = 0;

        virtual TemporaryQueue* createTemporaryQueue() = 0;

        virtual TemporaryTopic* createTemporaryTopic() = 0;

        virtual Message* createMessage() = 0;

        virtual BytesMessage* createBytesMessage() = 0;

        virtual BytesMessage* createBytesMessage(const unsigned char* bytes, int bytesSize) = 0;

        virtual StreamMessage* createStreamMessage() = 0;

        virtual TextMessage* createTextMessage() = 0;

        virtual TextMessage* createTextMessage(const std::string& text) = 0;

        virtual MapMessage* createMapMessage() = 0;

        virtual AcknowledgeMode getAcknowledgeMode() const = 0;

        virtual bool isTransacted() const = 0;

        virtual void unsubscribe(const std::string& name) = 0;

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

        virtual cms::MessageTransformer* getMessageTransformer() const = 0;

    };

}

#endif /*_CMS_SESSION_H_*/