ChannelElementBase.hpp

Go to the documentation of this file.

/***************************************************************************
  tag: Peter Soetens  Thu Oct 22 11:59:07 CEST 2009  ChannelElementBase.hpp

                        ChannelElementBase.hpp -  description
                           -------------------
    begin                : Thu October 22 2009
    copyright            : (C) 2009 Sylvain Joyeux
    email                : sylvain.joyeux@m4x.org

 ***************************************************************************
 *   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_CHANNEL_BASE_HPP
#define ORO_CHANNEL_BASE_HPP

#include "../os/oro_arch.h"
#include <utility>
#include <boost/intrusive_ptr.hpp>
#include <boost/call_traits.hpp>

#include "../rtt-fwd.hpp"
#include "rtt-base-fwd.hpp"
#include "../internal/rtt-internal-fwd.hpp"
#include "../BufferPolicy.hpp"
#include "../os/Mutex.hpp"

#include <list>
#include <map>

namespace RTT { namespace base {

    class RTT_API ChannelElementBase
    {
    public:
        typedef boost::intrusive_ptr<ChannelElementBase> shared_ptr;

    private:
        oro_atomic_t refcount;
        friend void RTT_API intrusive_ptr_add_ref( ChannelElementBase* e );
        friend void RTT_API intrusive_ptr_release( ChannelElementBase* e );

    protected:
        shared_ptr input;
        shared_ptr output;

        mutable RTT::os::SharedMutex input_lock;
        mutable RTT::os::SharedMutex output_lock;

    protected:
        void ref();
        void deref();

    public:
        ChannelElementBase();
        virtual ~ChannelElementBase();

        template <typename T> static ChannelElement<T> *narrow(ChannelElementBase *e)
        {
            return dynamic_cast<ChannelElement<T> *>(e);
        }

        template <typename T> ChannelElement<T> *narrow()
        {
            return dynamic_cast<ChannelElement<T> *>(this);
        }

        shared_ptr getInput();

        virtual shared_ptr getInputEndPoint();


        shared_ptr getOutput();

        virtual shared_ptr getOutputEndPoint();

        virtual bool connectTo(ChannelElementBase::shared_ptr const& output, bool mandatory = true);

        virtual bool connectFrom(ChannelElementBase::shared_ptr const& input);

        virtual bool connected();

        virtual bool signal();

        virtual bool signalFrom(ChannelElementBase *) { return signal(); }

        virtual bool channelReady(ChannelElementBase::shared_ptr const& caller, ConnPolicy const& policy, internal::ConnID *conn_id = 0);

        virtual bool inputReady(ChannelElementBase::shared_ptr const& caller);

        virtual void clear();

        virtual void disconnect(bool forward);

        virtual bool disconnect(ChannelElementBase::shared_ptr const& channel, bool forward);

        virtual PortInterface* getPort() const;

        virtual const ConnPolicy* getConnPolicy() const;

        RTT_DEPRECATED void setOutput(const ChannelElementBase::shared_ptr &output)
        {
            assert(false && "ChannelElementBase::setOutput() is deprecated! You should use ChannelElementBase::connectTo() instead.");
            (void) connectTo(output);
        }

        RTT_DEPRECATED void setInput(const ChannelElementBase::shared_ptr &input)
        {
            assert(false && "ChannelElementBase::setInput() is deprecated! You should use ChannelElementBase::addInput() instead.");
            (void) addInput(input);
        }

        virtual bool isRemoteElement() const;

        virtual std::string getRemoteURI() const;

        virtual std::string getLocalURI() const;

        virtual std::string getElementName() const;

    protected:
        friend class MultipleInputsChannelElementBase;
        friend class MultipleOutputsChannelElementBase;

        virtual bool addOutput(shared_ptr const& output, bool mandatory = true);

        virtual void removeOutput(shared_ptr const& output);

        virtual bool addInput(shared_ptr const& input);

        virtual void removeInput(shared_ptr const& input);

    private:
        virtual bool inputReady();
    };

    class RTT_API MultipleInputsChannelElementBase : virtual public ChannelElementBase
    {
    public:
        typedef boost::intrusive_ptr<MultipleInputsChannelElementBase> shared_ptr;
        typedef std::list<ChannelElementBase::shared_ptr> Inputs;

    protected:
        Inputs inputs;
        mutable RTT::os::SharedMutex inputs_lock;

    public:
        MultipleInputsChannelElementBase();

        virtual bool connected();

        virtual bool inputReady(ChannelElementBase::shared_ptr const& caller);

        virtual void clear();

        using ChannelElementBase::disconnect;

        virtual bool disconnect(ChannelElementBase::shared_ptr const& channel, bool forward = true);

        bool signalFrom(ChannelElementBase *caller);

    protected:
        virtual bool addInput(ChannelElementBase::shared_ptr const& input);

        virtual void removeInput(ChannelElementBase::shared_ptr const& input);
    };

    class RTT_API MultipleOutputsChannelElementBase : virtual public ChannelElementBase
    {
    public:
        typedef boost::intrusive_ptr<MultipleOutputsChannelElementBase> shared_ptr;
        struct Output {
            Output(ChannelElementBase::shared_ptr const &channel, bool mandatory = true);
            bool operator==(ChannelElementBase::shared_ptr const& channel) const;
            ChannelElementBase::shared_ptr channel;
            bool mandatory;
            bool disconnected;
        };
        typedef std::list<Output> Outputs;

    protected:
        Outputs outputs;
        mutable RTT::os::SharedMutex outputs_lock;

    public:
        MultipleOutputsChannelElementBase();

        virtual bool connected();

        virtual bool signal();

        virtual bool channelReady(ChannelElementBase::shared_ptr const& caller, ConnPolicy const& policy, internal::ConnID *conn_id = 0);

        using ChannelElementBase::disconnect;

        virtual bool disconnect(ChannelElementBase::shared_ptr const& channel, bool forward = false);

    protected:
        virtual bool addOutput(ChannelElementBase::shared_ptr const& output, bool mandatory = true);

        virtual void removeOutput(ChannelElementBase::shared_ptr const& output);

        void removeDisconnectedOutputs();
    };

    class RTT_API MultipleInputsMultipleOutputsChannelElementBase : virtual public MultipleInputsChannelElementBase, virtual public MultipleOutputsChannelElementBase
    {
    public:
        typedef boost::intrusive_ptr<MultipleInputsMultipleOutputsChannelElementBase> shared_ptr;

        virtual bool connected();

        using ChannelElementBase::disconnect;

        virtual bool disconnect(ChannelElementBase::shared_ptr const& channel, bool forward);
    };

    void RTT_API intrusive_ptr_add_ref( ChannelElementBase* e );
    void RTT_API intrusive_ptr_release( ChannelElementBase* e );

}}

#endif