Drizzled Public API Documentation

wakeup.h

00001 /* - mode: c; c-basic-offset: 2; indent-tabs-mode: nil; -*-
00002  *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
00003  *
00004  *  Copyright (C) 2010 Brian Aker
00005  *
00006  *  This program is free software; you can redistribute it and/or modify
00007  *  it under the terms of the GNU General Public License as published by
00008  *  the Free Software Foundation; either version 2 of the License, or
00009  *  (at your option) any later version.
00010  *
00011  *  This program is distributed in the hope that it will be useful,
00012  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00013  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00014  *  GNU General Public License for more details.
00015  *
00016  *  You should have received a copy of the GNU General Public License
00017  *  along with this program; if not, write to the Free Software
00018  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00019  */
00020 
00021 #include <boost/thread/mutex.hpp>
00022 #include <boost/thread/condition_variable.hpp>
00023 #include <boost/shared_ptr.hpp>
00024 
00025 #ifndef CLIENT_WAKEUP_H
00026 #define CLIENT_WAKEUP_H
00027 
00028 namespace client {
00029 
00030 // Wakeup starts in a blocking posistion
00031 class Wakeup {
00032 public:
00033   typedef boost::shared_ptr<Wakeup> shared_ptr;
00034 
00035   Wakeup() :
00036     sleeping(true)
00037   { }
00038 
00039   // Signal all of the waiters to start
00040   void start()
00041   {
00042     boost::mutex::scoped_lock scopedWakeup(sleeper_mutex);
00043     sleeping= false;
00044     sleep_threshhold.notify_all();
00045   }
00046 
00047   // reset after the start of the signal so that we can reuse the wakeup
00048   void reset()
00049   {
00050     boost::mutex::scoped_lock scopedWakeup(sleeper_mutex);
00051     sleeping= true;
00052   }
00053 
00054   void wait() 
00055   {
00056     sleeper_mutex.lock();
00057     while (sleeping)
00058     {
00059       sleep_threshhold.wait(sleeper_mutex);
00060     }
00061     sleeper_mutex.unlock();
00062   }
00063 
00064 private:
00065   bool sleeping;
00066   boost::mutex sleeper_mutex;
00067   boost::condition_variable_any sleep_threshhold;
00068 };
00069 
00070 } // namespace client
00071 
00072 #endif /* CLIENT_WAKEUP_H */