#include <libexplain/ac/errno.h>
#include <libexplain/ac/unistd.h>
#include <libexplain/output.h>
#include <libexplain/sleep.h>

Functions
unsigned int	explain_sleep_or_die (unsigned int seconds)
unsigned int	explain_sleep_on_error (unsigned int seconds)

Function Documentation

unsigned int explain_sleep_on_error ( unsigned int seconds )

The explain_sleep_on_error function is used to call the sleep(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_sleep(3) function.

Parameters:

seconds The seconds, exactly as to be passed to the sleep(3) system call.

Returns:: The value returned by the wrapped sleep(3) system call.

Example:

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

 unsigned int result = explain_sleep_on_error(seconds);
 if (result < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 45 of file sleep_or_die.c.

unsigned int explain_sleep_or_die ( unsigned int seconds )

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

Parameters:

seconds The seconds, exactly as to be passed to the sleep(3) system call.

Returns:: This function only returns on success, see sleep(3) for more information. On failure, prints an explanation and exits, it does not return.

Example:

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

 unsigned int result = explain_sleep_or_die(seconds);

Definition at line 27 of file sleep_or_die.c.

Functions

Function Documentation