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