libexplain/poll_or_die.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/poll.h>
#include <libexplain/output.h>
#include <libexplain/poll.h>

Go to the source code of this file.

Functions
int	explain_poll_or_die (struct pollfd *data, int data_size, int timeout)
int	explain_poll_on_error (struct pollfd *data, int data_size, int timeout)

---

Function Documentation

int explain_poll_on_error	(	struct pollfd *	data,
		int	data_size,
		int	timeout
	)

The explain_poll_on_error function is used to call the poll(2) system call. On failure an explanation will be printed to stderr, obtained from the explain_poll(3) function.

Parameters:

data	The data, exactly as to be passed to the poll(2) system call.
data_size	The data_size, exactly as to be passed to the poll(2) system call.
timeout	The timeout, exactly as to be passed to the poll(2) system call.

Returns:

The value returned by the wrapped poll(2) system call.

Example:

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

 int result = explain_poll_on_error(data, data_size, timeout);
 if (result < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 41 of file poll_or_die.c.

int explain_poll_or_die	(	struct pollfd *	data,
		int	data_size,
		int	timeout
	)

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

Parameters:

data	The data, exactly as to be passed to the poll(2) system call.
data_size	The data_size, exactly as to be passed to the poll(2) system call.
timeout	The timeout, exactly as to be passed to the poll(2) system call.

Returns:

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

 int result = explain_poll_or_die(data, data_size, timeout);

Definition at line 27 of file poll_or_die.c.