blob: d4b5af9f140dcaf085575df4b4cbb350da3d5f63 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
Gets the current priority of the task with respect to the scheduler.
copyrights:
- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2017 On-Line Applications Research Corporation (OAR)
definition:
default:
attributes: null
body: null
params:
- ${../../type/if/id:/name} ${.:/params[0]/name}
- ${../../type/if/id:/name} ${.:/params[1]/name}
- ${../../type/if/priority:/name} *${.:/params[2]/name}
return: ${../../status/if/code:/name}
variants: []
description: |
This directive returns the current priority in ${.:/params[2]/name} of the
task specified by ${.:/params[0]/name} with respect to the scheduler
specified by ${.:/params[1]/name}.
enabled-by: true
index-entries:
- current task priority
- get task priority
- obtain task priority
interface-type: function
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: group
- role: constraint
uid: /constraint/directive-ctx-isr
- role: constraint
uid: /constraint/directive-ctx-devinit
- role: constraint
uid: /constraint/directive-ctx-task
- role: constraint
uid: /constraint/directive-no-preempt
name: rtems_task_get_priority
notes: |
The current priority reflects temporary priority adjustments due to locking
protocols, the rate-monotonic period objects on some schedulers such as EDF,
and the POSIX sporadic server.
params:
- description: |
is the task identifier. The constant ${self-define:/name} may be used to
specify the calling task.
dir: null
name: task_id
- description: |
is the scheduler identifier.
dir: null
name: scheduler_id
- description: |
is the pointer to an ${../../type/if/priority:/name} object. When the
directive call is successful, the current priority of the task with respect
to the specified scheduler will be stored in this object.
dir: out
name: priority
return:
return: null
return-values:
- description: |
The requested operation was successful.
value: ${../../status/if/successful:/name}
- description: |
The ${.:/params[2]/name} parameter was ${/c/if/null:/name}.
value: ${../../status/if/invalid-address:/name}
- description: |
There was no task associated with the identifier specified by
${.:/params[0]/name}.
value: ${../../status/if/invalid-id:/name}
- description: |
There was no scheduler associated with the identifier specified by
${.:/params[1]/name}.
value: ${../../status/if/invalid-id:/name}
- description: |
The task had no priority with respect to the scheduler.
value: ${../../status/if/not-defined:/name}
- description: |
The task resided on a remote node.
value: ${../../status/if/illegal-on-remote-object:/name}
type: interface
|
