libexplain/socketpair_or_die.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/sys/socket.h>
#include <libexplain/output.h>
#include <libexplain/socketpair.h>

Go to the source code of this file.

Functions
void	explain_socketpair_or_die (int domain, int type, int protocol, int *sv)
int	explain_socketpair_on_error (int domain, int type, int protocol, int *sv)

---

Function Documentation

int explain_socketpair_on_error	(	int	domain,
		int	type,
		int	protocol,
		int *	sv
	)

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

Parameters:

domain	The domain, exactly as to be passed to the socketpair(2) system call.
type	The type, exactly as to be passed to the socketpair(2) system call.
protocol	The protocol, exactly as to be passed to the socketpair(2) system call.
sv	The sv, exactly as to be passed to the socketpair(2) system call.

Returns:

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

Example:

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

 if (explain_socketpair_on_error(domain, type, protocol, sv) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 37 of file socketpair_or_die.c.

void explain_socketpair_or_die	(	int	domain,
		int	type,
		int	protocol,
		int *	sv
	)

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

Parameters:

domain	The domain, exactly as to be passed to the socketpair(2) system call.
type	The type, exactly as to be passed to the socketpair(2) system call.
protocol	The protocol, exactly as to be passed to the socketpair(2) system call.
sv	The sv, exactly as to be passed to the socketpair(2) system call.

Returns:

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

 explain_socketpair_or_die(domain, type, protocol, sv);

Definition at line 27 of file socketpair_or_die.c.