systemeventreceive.c File Reference

This source file contains the implementation of rtems_event_system_receive(). More...

#include <rtems/rtems/eventimpl.h>
#include <rtems/rtems/tasksdata.h>
#include <rtems/score/statesimpl.h>
#include <rtems/score/threadimpl.h>

Functions
rtems_status_code	rtems_event_system_receive (rtems_event_set event_in, rtems_option option_set, rtems_interval ticks, rtems_event_set *event_out)
	Receives or gets a system event set from the executing task.

Detailed Description

This source file contains the implementation of rtems_event_system_receive().

Function Documentation

rtems_event_system_receive()

rtems_status_code rtems_event_system_receive	(	rtems_event_set	event_in,
		rtems_option	option_set,
		rtems_interval	ticks,
		rtems_event_set *	event_out
	)

Receives or gets a system event set from the executing task.

Parameters

event_in	is the event set of interest. Use RTEMS_PENDING_EVENTS to get the pending events.
option_set	is the option set.
ticks	is the timeout in clock ticks if the RTEMS_WAIT option was set. Use RTEMS_NO_TIMEOUT to wait potentially forever.
event_out	is the pointer to an event set. The received or pending events are stored in the referenced event set if the operation was successful.

This directive performs the same actions as the rtems_event_receive() directive except that it operates with a different set of events for each task.

Constraints

The following constraints apply to this directive:

• The directive may be called from within device driver initialization context.
• The directive may be called from within task context.
• The timeout functionality of the directive requires a clock tick.