include/anna/time/functions.hpp

   1 // ANNA - Anna is Not Nothingness Anymore
   2 //
   3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
   4 //
   5 // https://bitbucket.org/testillano/anna
   6 //
   7 // Redistribution and use in source and binary forms, with or without
   8 // modification, are permitted provided that the following conditions
   9 // are met:
  10 //
  11 //     * Redistributions of source code must retain the above copyright
  12 // notice, this list of conditions and the following disclaimer.
  13 //     * Redistributions in binary form must reproduce the above
  14 // copyright notice, this list of conditions and the following disclaimer
  15 // in the documentation and/or other materials provided with the
  16 // distribution.
  17 //     * Neither the name of Google Inc. nor the names of its
  18 // contributors may be used to endorse or promote products derived from
  19 // this software without specific prior written permission.
  20 //
  21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 //
  33 // Authors: eduardo.ramos.testillano@gmail.com
  34 //          cisco.tierra@gmail.com
  35
  36
  37 #ifndef anna_time_functions_hpp
  38 #define anna_time_functions_hpp
  39
  40 #include <string>
  41
  42
  43 namespace anna {
  44
  45 namespace time {
  46
  47 class TZ;
  48
  49 class functions {
  50 public:
  51
  52   // sets
  53
  54   /**
  55      Initializes global data used on time module. It must be firstly invoked on this module
  56   */
  57   static void initialize() throw();
  58
  59   /**
  60      Initializes reference timestamp used for statistics purposes and neccessary on limited 32-bits architectures
  61      in order to avoid overflow for unix timestamps. Time module initizalization timestamp remains if this is not called.
  62
  63      @param secondsTimestamp Reference timestamp in seconds. By default current is set.
  64   */
  65   static void setControlPoint(unsigned long long int secondsTimestamp = 0) throw();
  66
  67   /**
  68      Gets the seconds reference established by mean #setControlPoint
  69   */
  70   static unsigned long long int getSecondsReference() throw();
  71
  72
  73
  74   // gets
  75
  76   /**
  77      Gets initialization state
  78   */
  79   static bool initialized(void) throw();
  80
  81   /**
  82      Gets the local TZ
  83   */
  84   static const TZ & getLocalTz(void) throw();
  85
  86
  87   /**
  88      Get unix timestamp in seconds
  89   */
  90   static unsigned long long int unixSeconds() throw();
  91
  92
  93   /**
  94      Get unix timestamp in milliseconds
  95   */
  96   static unsigned long long int unixMilliseconds() throw();
  97
  98   /**
  99      Get the lapsed milliseconds from the last control point (#setControlPoint) or time module initialization.
 100      Used for statistics purposes (performance analysis), specially on 32-bits limited architectures in order
 101      to avoid overflow on timestamp structures.
 102   */
 103   static unsigned long long int lapsedMilliseconds() throw();
 104
 105   /**
 106      Get unix timestamp in microseconds
 107   */
 108   static unsigned long long int unixMicroseconds() throw();
 109
 110
 111   /**
 112      Get string time representation in format 'HH:mm:ss \<usecs\>'
 113      Useful for trace accurated time for events.
 114   */
 115   static std::string currentTimeAsString(void) throw();
 116 };
 117
 118 }
 119 }
 120
 121 #endif
 122