source: rtems-central/spec/if/rtems/event/system-receive.yml @ 51eded1

SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Receives or gets a system event set.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
definition:
  default:
    body: null
    params:
    - ${set:/name} ${.:/params[0]/name}
    - ${../options/option:/name} ${.:/params[1]/name}
    - ${../types/interval:/name} ${.:/params[2]/name}
    - ${set:/name} *${.:/params[3]/name}
    return: ${../status/code:/name}
  variants: []
description: |
  This directive performs the same actions as the ${receive:/name} directive
  except that it operates with a different set of events for each task.
enabled-by: true
interface-type: function
links:
- role: interface-placement
  uid: header
name: rtems_event_system_receive
notes: null
params:
- description: |
    is the event set of interest.  Use ${pending-events:/name} to get the
    pending events.
  dir: null
  name: event_in
- description: is the option set.
  dir: null
  name: option_set
- description: |
    is the timeout in clock ticks if the ${../options/wait:/name} option was
    set.  Use ${../types/no-timeout:/name} to wait potentially forever.
  dir: null
  name: ticks
- description: |
    is the pointer to an event set.  The received or pending events are stored
    in the referenced event set if the operation was successful.
  dir: null
  name: event_out
return:
  return: null
  return-values: []
type: interface