Handle.hpp
Go to the documentation of this file.
00001 /***************************************************************************
00002   tag: Peter Soetens  Wed Jan 18 14:11:38 CET 2006  Handle.hpp
00003 
00004                         Handle.hpp -  description
00005                            -------------------
00006     begin                : Wed January 18 2006
00007     copyright            : (C) 2006 Peter Soetens
00008     email                : peter.soetens@mech.kuleuven.be
00009 
00010  ***************************************************************************
00011  *   This library is free software; you can redistribute it and/or         *
00012  *   modify it under the terms of the GNU General Public                   *
00013  *   License as published by the Free Software Foundation;                 *
00014  *   version 2 of the License.                                             *
00015  *                                                                         *
00016  *   As a special exception, you may use this file as part of a free       *
00017  *   software library without restriction.  Specifically, if other files   *
00018  *   instantiate templates or use macros or inline functions from this     *
00019  *   file, or you compile this file and link it with other files to        *
00020  *   produce an executable, this file does not by itself cause the         *
00021  *   resulting executable to be covered by the GNU General Public          *
00022  *   License.  This exception does not however invalidate any other        *
00023  *   reasons why the executable file might be covered by the GNU General   *
00024  *   Public License.                                                       *
00025  *                                                                         *
00026  *   This library is distributed in the hope that it will be useful,       *
00027  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
00028  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
00029  *   Lesser General Public License for more details.                       *
00030  *                                                                         *
00031  *   You should have received a copy of the GNU General Public             *
00032  *   License along with this library; if not, write to the Free Software   *
00033  *   Foundation, Inc., 59 Temple Place,                                    *
00034  *   Suite 330, Boston, MA  02111-1307  USA                                *
00035  *                                                                         *
00036  ***************************************************************************/
00037 
00038 
00039 #ifndef ORO_CORELIB_SIGNAL_HANDLE_HPP
00040 #define ORO_CORELIB_SIGNAL_HANDLE_HPP
00041 
00042 #include "internal/SignalBase.hpp"
00043 
00044 namespace RTT
00045 {
00066         class RTT_API Handle
00067         {
00068         private:
00069                 typedef internal::SignalBase      sender_t; 
00070         typedef sender_t::connection_t    connection_t; 
00071         public:
00075                 Handle();
00076 
00077         Handle(connection_t conn);
00078 
00082         Handle(const Handle& hs);
00083 
00087                 ~Handle();
00088 
00094                 bool connect();
00095 
00101                 bool disconnect();
00102 
00108         bool connected() const;
00109 
00114         operator bool() const;
00115 
00120         bool ready() const;
00121         protected:
00126         connection_t  m_conn;
00127         };
00128 
00137         class RTT_API ScopedHandle
00138         :public Handle
00139         {
00140                 ScopedHandle();
00141     public:
00142 
00143         ScopedHandle(const Handle& hs);
00144 
00150                 ~ScopedHandle();
00151     };
00152 
00163         class RTT_API CleanupHandle
00164         :public Handle
00165         {
00166                 CleanupHandle();
00167     public:
00168 
00169         CleanupHandle(const Handle& hs);
00170 
00176                 ~CleanupHandle();
00177     };
00178 }
00179 #endif


rtt
Author(s): RTT Developers
autogenerated on Thu Jan 2 2014 11:35:21