libexplain/getsockopt_on_error.c File Reference

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

Go to the source code of this file.

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

---

Function Documentation

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

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

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

 if (explain_getsockopt_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 getsockopt(2) system call.
level	The level, exactly as to be passed to the getsockopt(2) system call.
name	The name, exactly as to be passed to the getsockopt(2) system call.
data	The data, exactly as to be passed to the getsockopt(2) system call.
data_size	The data_size, exactly as to be passed to the getsockopt(2) system call.

Returns:

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

Definition at line 27 of file getsockopt_on_error.c.