libexplain/usleep_or_die.c File Reference

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

Go to the source code of this file.

Functions
void	explain_usleep_or_die (long long usec)
int	explain_usleep_on_error (long long usec)

---

Function Documentation

int explain_usleep_on_error

(

long long

usec

)

The explain_usleep_on_error function is used to call the usleep(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_usleep(3) function.

Parameters:

usec	The usec, exactly as to be passed to the usleep(3) system call.

Returns:

The value returned by the wrapped usleep(3) system call.

Example:

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

 if (explain_usleep_on_error(usec) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 37 of file usleep_or_die.c.

void explain_usleep_or_die

(

long long

usec

)

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

Parameters:

usec	The usec, exactly as to be passed to the usleep(3) system call.

Returns:

This function only returns on success, see usleep(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:

 explain_usleep_or_die(usec);

Definition at line 27 of file usleep_or_die.c.