os/ossrv/genericopenlibs/openenvcore/include/sys/select.dosc
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
     1 /** @file   ../include/sys/select.h
     2 @internalComponent
     3 */
     4 
     5 /** @fn select(int, fd_set *, fd_set *, fd_set *, struct timeval *)
     6 
     7 The select() function indicates which of the specified file descriptors is ready for reading, ready for writing, or has an error condition pending. 
     8 If the specified condition is false for all of the specified file descriptors, select() blocks, up to the specified timeout interval, until the specified condition is true for at least one of the specified file descriptors.
     9 
    10 @publishedAll
    11 @externallyDefinedApi
    12 */
    13 
    14 
    15 /** @struct fd_set
    16 
    17 select.h would define fd_set type as a structure.
    18 
    19 @publishedAll
    20 @externallyDefinedApi
    21 */
    22 
    23 
    24 
    25 /** @def FD_CLR(n, p)
    26 
    27 Clears the bit for the file descriptor fd in the file descriptor set fdset.
    28 
    29 @publishedAll
    30 @externallyDefinedApi
    31 */
    32 
    33 /** @def FD_ISSET(n, p)
    34 
    35 Returns a non-zero value if the bit for the file descriptor fd is set in the file descriptor set pointed to by fdset, and 0 otherwise.
    36 
    37 @publishedAll
    38 @externallyDefinedApi
    39 */
    40 
    41 /** @def FD_SET(n, p)
    42 
    43 Sets the bit for the file descriptor fd in the file descriptor set fdset.
    44 
    45 @publishedAll
    46 @externallyDefinedApi
    47 */
    48 
    49 
    50 /** @def FD_ZERO(p)
    51 
    52 Initialises the file descriptor set fdset to have zero bits for all file descriptors.
    53 
    54 @publishedAll
    55 @externallyDefinedApi
    56 */
    57 
    58 
    59 /** @def FD_SETSIZE
    60 
    61 The value of this macro is the maximum number of file descriptors that a fd_set object can hold information about. 
    62 
    63 @publishedAll
    64 @externallyDefinedApi
    65 */
    66 
    67