GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  EXPLAIN_GETSOCKNAME (3)

NAME

explain_getsockname - explain getsockname(2) errors

CONTENTS

Synopsis
Description
See Also
Copyright

SYNOPSIS

#include <libexplain/getsockname.h>

const char *explain_getsockname(int fildes, struct sockaddr *sock_addr, socklen_t *sock_addr_size);
const char *explain_errno_getsockname(int errnum, int fildes, struct sockaddr *sock_addr, socklen_t *sock_addr_size);
void explain_message_getsockname(char *message, int message_size, int fildes, struct sockaddr *sock_addr, socklen_t *sock_addr_size);
void explain_message_errno_getsockname(char *message, int message_size, int errnum, int fildes, struct sockaddr *sock_addr, socklen_t *sock_addr_size);

DESCRIPTION

These functions may be used to obtain explanations for errors returned by the I]getsockname(2) system call.

    explain_getsockname

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

The B]explain_getsockname function is used to obtain an explanation of an error returned by the I]getsockname(2) system call. The least the message will contain is the value of CW]strerror(errno), but usually it will do much better, and indicate the underlying cause in more detail.

The I]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:

struct sockaddr sock_addr;
socklen_t sock_addr_size = sizeof(sock_addr);
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[hy]packaged as the I]explain_getsockname_or_die(3) function.
I]fildes The original fildes, exactly as passed to the I]getsockname(2) system call.
I]sock_addr
  The original sock_addr, exactly as passed to the I]getsockname(2) system call.
I]sock_addr_size
  The original sock_addr_size, exactly as passed to the I]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.
B]Note: This function is B]not thread safe, because it shares a return buffer across all threads, and many other functions in this library.

    explain_errno_getsockname

const char *explain_errno_getsockname(int errnum, int fildes, struct sockaddr *sock_addr, socklen_t *sock_addr_size);

The B]explain_errno_getsockname function is used to obtain an explanation of an error returned by the I]getsockname(2) system call. The least the message will contain is the value of CW]strerror(errnum), 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:

struct sockaddr sock_addr;
socklen_t sock_addr_size = sizeof(sock_addr);
if (getsockname(fildes, &sock_addr, &sock_addr_size) < 0)
{
    int err = errno;
    fprintf(stderr, "%s\n", explain_errno_getsockname(err,
        fildes, &sock_addr, &sock_addr_size));
    exit(EXIT_FAILURE);
}

The above code example is available pre[hy]packaged as the I]explain_getsockname_or_die(3) function.
I]errnum The error value to be decoded, usually obtained from the I]errno global variable just before this function is called. This is necessary if you need to call B]any code between the system call to be explained and this function, because many libc functions will alter the value of I]errno.
I]fildes The original fildes, exactly as passed to the I]getsockname(2) system call.
I]sock_addr
  The original sock_addr, exactly as passed to the I]getsockname(2) system call.
I]sock_addr_size
  The original sock_addr_size, exactly as passed to the I]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.
B]Note: This function is B]not thread safe, because it shares a return buffer across all threads, and many other functions in this library.

    explain_message_getsockname

void explain_message_getsockname(char *message, int message_size, int fildes, struct sockaddr *sock_addr, socklen_t *sock_addr_size);

The B]explain_message_getsockname function may be used to obtain an explanation of an error returned by the I]getsockname(2) system call. The least the message will contain is the value of CW]strerror(errno), but usually it will do much better, and indicate the underlying cause in more detail.

The I]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:

struct sockaddr sock_addr;
socklen_t sock_addr_size = sizeof(sock_addr);
if (getsockname(fildes, &sock_addr, &sock_addr_size) < 0)
{
    char message[3000];
    explain_message_getsockname(message, sizeof(message),
        fildes, &sock_addr, &sock_addr_size);
    fprintf(stderr, "%s\n", message);
    exit(EXIT_FAILURE);
}

The above code example is available pre[hy]packaged as the I]explain_getsockname_or_die(3) function.
I]message
  The location in which to store the returned message. If a suitable message return buffer is supplied, this function is thread safe.
I]message_size
  The size in bytes of the location in which to store the returned message.
I]fildes The original fildes, exactly as passed to the I]getsockname(2) system call.
I]sock_addr
  The original sock_addr, exactly as passed to the I]getsockname(2) system call.
I]sock_addr_size
  The original sock_addr_size, exactly as passed to the I]getsockname(2) system call.

    explain_message_errno_getsockname

void explain_message_errno_getsockname(char *message, int message_size, int errnum, int fildes, struct sockaddr *sock_addr, socklen_t *sock_addr_size);

The B]explain_message_errno_getsockname function may be used to obtain an explanation of an error returned by the I]getsockname(2) system call. The least the message will contain is the value of CW]strerror(errnum), 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:

struct sockaddr sock_addr;
socklen_t sock_addr_size = sizeof(sock_addr);
if (getsockname(fildes, &sock_addr, &sock_addr_size) < 0)
{
    int err = errno;
    char message[3000];
    explain_message_errno_getsockname(message, sizeof(message),
        err, fildes, &sock_addr, &sock_addr_size);
    fprintf(stderr, "%s\n", message);
    exit(EXIT_FAILURE);
}

The above code example is available pre[hy]packaged as the I]explain_getsockname_or_die(3) function.
I]message
  The location in which to store the returned message. If a suitable message return buffer is supplied, this function is thread safe.
I]message_size
  The size in bytes of the location in which to store the returned message.
I]errnum The error value to be decoded, usually obtained from the I]errno global variable just before this function is called. This is necessary if you need to call B]any code between the system call to be explained and this function, because many libc functions will alter the value of I]errno.
I]fildes The original fildes, exactly as passed to the I]getsockname(2) system call.
I]sock_addr
  The original sock_addr, exactly as passed to the I]getsockname(2) system call.
I]sock_addr_size
  The original sock_addr_size, exactly as passed to the I]getsockname(2) system call.

SEE ALSO

I]getsockname(2)
  get socket name
I]explain_getsockname_or_die(3)
  get socket name and report errors

COPYRIGHT

libexplain version 1.3
Copyright © 2009 Peter Miller
Search for    or go to Top of page |  Section 3 |  Main Index


EXPLAIN_GETSOCKNAME (3) -->

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.