Handle.hpp

/***************************************************************************
  tag: Peter Soetens  Wed Jan 18 14:11:38 CET 2006  Handle.hpp

                        Handle.hpp -  description
                           -------------------
    begin                : Wed January 18 2006
    copyright            : (C) 2006 Peter Soetens
    email                : peter.soetens@mech.kuleuven.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_CORELIB_SIGNAL_HANDLE_HPP
#define ORO_CORELIB_SIGNAL_HANDLE_HPP

#include "internal/SignalBase.hpp"

namespace RTT
{
    class RTT_API Handle
    {
    private:
        typedef internal::SignalBase      sender_t; 
        typedef sender_t::connection_t    connection_t; 
    public:
        Handle();

        Handle(connection_t conn);

        Handle(const Handle& hs);

        ~Handle();

        bool connect();

        bool disconnect();

        bool connected() const;

        operator bool() const;

        bool ready() const;
    protected:
        connection_t  m_conn;
    };

    class RTT_API ScopedHandle
        :public Handle
    {
        ScopedHandle();
    public:

        ScopedHandle(const Handle& hs);

        ~ScopedHandle();
    };

    class RTT_API CleanupHandle
        :public Handle
    {
        CleanupHandle();
    public:

        CleanupHandle(const Handle& hs);

        ~CleanupHandle();
    };
}
#endif