os/ossrv/genericopenlibs/openenvcore/include/sys/select.dosc
author sl@SLION-WIN7.fritz.box
Fri, 15 Jun 2012 03:10:57 +0200
changeset 0 bde4ae8d615e
permissions -rw-r--r--
First public contribution.
sl@0
     1
/** @file   ../include/sys/select.h
sl@0
     2
@internalComponent
sl@0
     3
*/
sl@0
     4
sl@0
     5
/** @fn select(int, fd_set *, fd_set *, fd_set *, struct timeval *)
sl@0
     6
sl@0
     7
The select() function indicates which of the specified file descriptors is ready for reading, ready for writing, or has an error condition pending. 
sl@0
     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.
sl@0
     9
sl@0
    10
@publishedAll
sl@0
    11
@externallyDefinedApi
sl@0
    12
*/
sl@0
    13
sl@0
    14
sl@0
    15
/** @struct fd_set
sl@0
    16
sl@0
    17
select.h would define fd_set type as a structure.
sl@0
    18
sl@0
    19
@publishedAll
sl@0
    20
@externallyDefinedApi
sl@0
    21
*/
sl@0
    22
sl@0
    23
sl@0
    24
sl@0
    25
/** @def FD_CLR(n, p)
sl@0
    26
sl@0
    27
Clears the bit for the file descriptor fd in the file descriptor set fdset.
sl@0
    28
sl@0
    29
@publishedAll
sl@0
    30
@externallyDefinedApi
sl@0
    31
*/
sl@0
    32
sl@0
    33
/** @def FD_ISSET(n, p)
sl@0
    34
sl@0
    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.
sl@0
    36
sl@0
    37
@publishedAll
sl@0
    38
@externallyDefinedApi
sl@0
    39
*/
sl@0
    40
sl@0
    41
/** @def FD_SET(n, p)
sl@0
    42
sl@0
    43
Sets the bit for the file descriptor fd in the file descriptor set fdset.
sl@0
    44
sl@0
    45
@publishedAll
sl@0
    46
@externallyDefinedApi
sl@0
    47
*/
sl@0
    48
sl@0
    49
sl@0
    50
/** @def FD_ZERO(p)
sl@0
    51
sl@0
    52
Initialises the file descriptor set fdset to have zero bits for all file descriptors.
sl@0
    53
sl@0
    54
@publishedAll
sl@0
    55
@externallyDefinedApi
sl@0
    56
*/
sl@0
    57
sl@0
    58
sl@0
    59
/** @def FD_SETSIZE
sl@0
    60
sl@0
    61
The value of this macro is the maximum number of file descriptors that a fd_set object can hold information about. 
sl@0
    62
sl@0
    63
@publishedAll
sl@0
    64
@externallyDefinedApi
sl@0
    65
*/
sl@0
    66
sl@0
    67