.lf 1 ./man/man3/explain_getaddrinfo.3
.\"
.\" libexplain - Explain errno values returned by libc functions
.\" Copyright (C) 2008-2011 Peter Miller
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or (at
.\" your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
.\" General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see .
.\"
.ds n) explain_getaddrinfo
.cp 0 \" Solaris defaults to ''.cp 1'', sheesh.
.TH explain_getaddrinfo 3
.SH NAME
explain_getaddrinfo \- explain getaddrinfo(3) errors
.if require_index \{
.\}
.SH SYNOPSIS
#include
.sp 0.3
const char *explain_errcode_getaddrinfo(int errnum, const char *node,
const char *service, const struct addrinfo *hints, struct addrinfo **res);
.br
void explain_message_errcode_getaddrinfo(char *message, int message_size,
int errnum, const char *node, const char *service, const struct addrinfo *hints,
struct addrinfo **res);
.SH DESCRIPTION
These functions may be used to obtain explanations for
errors returned by the \f[I]getaddrinfo\fP(3) system call.
.\" ----------------------------------------------------
.SS explain_errcode_getaddrinfo
const char *explain_errcode_getaddrinfo(int errnum, const char *node,
const char *service, const struct addrinfo *hints, struct addrinfo **res);
.PP
The \f[B]explain_errcode_getaddrinfo\fP function is used to obtain
an explanation of an error returned by the \f[I]getaddrinfo\fP(3)
system call. The least the message will contain is the value of
\f[CW]gai_strerror(errcode)\fP, but usually it will do much better, and
indicate the underlying cause in more detail.
.PP
This function is intended to be used in a fashion
similar to the following example:
.RS
.ft CW
.nf
int errcode = getaddrinfo(node, service, hints, res);
if (errncode == GAI_SYSTEM)
errcode = errno;
if (errcode)
{
fprintf(stderr, "%s\en", explain_errcode_getaddrinfo(errcode,
node, service, hints, res));
exit(EXIT_FAILURE);
}
.fi
.ft R
.RE
.PP
The above code example is available as the
\f[I]explain_getaddrinfo_or_die\fP(3) function.
.TP 8n
\f[I]errnum\fP
The error value to be decoded, usually obtained from
the \f[I]errno\fP global variable just before this
function is called. This is necessary if you need to call
\f[B]any\fP code between the system call to be explained
and this function, because many libc functions will alter
the value of \f[I]errno\fP.
.TP 8n
\f[I]node\fP
The original node, exactly as passed to the \f[I]getaddrinfo\fP(3) system call.
.TP 8n
\f[I]service\fP
The original service, exactly as passed to the \f[I]getaddrinfo\fP(3)
system call.
.TP 8n
\f[I]hints\fP
The original hints, exactly as passed to the \f[I]getaddrinfo\fP(3) system call.
.TP 8n
\f[I]res\fP
The original res, exactly as passed to the \f[I]getaddrinfo\fP(3) system call.
.TP 8n
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.
.PP
\f[B]Note:\fP
This function is \f[B]not\fP thread safe, because it
shares a return buffer across all threads, and many other
functions in this library.
.\" ----------------------------------------------------
.SS explain_message_errno_getaddrinfo
void explain_message_errno_getaddrinfo(char *message, int message_size,
int errnum, const char *node, const char *service, const struct addrinfo *hints,
struct addrinfo **res);
.PP
The \f[B]explain_message_errno_getaddrinfo\fP
function may be used to obtain an explanation of an error
returned by the
\f[I]getaddrinfo\fP(3) system call.
The least the message will contain is the value of
\f[CW]strerror(errnum)\fP, but usually it will do much
better, and indicate the underlying cause in more detail.
.PP
This function is intended to be used in a fashion
similar to the following example:
.RS
.ft CW
.nf
int errcode = getaddrinfo(node, service, hints, res);
if (errnode == EAI_SYSTEM)
errcode = errno;
if (errcode)
{
char message[3000];
explain_message_errcode_getaddrinfo(message, sizeof(message),
errcode, node, service, hints, res);
fprintf(stderr, "%s\en", message);
exit(EXIT_FAILURE);
}
.fi
.ft R
.RE
.PP
The above code example is available pre\[hy]packaged
as the \f[I]explain_getaddrinfo_or_die\fP(3) function.
.TP 8n
\f[I]message\fP
The location in which to store the returned message.
If a suitable message return buffer is supplied, this
function is thread safe.
.TP 8n
\f[I]message_size\fP
The size in bytes of the location in which to
store the returned message.
.TP 8n
\f[I]errnum\fP
The error value to be decoded, usually obtained from
the \f[I]errno\fP global variable just before this
function is called. This is necessary if you need to call
\f[B]any\fP code between the system call to be explained
and this function, because many libc functions will alter
the value of \f[I]errno\fP.
.TP 8n
\f[I]node\fP
The original node, exactly as passed to the \f[I]getaddrinfo\fP(3) system call.
.TP 8n
\f[I]service\fP
The original service, exactly as passed to the \f[I]getaddrinfo\fP(3)
system call.
.TP 8n
\f[I]hints\fP
The original hints, exactly as passed to the \f[I]getaddrinfo\fP(3) system call.
.TP 8n
\f[I]res\fP
The original res, exactly as passed to the \f[I]getaddrinfo\fP(3) system call.
.\" ----------------------------------------------------
.SH SEE ALSO
.TP 8n
\f[I]getaddrinfo\fP(3)
network address and
.TP 8n
\f[I]explain_getaddrinfo_or_die\fP(3)
network address and and report errors
.\" ----------------------------------------------------
.SH COPYRIGHT
.lf 1 ./etc/version.so
.ds v) 1.4
.ds V) 1.4.D001
.ds Y) 2008, 2009, 2010, 2011, 2012, 2013, 2014
.lf 179 ./man/man3/explain_getaddrinfo.3
.if n .ds C) (C)
.if t .ds C) \(co
libexplain version \*(v)
.br
Copyright \*(C) 2008 Peter Miller