libexplain  1.4.D001
Functions
libexplain/getsockname.c File Reference
#include <libexplain/ac/errno.h>
#include <libexplain/ac/sys/socket.h>
#include <libexplain/getsockname.h>

Go to the source code of this file.

Functions

const char * explain_getsockname (int fildes, struct sockaddr *sock_addr, socklen_t *sock_addr_size)

Function Documentation

const char* explain_getsockname ( int  fildes,
struct sockaddr *  sock_addr,
socklen_t *  sock_addr_size 
)

The explain_getsockname function is used to obtain an explanation of an error returned by the getsockname(2) system call. The least the message will contain is the value of strerror(errno), 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 (getsockname(fildes, sock_addr, sock_addr_size) < 0)
 {
     fprintf(stderr, "%s\n", explain_getsockname(fildes, sock_addr,
         sock_addr_size));
     exit(EXIT_FAILURE);
 }

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

Parameters:
fildesThe original fildes, exactly as passed to the getsockname(2) system call.
sock_addrThe original sock_addr, exactly as passed to the getsockname(2) system call.
sock_addr_sizeThe original sock_addr_size, exactly as passed to the getsockname(2) 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 26 of file getsockname.c.