X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=senf%2FScheduler%2FClockService.hh;h=59b3de089a9261939638baec31edc9d706cf36ee;hb=d8d169a9fa7f5633171ea83362b0deaaf5bd337e;hp=1ad6e26c738063d7357ebd01470f1ad93a4661fa;hpb=d9daeee4efbcb7776a14de22e090400a543e0f83;p=senf.git diff --git a/senf/Scheduler/ClockService.hh b/senf/Scheduler/ClockService.hh index 1ad6e26..59b3de0 100644 --- a/senf/Scheduler/ClockService.hh +++ b/senf/Scheduler/ClockService.hh @@ -83,13 +83,15 @@ 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; @@ -99,7 +101,8 @@ namespace senf { 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 */