libexplain/message/connect.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/connect.h>

Go to the source code of this file.

Functions
void	explain_message_connect (char *message, int message_size, int fildes, const struct sockaddr *serv_addr, int serv_addr_size)

---

Function Documentation

void explain_message_connect	(	char *	message,
		int	message_size,
		int	fildes,
		const struct sockaddr *	serv_addr,
		int	serv_addr_size
	)

The explain_message_connect function is used to obtain an explanation of an error returned by the connect(2) system call. The least the message will contain is the value of strerror(errnum), but usually it will do much better, and indicate the underlying cause in more detail.

The errno global variable will be used to obtain the error value to be decoded.

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

 if (connect(fildes, serv_addr, serv_addr_size) < 0)
 {
     char message[3000];
     explain_message_connect(message, sizeof(message), fildes, serv_addr,
         serv_addr_size);
     fprintf(stderr, "%s\n", message);
     exit(EXIT_FAILURE);
 }

The above code example is available pre-packaged as the explain_connect_or_die function.

Parameters:

message	The location in which to store the returned message. If a suitable message return buffer is supplied, this function is thread safe.
message_size	The size in bytes of the location in which to store the returned message.
fildes	The original fildes, exactly as passed to the connect(2) system call.
serv_addr	The original serv_addr, exactly as passed to the connect(2) system call.
serv_addr_size	The original serv_addr_size, exactly as passed to the connect(2) system call.

Definition at line 25 of file connect.c.