Orocos Real-Time Toolkit  2.5.0
MutexLock.hpp
00001 /***************************************************************************
00002   tag: Peter Soetens  Thu Oct 10 16:16:57 CEST 2002  MutexLock.hpp
00003 
00004                         MutexLock.hpp -  description
00005                            -------------------
00006     begin                : Thu October 10 2002
00007     copyright            : (C) 2002 Peter Soetens
00008     email                : peter.soetens@mech.kuleuven.ac.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 #ifndef OS_MUTEXLOCK_HPP
00039 #define OS_MUTEXLOCK_HPP
00040 
00041 #include "fosi.h"
00042 
00043 #include "Mutex.hpp"
00044 
00045 namespace RTT
00046 { namespace os {
00051     class RTT_API MutexLock
00052     {
00053 
00054         public:
00060             MutexLock( MutexInterface &mutex )
00061             {
00062                 _mutex = &mutex;
00063                 _mutex->lock ();
00064             }
00065 
00069             ~MutexLock()
00070             {
00071                 _mutex->unlock();
00072             }
00073 
00074         protected:
00075             MutexInterface *_mutex;
00076 
00077             MutexLock()
00078             {}
00079 
00080     };
00081 
00087     class RTT_API MutexTryLock
00088     {
00089 
00090         public:
00091 
00097             MutexTryLock( MutexInterface &mutex )
00098                     : _mutex( &mutex), successful( mutex.trylock() )
00099             {
00100             }
00101 
00107             bool isSuccessful()
00108             {
00109                 return successful;
00110             }
00111 
00115             ~MutexTryLock()
00116             {
00117                 if ( successful )
00118                     _mutex->unlock();
00119             }
00120 
00121         protected:
00125             MutexInterface *_mutex;
00126 
00127             MutexTryLock()
00128             {}
00129 
00130         private:
00131 
00135             bool successful;
00136 
00137     };
00138 
00146      class RTT_API MutexTimedLock
00147      {
00148 
00149          public:
00150 
00158              MutexTimedLock( MutexInterface &mutex, Seconds timeout )
00159                      : _mutex( &mutex), successful( mutex.timedlock(timeout) )
00160              {
00161              }
00162 
00168              bool isSuccessful()
00169              {
00170                  return successful;
00171              }
00172 
00176              ~MutexTimedLock()
00177              {
00178                  if ( successful )
00179                      _mutex->unlock();
00180              }
00181 
00182          protected:
00186              MutexInterface *_mutex;
00187 
00188              MutexTimedLock()
00189              {}
00190 
00191          private:
00192 
00196              bool successful;
00197 
00198      };
00199 }}
00200 
00201 #endif