summaryrefslogtreecommitdiffstats
path: root/spec/rtems/message/req/buffer.yml
blob: a4e446ecf6b967855265f9c39a89f6335feb371d (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
SPDX-License-Identifier: CC-BY-SA-4.0
copyrights:
- Copyright (C) 2021 embedded brains GmbH & Co. KG
enabled-by: true
functional-type: function
links:
- role: interface-function
  uid: ../if/buffer
rationale: null
references: []
requirement-type: functional
text: |
  When argument ${../if/buffer:/params[0]/name} is the size of
  the largest possible message in bytes
  (the same value as member ${../if/config:/definition[2]/default/name} of type
  ${../if/config:/name}),
  and ``MAXIMUM_PENDING_MESSAGES`` is the maximum number of messages
  which can be stored in the message queue
  (the same value as member ${../if/config:/definition[1]/default/name} of type
  ${../if/config:/name}),
  and ``storage_area`` is a variable or structure member,
  the expression
  ${../if/buffer:/name}( ${../if/buffer:/params[0]/name} )
  storage_area[ MAXIMUM_PENDING_MESSAGES ]
  shall declare an object of such a size that a pointer to it
  is usable as value for member ${../if/config:/definition[3]/default/name}
  of type ${../if/config:/name}.
type: requirement