libexplain/getpeername_on_error.c File Reference

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

Go to the source code of this file.

Functions
int	explain_getpeername_on_error (int fildes, struct sockaddr *sock_addr, socklen_t *sock_addr_size)

---

Function Documentation

int explain_getpeername_on_error	(	int	fildes,
		struct sockaddr *	sock_addr,
		socklen_t *	sock_addr_size
	)

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

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

 if (explain_getpeername_on_error(fildes, sock_addr, sock_addr_size) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Parameters:

fildes	The fildes, exactly as to be passed to the getpeername(2) system call.
sock_addr	The sock_addr, exactly as to be passed to the getpeername(2) system call.
sock_addr_size	The sock_addr_size, exactly as to be passed to the getpeername(2) system call.

Returns:

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

Definition at line 27 of file getpeername_on_error.c.