ConnectionInterface.hpp

/***************************************************************************
  tag: Peter Soetens  Thu Mar 2 08:30:17 CET 2006  ConnectionInterface.hpp

                        ConnectionInterface.hpp -  description
                           -------------------
    begin                : Thu March 02 2006
    copyright            : (C) 2006 Peter Soetens
    email                : peter.soetens@fmtc.be

 ***************************************************************************
 *   This library is free software; you can redistribute it and/or         *
 *   modify it under the terms of the GNU General Public                   *
 *   License as published by the Free Software Foundation;                 *
 *   version 2 of the License.                                             *
 *                                                                         *
 *   As a special exception, you may use this file as part of a free       *
 *   software library without restriction.  Specifically, if other files   *
 *   instantiate templates or use macros or inline functions from this     *
 *   file, or you compile this file and link it with other files to        *
 *   produce an executable, this file does not by itself cause the         *
 *   resulting executable to be covered by the GNU General Public          *
 *   License.  This exception does not however invalidate any other        *
 *   reasons why the executable file might be covered by the GNU General   *
 *   Public License.                                                       *
 *                                                                         *
 *   This library is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU General Public             *
 *   License along with this library; if not, write to the Free Software   *
 *   Foundation, Inc., 59 Temple Place,                                    *
 *   Suite 330, Boston, MA  02111-1307  USA                                *
 *                                                                         *
 ***************************************************************************/


#ifndef ORO_EXECUTION_CONNECTION_INTERFACE_HPP
#define ORO_EXECUTION_CONNECTION_INTERFACE_HPP

#include <boost/intrusive_ptr.hpp>
#include "os/Atomic.hpp"
#include "DataSourceBase.hpp"
#include "BufferBase.hpp"
#include <vector>

namespace RTT
{
    class ConnectionInterface;
}

void RTT_API intrusive_ptr_add_ref( RTT::ConnectionInterface* p );
void RTT_API intrusive_ptr_release( RTT::ConnectionInterface* p );

namespace RTT
{
    class PortInterface;

    class RTT_API ConnectionInterface
    {
    protected:
        friend void ::intrusive_ptr_add_ref( ConnectionInterface* p );
        friend void ::intrusive_ptr_release( ConnectionInterface* p );
        OS::AtomicInt refcount;

        typedef std::vector<PortInterface*> PList;
        PList ports;
        bool mconnected;

        std::string connectionName;
    public:
        typedef boost::intrusive_ptr<ConnectionInterface> shared_ptr;

        ConnectionInterface();
        virtual ~ConnectionInterface();

        virtual DataSourceBase::shared_ptr getDataSource() const = 0;

        virtual BufferBase::shared_ptr getBuffer() const = 0;

        virtual bool connect();

        virtual bool connected() const;

        virtual bool disconnect();

        virtual bool addPort(PortInterface* p);

        virtual bool removePort(PortInterface* p);

        virtual const TypeInfo* getTypeInfo() const = 0;

        virtual int serverProtocol() const {
            return 0;
        }

        void signal();

        std::string getConnectionName();

        void setConnectionName(std::string newConnectionName);

        PList getPortList();
    };
}

#endif