X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsd_event_now.xml;h=b419e7d8210aac15f21d6793ebe5177e90161c39;hp=219e261fd4a7031bca6fa870b3202f37bb8bf8e2;hb=47f94046d2208b0ca48928df3ac3bce803361f23;hpb=07045a1a92c839fd2af80bd0c060a595021bc3b3 diff --git a/man/sd_event_now.xml b/man/sd_event_now.xml index 219e261fd..b419e7d82 100644 --- a/man/sd_event_now.xml +++ b/man/sd_event_now.xml @@ -65,45 +65,44 @@ Description - sd_event_now() returns the timestamp - the most recent event loop iteration began. This timestamp is - taken right after returning from the event sleep, and before + sd_event_now() returns the time when + the most recent event loop iteration began. A timestamp + is taken right after returning from the event sleep, and before dispatching any event sources. The event - parameter takes the even loop object to retrieve the timestamp + parameter specifies the event loop object to retrieve the timestamp from. The clock parameter specifies the clock to retrieve the timestamp for, and is one of - CLOCK_REALTIME (or its equivalent + CLOCK_REALTIME (or equivalently CLOCK_REALTIME_ALARM), - CLOCK_MONOTONIC or - CLOCK_BOOTTIME (or its equivalent - CLOCK_BOOTTIME_ALARM), see clock_gettime2 + CLOCK_MONOTONIC, or + CLOCK_BOOTTIME (or equivalently + CLOCK_BOOTTIME_ALARM), see + clock_gettime2 for more information on the various clocks. The retrieved timestamp is stored in the usec parameter, in µs since the clock's epoch. If this function is invoked before - the first event loop iteration the current time is returned, as + the first event loop iteration, the current time is returned, as reported by clock_gettime(). To distinguish this case from a regular invocation the return value will be - positive non-zero in this case, while it is zero when the returned - timestamp refers to the actual event loop iteration. + positive, and zero when the returned timestamp refers to an actual + event loop iteration. Return Value If the first event loop iteration has not run yet - sd_event_now() returns the requested - timestamp in usec and returns a positive, - non-zero return value. Otherwise, on success it will return the - iteration's timestamp in usec and 0 as - return value. On failure, the call returns a negative errno-style + sd_event_now() writes current time to + usec and returns a positive return value. + Otherwise, it will write the requested timestamp to usec + and return 0. On failure, the call returns a negative errno-style error code. Errors - Returned errors may indicate the following problems: + Returned values may indicate the following problems: