blob: e3d4068a0ee75cc36b5ec6aeaf6d09edd3450666 (
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
|
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
Gets the number of messages pending on the queue.
copyrights:
- Copyright (C) 2021 embedded brains GmbH & Co. KG
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
definition:
default:
attributes: null
body: null
params:
- ${../../type/if/id:/name} ${.:/params[0]/name}
- ${/c/if/uint32_t:/name} *${.:/params[1]/name}
return: ${../../status/if/code:/name}
variants: []
description: |
This directive returns the number of messages pending on the queue specified
by ${.:/params[0]/name} in ${.:/params[1]/name}. If no messages are present
on the queue, count is set to zero.
enabled-by: true
index-entries:
- get number of pending messages
interface-type: function
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: group
- role: constraint
uid: /constraint/directive-ctx-task
- role: constraint
uid: /constraint/directive-ctx-isr
- role: constraint
uid: /constraint/directive-remote
name: rtems_message_queue_get_number_pending
notes: null
params:
- description: |
is the queue identifier.
dir: null
name: id
- description: |
is the pointer to an ${/c/if/uint32_t:/name} object. When the directive
call is successful, the number of pending messages will be stored in this
object.
dir: out
name: count
return:
return: null
return-values:
- description: |
The requested operation was successful.
value: ${../../status/if/successful:/name}
- description: |
There was no queue associated with the identifier specified by
${.:/params[0]/name}.
value: ${../../status/if/invalid-id:/name}
- description: |
The ${.:/params[1]/name} parameter was ${/c/if/null:/name}.
value: ${../../status/if/invalid-address:/name}
type: interface
|
