libexplain/setsockopt_on_error.c File Reference

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

Go to the source code of this file.

Functions
int	explain_setsockopt_on_error (int fildes, int level, int name, void *data, socklen_t data_size)

---

Function Documentation

int explain_setsockopt_on_error	(	int	fildes,
		int	level,
		int	name,
		void *	data,
		socklen_t	data_size
	)

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

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

 if (explain_setsockopt_on_error(fildes, level, name, data, data_size) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Parameters:

fildes	The fildes, exactly as to be passed to the setsockopt(2) system call.
level	The level, exactly as to be passed to the setsockopt(2) system call.
name	The name, exactly as to be passed to the setsockopt(2) system call.
data	The data, exactly as to be passed to the setsockopt(2) system call.
data_size	The data_size, exactly as to be passed to the setsockopt(2) system call.

Returns:

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

Definition at line 27 of file setsockopt_on_error.c.