libexplain/connect_on_error.c File Reference

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

Go to the source code of this file.

Functions
int	explain_connect_on_error (int fildes, const struct sockaddr *serv_addr, int serv_addr_size)

---

Function Documentation

int explain_connect_on_error	(	int	fildes,
		const struct sockaddr *	serv_addr,
		int	serv_addr_size
	)

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

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

 if (explain_connect_on_error(fildes, serv_addr, serv_addr_size) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Parameters:

fildes	The fildes, exactly as to be passed to the connect(2) system call.
serv_addr	The serv_addr, exactly as to be passed to the connect(2) system call.
serv_addr_size	The serv_addr_size, exactly as to be passed to the connect(2) system call.

Returns:

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

Definition at line 27 of file connect_on_error.c.