desktop/src/EasyCondition.h

   1 ///
   2 /// \file       EasyCondition.h
   3 ///             Wrapper thread around wxMutex and wxCondition, to make
   4 ///             simple waits easy and safe.  Also an RAII scope signaler.
   5 ///
   6
   7 /*
   8     Copyright (C) 2012, Net Direct Inc. (http://www.netdirect.ca/)
   9
  10     This program is free software; you can redistribute it and/or modify
  11     it under the terms of the GNU General Public License as published by
  12     the Free Software Foundation; either version 2 of the License, or
  13     (at your option) any later version.
  14
  15     This program is distributed in the hope that it will be useful,
  16     but WITHOUT ANY WARRANTY; without even the implied warranty of
  17     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  18
  19     See the GNU General Public License in the COPYING file at the
  20     root directory of this project for more details.
  21 */
  22
  23 #ifndef __BARRYDESKTOP_EASYCONDITION_H__
  24 #define __BARRYDESKTOP_EASYCONDITION_H__
  25
  26 #include <wx/wx.h>
  27
  28 class EasyCondition
  29 {
  30         wxMutex m_mutex;
  31         wxCondition m_condition;
  32
  33 public:
  34         EasyCondition()
  35                 : m_condition(m_mutex)
  36         {
  37                 m_mutex.Lock();
  38         }
  39
  40         void Wait()
  41         {
  42                 m_condition.Wait();
  43         }
  44
  45         void Signal()
  46         {
  47                 wxMutexLocker lock(m_mutex);
  48                 m_condition.Broadcast();
  49         }
  50 };
  51
  52 class ScopeSignaler
  53 {
  54         EasyCondition &m_condition;
  55
  56 public:
  57         explicit ScopeSignaler(EasyCondition &cond)
  58                 : m_condition(cond)
  59         {
  60         }
  61
  62         ~ScopeSignaler()
  63         {
  64                 m_condition.Signal();
  65         }
  66 };
  67
  68 #endif
  69