explain_timerfd_create_or_die(3)

explain_timerfd_create_or_die3

Create file descriptor timers and report errors

Usage

#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);

Overview

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.

Examples

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);

Releases

6 releases since Debian 7 (Wheezy); the text changed 1 time.

  1. 7
  2. 9–13

From libexplain-dev 1.4.D001-16 in Debian 13 (Trixie). Parsed by carta from the page's man source.