os/ossrv/genericopenlibs/openenvcore/include/posix4/sched.dosc
changeset 0 bde4ae8d615e
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/ossrv/genericopenlibs/openenvcore/include/posix4/sched.dosc	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,54 @@
     1.4 +/** @file ../include/posix4/sched.h
     1.5 +@internalComponent
     1.6 +*/
     1.7 +
     1.8 +/** @def SCHED_RR
     1.9 +
    1.10 +Scheduling policy
    1.11 +
    1.12 +@publishedAll
    1.13 +@externallyDefinedApi
    1.14 +*/
    1.15 +
    1.16 +/** @struct sched_param
    1.17 +
    1.18 +Contains following members,
    1.19 +
    1.20 +@publishedAll
    1.21 +@externallyDefinedApi
    1.22 +*/
    1.23 +
    1.24 +/** @var sched_param::sched_priority
    1.25 +process execution scheduling priority
    1.26 +*/
    1.27 +
    1.28 +/** @fn  sched_yield( void )
    1.29 +@return The sched_yield() function returns 0 if it completes successfully, or it returns a value of -1 and sets errno to indicate the error.
    1.30 +
    1.31 +yield processor.
    1.32 +The sched_yield() function forces the running thread to relinquish the processor until it again becomes the head of its thread list. It takes no arguments.
    1.33 +
    1.34 +
    1.35 +@publishedAll
    1.36 +@externallyDefinedApi
    1.37 +*/
    1.38 +
    1.39 +/** @fn  sched_get_priority_max(int policy)
    1.40 +@param policy
    1.41 +@return If successful, the sched_get_priority_max() functions return the appropriate maximum values, respectively. If unsuccessful, they return a value of -1 and set errno to indicate the error.
    1.42 +
    1.43 +The value of policy is one of the scheduling policy values defined in <sched.h>.
    1.44 +
    1.45 +@publishedAll
    1.46 +@externallyDefinedApi
    1.47 +*/
    1.48 +
    1.49 +/** @fn  sched_get_priority_min(int policy)
    1.50 +@param policy
    1.51 +@return If successful, the sched_get_priority_min() functions return the appropriate minimum values, respectively. If unsuccessful, they return a value of -1 and set errno to indicate the error.
    1.52 +
    1.53 +The value of policy is one of the scheduling policy values defined in <sched.h>.
    1.54 +
    1.55 +@publishedAll
    1.56 +@externallyDefinedApi
    1.57 +*/