libexplain/getpeername_or_die.c File Reference

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

Go to the source code of this file.

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

---

Function Documentation

void explain_getpeername_or_die	(	int	fildes,
		struct sockaddr *	sock_addr,
		socklen_t *	sock_addr_size
	)

The explain_getpeername_or_die 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, and then the process terminates by calling exit(EXIT_FAILURE).

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

 explain_getpeername_or_die(fildes, sock_addr, sock_addr_size);

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:

This function only returns on success. On failure, prints an explanation and exits, it does not return.

Definition at line 26 of file getpeername_or_die.c.