diff options
Diffstat (limited to 'c-user/timer/introduction.rst')
| -rw-r--r-- | c-user/timer/introduction.rst | 61 |
1 files changed, 49 insertions, 12 deletions
diff --git a/c-user/timer/introduction.rst b/c-user/timer/introduction.rst index 48a36ba..4f35972 100644 --- a/c-user/timer/introduction.rst +++ b/c-user/timer/introduction.rst @@ -1,29 +1,66 @@ .. SPDX-License-Identifier: CC-BY-SA-4.0 +.. Copyright (C) 2020, 2021 embedded brains GmbH & Co. KG .. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +.. This file is part of the RTEMS quality process and was automatically +.. generated. If you find something that needs to be fixed or +.. worded better please post a report or patch to an RTEMS mailing list +.. or raise a bug report: +.. +.. https://www.rtems.org/bugs.html +.. +.. For information on updating and regenerating please refer to the How-To +.. section in the Software Requirements Engineering chapter of the +.. RTEMS Software Engineering manual. The manual is provided as a part of +.. a release. For development sources please refer to the online +.. documentation at: +.. +.. https://docs.rtems.org + +.. Generated from spec:/rtems/timer/if/group + +.. _TimerManagerIntroduction: + Introduction ============ -The timer manager provides support for timer -facilities. The directives provided by the timer manager are: +.. The following list was generated from: +.. spec:/rtems/timer/if/create +.. spec:/rtems/timer/if/ident +.. spec:/rtems/timer/if/cancel +.. spec:/rtems/timer/if/delete +.. spec:/rtems/timer/if/fire-after +.. spec:/rtems/timer/if/fire-when +.. spec:/rtems/timer/if/initiate-server +.. spec:/rtems/timer/if/server-fire-after +.. spec:/rtems/timer/if/server-fire-when +.. spec:/rtems/timer/if/reset +.. spec:/rtems/timer/if/get-information + +The Timer Manager provides support for timer facilities. The directives +provided by the Timer Manager are: + +* :ref:`InterfaceRtemsTimerCreate` - Creates a timer. -- :ref:`rtems_timer_create` +* :ref:`InterfaceRtemsTimerIdent` - Identifies a timer by the object name. -- :ref:`rtems_timer_ident` +* :ref:`InterfaceRtemsTimerCancel` - Cancels the timer. -- :ref:`rtems_timer_cancel` +* :ref:`InterfaceRtemsTimerDelete` - Deletes the timer. -- :ref:`rtems_timer_delete` +* :ref:`InterfaceRtemsTimerFireAfter` - Fires the timer after the interval. -- :ref:`rtems_timer_fire_after` +* :ref:`InterfaceRtemsTimerFireWhen` - Fires the timer at the time of day. -- :ref:`rtems_timer_fire_when` +* :ref:`InterfaceRtemsTimerInitiateServer` - Initiates the Timer Server. -- :ref:`rtems_timer_initiate_server` +* :ref:`InterfaceRtemsTimerServerFireAfter` - Fires the timer after the + interval using the Timer Server. -- :ref:`rtems_timer_server_fire_after` +* :ref:`InterfaceRtemsTimerServerFireWhen` - Fires the timer at the time of day + using the Timer Server. -- :ref:`rtems_timer_server_fire_when` +* :ref:`InterfaceRtemsTimerReset` - Resets the timer. -- :ref:`rtems_timer_reset` +* :ref:`InterfaceRtemsTimerGetInformation` - Gets information about the timer. |