os/ossrv/genericopenlibs/openenvcore/include/posix4/sched.dosc
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
     1 /** @file ../include/posix4/sched.h
     2 @internalComponent
     3 */
     4 
     5 /** @def SCHED_RR
     6 
     7 Scheduling policy
     8 
     9 @publishedAll
    10 @externallyDefinedApi
    11 */
    12 
    13 /** @struct sched_param
    14 
    15 Contains following members,
    16 
    17 @publishedAll
    18 @externallyDefinedApi
    19 */
    20 
    21 /** @var sched_param::sched_priority
    22 process execution scheduling priority
    23 */
    24 
    25 /** @fn  sched_yield( void )
    26 @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.
    27 
    28 yield processor.
    29 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.
    30 
    31 
    32 @publishedAll
    33 @externallyDefinedApi
    34 */
    35 
    36 /** @fn  sched_get_priority_max(int policy)
    37 @param policy
    38 @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.
    39 
    40 The value of policy is one of the scheduling policy values defined in <sched.h>.
    41 
    42 @publishedAll
    43 @externallyDefinedApi
    44 */
    45 
    46 /** @fn  sched_get_priority_min(int policy)
    47 @param policy
    48 @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.
    49 
    50 The value of policy is one of the scheduling policy values defined in <sched.h>.
    51 
    52 @publishedAll
    53 @externallyDefinedApi
    54 */