explain_select(3)                                            explain_select(3)



NNAAMMEE
       explain_select - explain select(2) errors

SSYYNNOOPPSSIISS
       #include <sys/select.h> #include <libexplain/select.h>
       const char *explain_select(int nfds, fd_set *readfds, fd_set *writefds,
       fd_set *exceptfds, struct timeval *timeout);
       const char *explain_errno_select(int errnum, int nfds, fd_set *readfds,
       fd_set *writefds, fd_set *exceptfds, struct timeval *timeout);
       void  explain_message_select(char *message, int message_size, int nfds,
       fd_set *readfds, fd_set *writefds, fd_set  *exceptfds,  struct  timeval
       *timeout);
       void  explain_message_errno_select(char *message, int message_size, int
       errnum, int nfds, fd_set *readfds, fd_set *writefds, fd_set *exceptfds,
       struct timeval *timeout);

DDEESSCCRRIIPPTTIIOONN
       These  functions may be used to obtain explanations for errors returned
       by the _s_e_l_e_c_t(2) system call.

   eexxppllaaiinn__sseelleecctt
       const char *explain_select(int nfds, fd_set *readfds, fd_set *writefds,
       fd_set *exceptfds, struct timeval *timeout);

       The  eexxppllaaiinn__sseelleecctt  function  is  used  to obtain an explanation of an
       error returned by the _s_e_l_e_c_t(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 _e_r_r_n_o 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 fol-
       lowing example:
              if (select(nfds, readfds, writefds, exceptfds, timeout) < 0)
              {
                  fprintf(stderr, "%s\n", explain_select(nfds,
                      readfds, writefds, exceptfds, timeout));
                  exit(EXIT_FAILURE);
              }

       _n_f_d_s    The original nfds, exactly as passed to  the  _s_e_l_e_c_t(2)  system
               call.

       _r_e_a_d_f_d_s The original readfds, exactly as passed to the _s_e_l_e_c_t(2) system
               call.

       _w_r_i_t_e_f_d_s
               The original writefds, exactly as passed to the _s_e_l_e_c_t(2)  sys-
               tem call.

       _e_x_c_e_p_t_f_d_s
               The original exceptfds, exactly as passed to the _s_e_l_e_c_t(2) sys-
               tem call.

       _t_i_m_e_o_u_t The original timeout, exactly as passed to the _s_e_l_e_c_t(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.

       NNoottee:: This function is nnoott thread safe, because it shares a return buf-
       fer across all threads, and many other functions in this library.

   eexxppllaaiinn__eerrrrnnoo__sseelleecctt
       const char *explain_errno_select(int errnum, int nfds, fd_set *readfds,
       fd_set *writefds, fd_set *exceptfds, struct timeval *timeout);

       The  eexxppllaaiinn__eerrrrnnoo__sseelleecctt  function is used to obtain an explanation of
       an error returned by the _s_e_l_e_c_t(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.

       This function is intended to be used in a fashion similar to  the  fol-
       lowing example:
              if (select(nfds, readfds, writefds, exceptfds, timeout) < 0)
              {
                  int err = errno;
                  fprintf(stderr, "%s\n", explain_errno_select(err,
                      nfds, readfds, writefds, exceptfds, timeout));
                  exit(EXIT_FAILURE);
              }

       _e_r_r_n_u_m  The  error value to be decoded, usually obtained from the _e_r_r_n_o
               global variable just before this function is called.   This  is
               necessary  if you need to call aannyy code between the system call
               to be explained and this function, because many libc  functions
               will alter the value of _e_r_r_n_o.

       _n_f_d_s    The  original  nfds,  exactly as passed to the _s_e_l_e_c_t(2) system
               call.

       _r_e_a_d_f_d_s The original readfds, exactly as passed to the _s_e_l_e_c_t(2) system
               call.

       _w_r_i_t_e_f_d_s
               The  original writefds, exactly as passed to the _s_e_l_e_c_t(2) sys-
               tem call.

       _e_x_c_e_p_t_f_d_s
               The original exceptfds, exactly as passed to the _s_e_l_e_c_t(2) sys-
               tem call.

       _t_i_m_e_o_u_t The original timeout, exactly as passed to the _s_e_l_e_c_t(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.

       NNoottee:: This function is nnoott thread safe, because it shares a return buf-
       fer across all threads, and many other functions in this library.

   eexxppllaaiinn__mmeessssaaggee__sseelleecctt
       void  explain_message_select(char *message, int message_size, int nfds,
       fd_set *readfds, fd_set *writefds, fd_set  *exceptfds,  struct  timeval
       *timeout);

       The  eexxppllaaiinn__mmeessssaaggee__sseelleecctt function may be used to  obtain an explana-
       tion of an error returned by the _s_e_l_e_c_t(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 _e_r_r_n_o 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 fol-
       lowing example:
              if (select(nfds, readfds, writefds, exceptfds, timeout) < 0)
              {
                  char message[3000];
                  explain_message_select(message, sizeof(message),
                      nfds, readfds, writefds, exceptfds, timeout);
                  fprintf(stderr, "%s\n", message);
                  exit(EXIT_FAILURE);
              }

       _m_e_s_s_a_g_e The location in which to store  the  returned  message.   If  a
               suitable  message  return  buffer is supplied, this function is
               thread safe.

       _m_e_s_s_a_g_e___s_i_z_e
               The size in bytes  of  the  location  in  which  to  store  the
               returned message.

       _n_f_d_s    The  original  nfds,  exactly as passed to the _s_e_l_e_c_t(2) system
               call.

       _r_e_a_d_f_d_s The original readfds, exactly as passed to the _s_e_l_e_c_t(2) system
               call.

       _w_r_i_t_e_f_d_s
               The  original writefds, exactly as passed to the _s_e_l_e_c_t(2) sys-
               tem call.

       _e_x_c_e_p_t_f_d_s
               The original exceptfds, exactly as passed to the _s_e_l_e_c_t(2) sys-
               tem call.

       _t_i_m_e_o_u_t The original timeout, exactly as passed to the _s_e_l_e_c_t(2) system
               call.

   eexxppllaaiinn__mmeessssaaggee__eerrrrnnoo__sseelleecctt
       void explain_message_errno_select(char *message, int message_size,  int
       errnum, int nfds, fd_set *readfds, fd_set *writefds, fd_set *exceptfds,
       struct timeval *timeout);

       The eexxppllaaiinn__mmeessssaaggee__eerrrrnnoo__sseelleecctt function may  be  used  to  obtain  an
       explanation  of  an  error  returned by the _s_e_l_e_c_t(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.

       This function is intended to be used in a fashion similar to  the  fol-
       lowing example:
              if (select(nfds, readfds, writefds, exceptfds, timeout) < 0)
              {
                  int err = errno;
                  char message[3000];
                  explain_message_errno_select(message, sizeof(message), err,
                      nfds, readfds, writefds, exceptfds, timeout);
                  fprintf(stderr, "%s\n", message);
                  exit(EXIT_FAILURE);
              }

       _m_e_s_s_a_g_e The  location  in  which  to  store the returned message.  If a
               suitable message return buffer is supplied,  this  function  is
               thread safe.

       _m_e_s_s_a_g_e___s_i_z_e
               The  size  in  bytes  of  the  location  in  which to store the
               returned message.

       _e_r_r_n_u_m  The error value to be decoded, usually obtained from the  _e_r_r_n_o
               global  variable  just before this function is called.  This is
               necessary if you need to call aannyy code between the system  call
               to  be explained and this function, because many libc functions
               will alter the value of _e_r_r_n_o.

       _n_f_d_s    The original nfds, exactly as passed to  the  _s_e_l_e_c_t(2)  system
               call.

       _r_e_a_d_f_d_s The original readfds, exactly as passed to the _s_e_l_e_c_t(2) system
               call.

       _w_r_i_t_e_f_d_s
               The original writefds, exactly as passed to the _s_e_l_e_c_t(2)  sys-
               tem call.

       _e_x_c_e_p_t_f_d_s
               The original exceptfds, exactly as passed to the _s_e_l_e_c_t(2) sys-
               tem call.

       _t_i_m_e_o_u_t The original timeout, exactly as passed to the _s_e_l_e_c_t(2) system
               call.

SSEEEE AALLSSOO
       _s_e_l_e_c_t(2)
               blah blah

       _e_x_p_l_a_i_n___s_e_l_e_c_t___o_r___d_i_e(3)
               blah blah and report errors

CCOOPPYYRRIIGGHHTT
       libexplain version 1.4
       Copyright (C) 2008 Peter Miller



                                                             explain_select(3)
