PortInterface.hpp

/***************************************************************************
  tag: Peter Soetens  Thu Mar 2 08:30:18 CET 2006  PortInterface.hpp

                        PortInterface.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_PORT_INTERFACE_HPP
#define ORO_EXECUTION_PORT_INTERFACE_HPP

#include <string>
#include "ConnectionTypes.hpp"
#include "ConnectionInterface.hpp"
#include "Event.hpp"

namespace RTT
{
    class TaskObject;

    class RTT_API PortInterface
    {
    public:
        typedef Event<void(PortInterface*)> NewDataOnPortEvent;
    protected:
        friend class ConnectionInterface;
        std::string portname;
        NewDataOnPortEvent* new_data_on_port_event;
        PortInterface(const std::string& name);

        virtual bool connect(ConnectionInterface::shared_ptr conn) = 0;
    public:
        enum PortType { ReadPort, WritePort, ReadWritePort };

        enum ConnectionModel { Buffered, Data };

        virtual ~PortInterface();

        const std::string& getName() const { return portname;}

        bool setName(const std::string& name);

        bool ready() const;

        void signal();

        NewDataOnPortEvent* getNewDataOnPortEvent();

        virtual ConnectionModel getConnectionModel() const = 0;

        virtual PortType getPortType() const = 0;

        virtual const TypeInfo* getTypeInfo() const = 0;

        virtual bool connected() const = 0;

        virtual ConnectionInterface::shared_ptr connection() const = 0;

        virtual bool connectTo( ConnectionInterface::shared_ptr conn ) = 0;

        virtual bool connectTo( PortInterface* other );

        virtual void disconnect() = 0;

        virtual PortInterface* clone() const = 0;

        virtual PortInterface* antiClone() const = 0;

        virtual ConnectionInterface::shared_ptr createConnection(ConnectionTypes::ConnectionType con_type = ConnectionTypes::lockfree);

        virtual ConnectionInterface::shared_ptr createConnection( BufferBase::shared_ptr buf );

        virtual ConnectionInterface::shared_ptr createConnection( DataSourceBase::shared_ptr data );

        virtual TaskObject* createPortObject();

        virtual int serverProtocol() const;
    };

}

#endif