diff options
| author | Chris Johns <chrisj@rtems.org> | 2017-11-12 14:34:48 +1100 |
|---|---|---|
| committer | Chris Johns <chrisj@rtems.org> | 2017-11-12 14:34:48 +1100 |
| commit | 6c5640131fca82624f72b2bd33b5b5f46156626e (patch) | |
| tree | eca99c4c65ff8a3767a26a49f7aeca0af7eedfa0 /c-user/event_manager.rst | |
| parent | Add indexes to all documents. (diff) | |
| download | rtems-docs-6c5640131fca82624f72b2bd33b5b5f46156626e.tar.bz2 | |
c-user: Fix index locations.
Update #3229.
Diffstat (limited to '')
| -rw-r--r-- | c-user/event_manager.rst | 22 |
1 files changed, 12 insertions, 10 deletions
diff --git a/c-user/event_manager.rst b/c-user/event_manager.rst index 784fbd9..d3c1a95 100644 --- a/c-user/event_manager.rst +++ b/c-user/event_manager.rst @@ -4,11 +4,11 @@ .. COMMENT: On-Line Applications Research Corporation (OAR). .. COMMENT: All rights reserved. +.. index:: events + Event Manager ************* -.. index:: events - Introduction ============ @@ -21,12 +21,13 @@ and synchronization. The directives provided by the event manager are: Background ========== -Event Sets ----------- .. index:: event flag, definition .. index:: event set, definition .. index:: rtems_event_set +Event Sets +---------- + An event flag is used by a task (or ISR) to inform another task of the occurrence of a significant situation. Thirty-two event flags are associated with each task. A collection of one or more event flags is referred to as an @@ -59,11 +60,12 @@ condition is satisfied when at least a single requested event is posted. The ``RTEMS_EVENT_ALL`` algorithm states that an event condition is satisfied when every requested event is posted. -Building an Event Set or Condition ----------------------------------- .. index:: event condition, building .. index:: event set, building +Building an Event Set or Condition +---------------------------------- + An event set or condition is built by a bitwise OR of the desired events. The set of valid events is ``RTEMS_EVENT_0`` through ``RTEMS_EVENT_31``. If an event is not explicitly specified in the set or condition, then it is not @@ -181,11 +183,11 @@ related constants, usage, and status codes. \clearpage .. _rtems_event_send: +.. index:: send event set to a task +.. index:: rtems_event_send EVENT_SEND - Send event set to a task ------------------------------------- -.. index:: send event set to a task -.. index:: rtems_event_send CALLING SEQUENCE: .. code-block:: c @@ -232,11 +234,11 @@ NOTES: \clearpage .. _rtems_event_receive: +.. index:: receive event condition +.. index:: rtems_event_receive EVENT_RECEIVE - Receive event condition --------------------------------------- -.. index:: receive event condition -.. index:: rtems_event_receive CALLING SEQUENCE: .. code-block:: c |