X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=senf%2FScheduler%2FClockService.hh;h=cc859afb551e669c1111b4683ec3976ef2f3b59e;hb=9bc655e14d2d8c204ed835896cb51e42d49bd68f;hp=3bb09f9f5c375b26a27b35a258caa6b5a6b34ccb;hpb=4adca0eda1b26c8ca84421fd936f8450713ca6fd;p=senf.git diff --git a/senf/Scheduler/ClockService.hh b/senf/Scheduler/ClockService.hh index 3bb09f9..cc859af 100644 --- a/senf/Scheduler/ClockService.hh +++ b/senf/Scheduler/ClockService.hh @@ -27,7 +27,7 @@ #define HH_SENF_Scheduler_ClockService_ 1 // Custom includes -#include +#include #include #include #include @@ -51,7 +51,7 @@ namespace senf { // To allow conversion between clock value and absolute time, the ClockService samples the // absolute current time and the clock value when the conversion is performed. This is done at // most once per second on a if-needed basis. - + /** \brief Reliable high precision monotonous clock source The ClockService provides a highly accurate monotonous clock source based on @@ -69,7 +69,7 @@ namespace senf { // Types /** \brief ClockService timer data type - + Unsigned integer type representing scheduler time. Scheduler time is measured in nanoseconds relative to some implementation defined reference time. */ @@ -83,23 +83,26 @@ namespace senf { /** \brief Absolute time data type - Boost.DateTime datatype used to represent absolute date/time values. + Boost.DateTime + datatype used to represent absolute date/time values. */ typedef boost::posix_time::ptime abstime_type; /** \brief Relative time data type - Boost.DateTime datatype used to represent time intervals + Boost.DateTime + datatype used to represent time intervals */ typedef boost::posix_time::time_duration reltime_type; /////////////////////////////////////////////////////////////////////////// static clock_type now(); ///< Return current clock value - + static abstime_type abstime(clock_type clock); ///< Convert clock to absolute time /**< This member converts a clock value into an absolute - Boost.DateTime value. + Boost.DateTime + value. \note You should not base timeout calculations on this absolute time value. Clock time is guaranteed to be monotonous, absolute time may be non-monotonous if @@ -107,7 +110,8 @@ namespace senf { static reltime_type reltime(clock_type clock); ///< Convert clock to relative time /**< This member converts a clock value into a relative - Boost.DateTime time interval + Boost.DateTime + time interval \note The resolution of reltime_type might be smaller than the clock_type resolution */ @@ -116,12 +120,12 @@ namespace senf { corresponding clock value. \see abstime */ - static clock_type from_time_t(time_t const & time); + static clock_type from_time_t(time_t const & time); ///< Convert legacy time_t to clock value - /**< This member converts an absolute time value + /**< This member converts an absolute time value represented as a time_t value into a clock value */ - static clock_type from_timeval(timeval const & time); + static clock_type from_timeval(timeval const & time); ///< Convert legacy timeval to clock value /**< This member converts an absolute time value represented as a timeval value into a clock value */ @@ -197,7 +201,7 @@ namespace senf { 2md(very unusual) 2 milli-days */ - void parseClockServiceInterval(console::ParseCommandInfo::TokensRange const & tokens, + void parseClockServiceInterval(console::ParseCommandInfo::TokensRange const & tokens, ClockService::clock_type & out); void formatClockServiceInterval(ClockService::clock_type interval, std::ostream & os);