explain_timerfd_create_or_die man page

explain_timerfd_create_or_die — create file descriptor timers and report errors

Synopsis

#include <libexplain/timerfd_create.h>

int explain_timerfd_create_or_die(int clockid, int flags);
int explain_timerfd_create_on_error(int clockid, int flags);

Description

The explain_timerfd_create_or_die function is used to call the timerfd_create(2) system call. On failure an explanation will be printed to stderr, obtained from the explain_timerfd_create(3) function, and then the process terminates by calling exit(EXIT_FAILURE).

The explain_timerfd_create_on_error function is used to call the timerfd_create(2) system call. On failure an explanation will be printed to stderr, obtained from the explain_timerfd_create(3) function, but still returns to the caller.

clockid
The clockid, exactly as to be passed to the timerfd_create(2) system call.
flags
The flags, exactly as to be passed to the timerfd_create(2) system call.

Return Value

The explain_timerfd_create_or_die function only returns on success, see timerfd_create(2) for more information. On failure, prints an explanation and exits, it does not return.

The explain_timerfd_create_on_error function always returns the value return by the wrapped timerfd_create(2) system call.

Example

The explain_timerfd_create_or_die function is intended to be used in a fashion similar to the following example:

int result = explain_timerfd_create_or_die(clockid, flags);

See Also

timerfd_create(2)
timers that notify via file descriptors
explain_timerfd_create(3)
explain timerfd_create(2) errors
exit(2)
terminate the calling process

Referenced By

explain(3), explain_timerfd_create(3).