summaryrefslogtreecommitdiffstats
path: root/spec/rtems/message/if/buffer.yml
blob: 72f83703059e42f8f9f29bcf2c3eee8989965657 (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
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Defines a structure which can be used as a message queue buffer for messages
  of the specified maximum size.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
definition:
  default:
    attributes: null
    body: |
      struct {
        ${/score/msgq/if/buffer:/name} _buffer;
        char _message[ ${.:/params[0]/name} ];
      }
    params:
    - ${/c/if/size_t:/name} ${.:/params[0]/name}
    return: null
  variants: []
description: null
enabled-by: true
index-entries: []
interface-type: macro
links:
- role: interface-placement
  uid: header
- role: interface-ingroup
  uid: group
name: RTEMS_MESSAGE_QUEUE_BUFFER
notes: |
  Use this macro to define the message buffer storage area for
  ${construct:/name}.
params:
- description: |
    is the maximum message size in bytes.
  dir: null
  name: _maximum_message_size
return: null
type: interface