os/ossrv/genericopenlibs/openenvcore/include/sys/select.dosc
changeset 0 bde4ae8d615e
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/ossrv/genericopenlibs/openenvcore/include/sys/select.dosc	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,67 @@
     1.4 +/** @file   ../include/sys/select.h
     1.5 +@internalComponent
     1.6 +*/
     1.7 +
     1.8 +/** @fn select(int, fd_set *, fd_set *, fd_set *, struct timeval *)
     1.9 +
    1.10 +The select() function indicates which of the specified file descriptors is ready for reading, ready for writing, or has an error condition pending. 
    1.11 +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.
    1.12 +
    1.13 +@publishedAll
    1.14 +@externallyDefinedApi
    1.15 +*/
    1.16 +
    1.17 +
    1.18 +/** @struct fd_set
    1.19 +
    1.20 +select.h would define fd_set type as a structure.
    1.21 +
    1.22 +@publishedAll
    1.23 +@externallyDefinedApi
    1.24 +*/
    1.25 +
    1.26 +
    1.27 +
    1.28 +/** @def FD_CLR(n, p)
    1.29 +
    1.30 +Clears the bit for the file descriptor fd in the file descriptor set fdset.
    1.31 +
    1.32 +@publishedAll
    1.33 +@externallyDefinedApi
    1.34 +*/
    1.35 +
    1.36 +/** @def FD_ISSET(n, p)
    1.37 +
    1.38 +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.
    1.39 +
    1.40 +@publishedAll
    1.41 +@externallyDefinedApi
    1.42 +*/
    1.43 +
    1.44 +/** @def FD_SET(n, p)
    1.45 +
    1.46 +Sets the bit for the file descriptor fd in the file descriptor set fdset.
    1.47 +
    1.48 +@publishedAll
    1.49 +@externallyDefinedApi
    1.50 +*/
    1.51 +
    1.52 +
    1.53 +/** @def FD_ZERO(p)
    1.54 +
    1.55 +Initialises the file descriptor set fdset to have zero bits for all file descriptors.
    1.56 +
    1.57 +@publishedAll
    1.58 +@externallyDefinedApi
    1.59 +*/
    1.60 +
    1.61 +
    1.62 +/** @def FD_SETSIZE
    1.63 +
    1.64 +The value of this macro is the maximum number of file descriptors that a fd_set object can hold information about. 
    1.65 +
    1.66 +@publishedAll
    1.67 +@externallyDefinedApi
    1.68 +*/
    1.69 +
    1.70 +