libexplain/message/socket.c File Reference

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

Go to the source code of this file.

Functions
void	explain_message_socket (char *message, int message_size, int domain, int type, int protocol)

---

Function Documentation

void explain_message_socket	(	char *	message,
		int	message_size,
		int	domain,
		int	type,
		int	protocol
	)

The explain_message_socket function is used to obtain an explanation of an error returned by the socket(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:

 int fildes = socket(domain, type, protocol);
 if (fildes < 0)
 {
     char message[3000];
     explain_message_socket(message, sizeof(message), domain, type,
         protocol);
     fprintf(stderr, "%s\n", message);
     exit(EXIT_FAILURE);
 }

The above code example is available pre-packaged as the explain_socket_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.
domain	The original domain, exactly as passed to the socket(2) system call.
type	The original type, exactly as passed to the socket(2) system call.
protocol	The original protocol, exactly as passed to the socket(2) system call.

Definition at line 25 of file socket.c.