Dogcows Code - chaz/yoink/blob - src/Moof/Timer.hh

   1
   2 /*******************************************************************************
   3
   4  Copyright (c) 2009, Charles McGarvey
   5  All rights reserved.
   6
   7  Redistribution   and   use  in  source  and  binary  forms,  with  or  without
   8  modification, are permitted provided that the following conditions are met:
   9
  10    * Redistributions  of  source  code  must retain the above copyright notice,
  11      this list of conditions and the following disclaimer.
  12    * Redistributions  in binary form must reproduce the above copyright notice,
  13      this  list of conditions and the following disclaimer in the documentation
  14      and/or other materials provided with the distribution.
  15
  16  THIS  SOFTWARE  IS  PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  17  AND  ANY  EXPRESS  OR  IMPLIED  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  DISCLAIMED.  IN  NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  20  FOR  ANY  DIRECT,  INDIRECT,  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  DAMAGES  (INCLUDING,  BUT  NOT  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  22  SERVICES;  LOSS  OF  USE,  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  23  CAUSED  AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  24  OR  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  25  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26
  27 *******************************************************************************/
  28
  29 #ifndef _MOOF_TIMER_HH_
  30 #define _MOOF_TIMER_HH_
  31
  32 /**
  33  * @file Timer.hh
  34  * Functions for measuring time in a friendly unit.
  35  */
  36
  37 #include <Moof/Math.hh>
  38
  39
  40 namespace Mf {
  41
  42
  43 /**
  44  * Get the number of seconds since a fixed, arbitrary point in the past.
  45  * @return Seconds.
  46  */
  47
  48 Scalar getTicks();
  49
  50
  51 /**
  52  * Put the thread to sleep for a certain period of time.  If absolute is true,
  53  * then it will sleep until seconds after the fixed time in the past.  If
  54  * absolute is false, it will sleep for seconds starting now.  Unlike system
  55  * sleep functions, this one automatically resumes sleep if sleep was
  56  * interrupted by a signal.  Therefore, calling this function is guaranteed to
  57  * sleep for the requested amount of time.
  58  */
  59
  60 void sleep(Scalar seconds, bool absolute = false);
  61
  62
  63 } // namespace Mf
  64
  65
  66 #endif // _MOOF_TIMER_HH_
  67
  68 /** vim: set ts=4 sw=4 tw=80: *************************************************/
  69