activemq-cpp/src/main/activemq/transport/IOTransport.h

/*
 * 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_TRANSPORT_IOTRANSPORT_H_
#define _ACTIVEMQ_TRANSPORT_IOTRANSPORT_H_

#include <activemq/util/Config.h>
#include <activemq/transport/Transport.h>
#include <activemq/transport/TransportListener.h>
#include <activemq/commands/Command.h>
#include <activemq/commands/Response.h>
#include <activemq/wireformat/WireFormat.h>

#include <decaf/lang/Runnable.h>
#include <decaf/lang/Thread.h>
#include <decaf/io/DataInputStream.h>
#include <decaf/io/DataOutputStream.h>
#include <decaf/util/logging/LoggerDefines.h>

namespace activemq {
namespace transport {

    using decaf::lang::Pointer;
    using activemq::commands::Command;
    using activemq::commands::Response;

    class IOTransportImpl;

    /**
     * Implementation of the Transport interface that performs marshaling of commands
     * to IO streams.
     *
     * This class does not implement the Transport::request method, it only handles
     * oneway messages.  A thread polls on the input stream for in-coming commands.  When
     * a command is received, the command listener is notified.  The polling thread is not
     * started until the start method is called.  Polling can be suspending by calling stop;
     * however, because the read operation is blocking the transport my still pull one command
     * off the wire even after the stop method has been called.
     *
     * The close method will close the associated
     * streams.  Close can be called explicitly by the user, but is also called in the
     * destructor.  Once this object has been closed, it cannot be restarted.
     */
    class AMQCPP_API IOTransport : public Transport,
                                   public decaf::lang::Runnable {

        LOGDECAF_DECLARE(logger)

    private:

        IOTransportImpl* impl;

    private:

        IOTransport(const IOTransport&);
        IOTransport& operator=(const IOTransport&);

    private:

        /**
         * Notify the exception listener
         *
         * @param ex
         *      The exception to send to any registered listener.
         */
        void fire(decaf::lang::Exception& ex);

        /**
         * Notify the command listener.
         *
         * @param
         *      The command the command the send to any registered listener.
         */
        void fire(const Pointer<Command> command);

    public:

        /**
         * Default Constructor
         */
        IOTransport();

        /**
         * Create an instance of this Transport and assign its WireFormat instance
         * at creation time.
         *
         * @param wireFormat
         *        Data encoder / decoder to use when reading and writing.
         */
        IOTransport(const Pointer<wireformat::WireFormat> wireFormat);

        virtual ~IOTransport();

        /**
         * Sets the stream from which this Transport implementation will read its data.
         *
         * @param is
         *      The InputStream that will be read from by this object.
         */
        virtual void setInputStream(decaf::io::DataInputStream* is);

        /**
         * Sets the stream to which this Transport implementation will write its data.
         *
         * @param os
         *      The OuputStream that will be written to by this object.
         */
        virtual void setOutputStream(decaf::io::DataOutputStream* os);

    public:  // Transport methods

        virtual void oneway(const Pointer<Command> command);

        /**
         * {@inheritDoc}
         *
         * This method always thrown an UnsupportedOperationException.
         */
        virtual Pointer<FutureResponse> asyncRequest(const Pointer<Command> command,
                                                     const Pointer<ResponseCallback> responseCallback);

        /**
         * {@inheritDoc}
         *
         * This method always thrown an UnsupportedOperationException.
         */
        virtual Pointer<Response> request(const Pointer<Command> command);

        /**
         * {@inheritDoc}
         *
         * This method always thrown an UnsupportedOperationException.
         */
        virtual Pointer<Response> request(const Pointer<Command> command, unsigned int timeout);

        virtual Pointer<wireformat::WireFormat> getWireFormat() const;

        virtual void setWireFormat(const Pointer<wireformat::WireFormat> wireFormat);

        virtual void setTransportListener(TransportListener* listener);

        virtual TransportListener* getTransportListener() const;

        virtual void start();

        virtual void stop();

        virtual void close();

        virtual Transport* narrow(const std::type_info& typeId) {
            if (typeid(*this) == typeId) {
                return this;
            }

            return NULL;
        }

        virtual bool isFaultTolerant() const {
            return false;
        }

        virtual bool isConnected() const;

        virtual bool isClosed() const;

        virtual std::string getRemoteAddress() const {
            return "";
        }

        virtual bool isReconnectSupported() const {
            return false;
        }

        virtual bool isUpdateURIsSupported() const {
            return false;
        }

        virtual void updateURIs(bool rebalance AMQCPP_UNUSED, const decaf::util::List<decaf::net::URI>& uris AMQCPP_UNUSED) {
            throw decaf::io::IOException();
        }

        /**
         * {@inheritDoc}
         *
         * This method does nothing in this subclass.
         */
        virtual void reconnect(const decaf::net::URI& uri AMQCPP_UNUSED) {}

    public:  // Runnable methods.

        virtual void run();

    };

}}

#endif /*_ACTIVEMQ_TRANSPORT_IOTRANSPORT_H_*/