]> git.kernelconcepts.de Git - karo-tx-redboot.git/blobdiff - doc/html/ref/net-common-tcpip-manpages-select.html
Initial revision
[karo-tx-redboot.git] / doc / html / ref / net-common-tcpip-manpages-select.html
diff --git a/doc/html/ref/net-common-tcpip-manpages-select.html b/doc/html/ref/net-common-tcpip-manpages-select.html
new file mode 100644 (file)
index 0000000..fb1a700
--- /dev/null
@@ -0,0 +1,299 @@
+<!-- Copyright (C) 2003 Red Hat, Inc.                                -->
+<!-- This material may be distributed only subject to the terms      -->
+<!-- and conditions set forth in the Open Publication License, v1.0  -->
+<!-- or later (the latest version is presently available at          -->
+<!-- http://www.opencontent.org/openpub/).                           -->
+<!-- Distribution of the work or derivative of the work in any       -->
+<!-- standard (paper) book form is prohibited unless prior           -->
+<!-- permission is obtained from the copyright holder.               -->
+<HTML
+><HEAD
+><TITLE
+>select</TITLE
+><meta name="MSSmartTagsPreventParsing" content="TRUE">
+<META
+NAME="GENERATOR"
+CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
+"><LINK
+REL="HOME"
+TITLE="eCos Reference Manual"
+HREF="ecos-ref.html"><LINK
+REL="UP"
+TITLE="TCP/IP Library Reference"
+HREF="tcpip-library-reference.html"><LINK
+REL="PREVIOUS"
+TITLE="poll"
+HREF="net-common-tcpip-manpages-poll.html"><LINK
+REL="NEXT"
+TITLE="send"
+HREF="net-common-tcpip-manpages-send.html"></HEAD
+><BODY
+CLASS="SECT1"
+BGCOLOR="#FFFFFF"
+TEXT="#000000"
+LINK="#0000FF"
+VLINK="#840084"
+ALINK="#0000FF"
+><DIV
+CLASS="NAVHEADER"
+><TABLE
+SUMMARY="Header navigation table"
+WIDTH="100%"
+BORDER="0"
+CELLPADDING="0"
+CELLSPACING="0"
+><TR
+><TH
+COLSPAN="3"
+ALIGN="center"
+>eCos Reference Manual</TH
+></TR
+><TR
+><TD
+WIDTH="10%"
+ALIGN="left"
+VALIGN="bottom"
+><A
+HREF="net-common-tcpip-manpages-poll.html"
+ACCESSKEY="P"
+>Prev</A
+></TD
+><TD
+WIDTH="80%"
+ALIGN="center"
+VALIGN="bottom"
+>Chapter 38. TCP/IP Library Reference</TD
+><TD
+WIDTH="10%"
+ALIGN="right"
+VALIGN="bottom"
+><A
+HREF="net-common-tcpip-manpages-send.html"
+ACCESSKEY="N"
+>Next</A
+></TD
+></TR
+></TABLE
+><HR
+ALIGN="LEFT"
+WIDTH="100%"></DIV
+><DIV
+CLASS="SECT1"
+><H1
+CLASS="SECT1"
+><A
+NAME="NET-COMMON-TCPIP-MANPAGES-SELECT">select</H1
+><TABLE
+BORDER="5"
+BGCOLOR="#E0E0F0"
+WIDTH="70%"
+><TR
+><TD
+><PRE
+CLASS="SCREEN"
+>SELECT(2)                     System Calls Manual                    SELECT(2)
+
+NAME
+     select - synchronous I/O multiplexing
+
+SYNOPSIS
+     #include &lt;sys/types.h&#62;
+     #include &lt;sys/time.h&#62;
+     #include &lt;unistd.h&#62;
+
+     int
+     select(int nfds, fd_set *readfds, fd_set *writefds, fd_set *exceptfds,
+             struct timeval *timeout);
+
+     FD_SET(fd, &amp;fdset);
+
+     FD_CLR(fd, &amp;fdset);
+
+     FD_ISSET(fd, &amp;fdset);
+
+     FD_ZERO(&amp;fdset);
+
+DESCRIPTION
+     select() examines the I/O descriptor sets whose addresses are passed in
+     readfds, writefds, and exceptfds to see if some of their descriptors are
+     ready for reading, are ready for writing, or have an exceptional condi-
+     tion pending, respectively.  The first nfds descriptors are checked in
+     each set; i.e., the descriptors from 0 through nfds-1 in the descriptor
+     sets are examined.  On return, select() replaces the given descriptor
+     sets with subsets consisting of those descriptors that are ready for the
+     requested operation.  select() returns the total number of ready descrip-
+     tors in all the sets.
+
+     The descriptor sets are stored as bit fields in arrays of integers.  The
+     following macros are provided for manipulating such descriptor sets:
+     FD_ZERO(&amp;fdset) initializes a descriptor set fdset to the null set.
+     FD_SET(fd, &amp;fdset) includes a particular descriptor fd in fdset.
+     FD_CLR(fd, &amp;fdset) removes fd from fdset.  FD_ISSET(fd, &amp;fdset) is non-
+     zero if fd is a member of fdset, zero otherwise.  The behavior of these
+     macros is undefined if a descriptor value is less than zero or greater
+     than or equal to FD_SETSIZE, which is normally at least equal to the max-
+     imum number of descriptors supported by the system.
+
+     If timeout is a non-null pointer, it specifies a maximum interval to wait
+     for the selection to complete.  If timeout is a null pointer, the select
+     blocks indefinitely.  To effect a poll, the timeout argument should be
+     non-null, pointing to a zero-valued timeval structure.  timeout is not
+     changed by select(), and may be reused on subsequent calls; however, it
+     is good style to re-initialize it before each invocation of select().
+
+     Any of readfds, writefds, and exceptfds may be given as null pointers if
+     no descriptors are of interest.
+
+RETURN VALUES
+     select() returns the number of ready descriptors that are contained in
+     the descriptor sets, or -1 is an error occurred.  If the time limit
+     expires, select() returns 0.  If select() returns with an error, includ-
+     ing one due to an interrupted call, the descriptor sets will be unmodi-
+     fied.
+
+ERRORS
+     An error return from select() indicates:
+
+     [EFAULT]           One or more of readfds, writefds, or exceptfds points
+                        outside the process's allocated address space.
+
+     [EBADF]            One of the descriptor sets specified an invalid
+                        descriptor.
+
+     [EINTR]            A signal was delivered before the time limit expired
+                        and before any of the selected events occurred.
+
+     [EINVAL]           The specified time limit is invalid.  One of its com-
+                        ponents is negative or too large.
+
+SEE ALSO
+     accept(2), connect(2), gettimeofday(2), poll(2), read(2), recv(2),
+     send(2), write(2), getdtablesize(3)
+
+BUGS
+     Although the provision of getdtablesize(3) was intended to allow user
+     programs to be written independent of the kernel limit on the number of
+     open files, the dimension of a sufficiently large bit field for select
+     remains a problem.  The default bit size of fd_set is based on the symbol
+     FD_SETSIZE (currently 256), but that is somewhat smaller than the current
+     kernel limit to the number of open files.  However, in order to accommo-
+     date programs which might potentially use a larger number of open files
+     with select, it is possible to increase this size within a program by
+     providing a larger definition of FD_SETSIZE before the inclusion of
+     &lt;sys/types.h&#62;.  The kernel will cope, and the userland libraries provided
+     with the system are also ready for large numbers of file descriptors.
+
+     Alternatively, to be really safe, it is possible to allocate fd_set bit-
+     arrays dynamically.  The idea is to permit a program to work properly
+     even if it is execve(2)'d with 4000 file descriptors pre-allocated.  The
+     following illustrates the technique which is used by userland libraries:
+
+                   fd_set *fdsr;
+                   int max = fd;
+
+                   fdsr = (fd_set *)calloc(howmany(max+1, NFDBITS),
+                       sizeof(fd_mask));
+                   if (fdsr == NULL) {
+                           ...
+                           return (-1);
+                   }
+                   FD_SET(fd, fdsr);
+                   n = select(max+1, fdsr, NULL, NULL, &amp;tv);
+                   ...
+                   free(fdsr);
+
+     Alternatively, it is possible to use the poll(2) interface.  poll(2) is
+     more efficient when the size of select()'s fd_set bit-arrays are very
+     large, and for fixed numbers of file descriptors one need not size and
+     dynamically allocate a memory object.
+
+     select() should probably have been designed to return the time remaining
+     from the original timeout, if any, by modifying the time value in place.
+     Even though some systems stupidly act in this different way, it is
+     unlikely this semantic will ever be commonly implemented, as the change
+     causes massive source code compatibility problems.  Furthermore, recent
+     new standards have dictated the current behaviour.  In general, due to
+     the existence of those brain-damaged non-conforming systems, it is unwise
+     to assume that the timeout value will be unmodified by the select() call,
+     and the caller should reinitialize it on each invocation.  Calculating
+     the delta is easily done by calling gettimeofday(2) before and after the
+     call to select(), and using timersub() (as described in getitimer(2)).
+
+     Internally to the kernel, select() works poorly if multiple processes
+     wait on the same file descriptor.  Given that, it is rather surprising to
+     see that many daemons are written that way (i.e., httpd(8)).
+
+HISTORY
+     The select() function call appeared in 4.2BSD.
+
+BSD                             March 25, 1994                             BSD
+    </PRE
+></TD
+></TR
+></TABLE
+></DIV
+><DIV
+CLASS="NAVFOOTER"
+><HR
+ALIGN="LEFT"
+WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
+WIDTH="100%"
+BORDER="0"
+CELLPADDING="0"
+CELLSPACING="0"
+><TR
+><TD
+WIDTH="33%"
+ALIGN="left"
+VALIGN="top"
+><A
+HREF="net-common-tcpip-manpages-poll.html"
+ACCESSKEY="P"
+>Prev</A
+></TD
+><TD
+WIDTH="34%"
+ALIGN="center"
+VALIGN="top"
+><A
+HREF="ecos-ref.html"
+ACCESSKEY="H"
+>Home</A
+></TD
+><TD
+WIDTH="33%"
+ALIGN="right"
+VALIGN="top"
+><A
+HREF="net-common-tcpip-manpages-send.html"
+ACCESSKEY="N"
+>Next</A
+></TD
+></TR
+><TR
+><TD
+WIDTH="33%"
+ALIGN="left"
+VALIGN="top"
+>poll</TD
+><TD
+WIDTH="34%"
+ALIGN="center"
+VALIGN="top"
+><A
+HREF="tcpip-library-reference.html"
+ACCESSKEY="U"
+>Up</A
+></TD
+><TD
+WIDTH="33%"
+ALIGN="right"
+VALIGN="top"
+>send</TD
+></TR
+></TABLE
+></DIV
+></BODY
+></HTML
+>
\ No newline at end of file