rtems-docs/c-user/timer/introduction.rst
Sebastian Huber d716c79070 c-user: Generate Timer Manager documentation
The documentation is a consolidation of the comments in Doxygen markup
and the documentation sources in Sphinx markup.  The documentation was
transfered to interface specification items.  The documentation source
files were generated from the items by a script.

Update #3993.
2020-12-09 09:17:37 +01:00

63 lines
2.0 KiB
ReStructuredText

.. SPDX-License-Identifier: CC-BY-SA-4.0
.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
.. 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://docs.rtems.org/branches/master/user/support/bugs.html
..
.. For information on updating and regenerating please refer to:
..
.. https://docs.rtems.org/branches/master/eng/req/howto.html
.. Generated from spec:/rtems/timer/if/group
.. _TimerManagerIntroduction:
Introduction
============
.. 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:`InterfaceRtemsTimerIdent` - Identifies a timer by the object name.
* :ref:`InterfaceRtemsTimerCancel` - Cancels the timer.
* :ref:`InterfaceRtemsTimerDelete` - Deletes the timer.
* :ref:`InterfaceRtemsTimerFireAfter` - Fires the timer after the interval.
* :ref:`InterfaceRtemsTimerFireWhen` - Fires the timer at the time of day.
* :ref:`InterfaceRtemsTimerInitiateServer` - Initiates the Timer Server.
* :ref:`InterfaceRtemsTimerServerFireAfter` - Fires the timer after the
interval using the Timer Server.
* :ref:`InterfaceRtemsTimerServerFireWhen` - Fires the timer at the time of day
using the Timer Server.
* :ref:`InterfaceRtemsTimerReset` - Resets the timer.
* :ref:`InterfaceRtemsTimerGetInformation` - Gets information about the timer.