From c11dd1c49b997de4d222f302070387f82d8068ca Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Thu, 19 Nov 2015 23:38:54 +0100 Subject: man: fully document sd-event interfaces This completes the set of man pages for sd-event and contains some minor other fixes for other man pages too. The sd_event_set_name(3) man page is renamed to sd_event_source_set_description(3), which is the correct name of the concept today. --- man/sd_event_now.xml | 141 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 141 insertions(+) create mode 100644 man/sd_event_now.xml (limited to 'man/sd_event_now.xml') diff --git a/man/sd_event_now.xml b/man/sd_event_now.xml new file mode 100644 index 000000000..b4105236d --- /dev/null +++ b/man/sd_event_now.xml @@ -0,0 +1,141 @@ + + + + + + + + + sd_event_now + elogind + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + sd_event_now + 3 + + + + sd_event_now + + Retrieve current event loop iteration timestamp + + + + + #include <elogind/sd-event.h> + + + int sd_event_now + sd_event *event + clockid_t clock + uint64_t *usec + + + + + + + Description + + sd_event_now() returns the timestamp + the most recent event loop iteration began. This timestamp is + taken right after after returning from the event sleep, and before + dispatching any event sources. The event + parameter takes the even 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_ALARM), + CLOCK_MONOTONIC or + CLOCK_BOOTTIME (or its equivalent + 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 + 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. + + + + 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 + error code. + + + + Errors + + Returned errors may indicate the following problems: + + + + -EINVAL + + An invalid parameter was + passed. + + + + + -ECHILD + + The event loop object was created in a + different process. + + + + + + + + + See Also + + + elogind1, + sd-event3, + sd_event_new3, + sd_event_add_time3, + clock_gettime2 + + + + -- cgit v1.2.3