libexplain/errno/getaddrinfo.c File Reference

#include <libexplain/common_message_buffer.h>
#include <libexplain/getaddrinfo.h>

Go to the source code of this file.

Functions
const char *	explain_errcode_getaddrinfo (int errcode, const char *node, const char *service, const struct addrinfo *hints, struct addrinfo **res)

---

Function Documentation

const char* explain_errcode_getaddrinfo	(	int	errnum,
		const char *	node,
		const char *	service,
		const struct addrinfo *	hints,
		struct addrinfo **	res
	)

The explain_errcode_getaddrinfo function is used to obtain an explanation of an error returned by the getaddrinfo(3) system call. The least the message will contain is the value of gai_strerror(errcode), but usually it will do much better, and indicate the underlying cause in more detail.

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

 int errcode = getaddrinfo(node, service, hints, res);
 if (errcode == EAI_SYSTEM)
     errcode = errno;
 if (errcode)
 {
     fprintf(stderr, "%s\n", explain_errcode_getaddrinfo(errcode,
         node, service, hints, res));
     exit(EXIT_FAILURE);
 }

Parameters:

errnum	The error value to be decoded, as returned by the getaddrinfo(3) system call.
node	The original node, exactly as passed to the getaddrinfo(3) system call.
service	The original service, exactly as passed to the getaddrinfo(3) system call.
hints	The original hints, exactly as passed to the getaddrinfo(3) system call.
res	The original res, exactly as passed to the getaddrinfo(3) system call.

Returns:

The message explaining the error. This message buffer is shared by all libexplain functions which do not supply a buffer in their argument list. This will be overwritten by the next call to any libexplain function which shares this buffer, including other threads.

Note:

This function is not thread safe, because it shares a return buffer across all threads, and many other functions in this library.

Definition at line 24 of file getaddrinfo.c.