summaryrefslogtreecommitdiffstats
path: root/c-user/timer_manager.rst
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2017-11-12 14:34:48 +1100
committerChris Johns <chrisj@rtems.org>2017-11-12 14:34:48 +1100
commit6c5640131fca82624f72b2bd33b5b5f46156626e (patch)
treeeca99c4c65ff8a3767a26a49f7aeca0af7eedfa0 /c-user/timer_manager.rst
parent42d50d760e6c829d5673299bb8c631b9fa5c1342 (diff)
downloadrtems-docs-6c5640131fca82624f72b2bd33b5b5f46156626e.tar.bz2
c-user: Fix index locations.
Update #3229.
Diffstat (limited to 'c-user/timer_manager.rst')
-rw-r--r--c-user/timer_manager.rst48
1 files changed, 24 insertions, 24 deletions
diff --git a/c-user/timer_manager.rst b/c-user/timer_manager.rst
index 1e29add..ca80dfd 100644
--- a/c-user/timer_manager.rst
+++ b/c-user/timer_manager.rst
@@ -4,11 +4,11 @@
.. COMMENT: On-Line Applications Research Corporation (OAR).
.. COMMENT: All rights reserved.
+.. index:: timers
+
Timer Manager
*************
-.. index:: timers
-
Introduction
============
@@ -84,14 +84,14 @@ service routine finished its work.
The Timer Server is designed to remain blocked until a task-based timer fires.
This reduces the execution overhead of the Timer Server.
+.. index:: rtems_timer_service_routine
+
Timer Service Routines
----------------------
The timer service routine should adhere to C calling conventions and have a
prototype similar to the following:
-.. index:: rtems_timer_service_routine
-
.. code-block:: c
rtems_timer_service_routine user_routine(
@@ -195,11 +195,11 @@ related constants, usage, and status codes.
\clearpage
.. _rtems_timer_create:
+.. index:: create a timer
+.. index:: rtems_timer_create
TIMER_CREATE - Create a timer
-----------------------------
-.. index:: create a timer
-.. index:: rtems_timer_create
CALLING SEQUENCE:
.. code-block:: c
@@ -241,11 +241,11 @@ NOTES:
\clearpage
.. _rtems_timer_ident:
+.. index:: obtain the ID of a timer
+.. index:: rtems_timer_ident
TIMER_IDENT - Get ID of a timer
-------------------------------
-.. index:: obtain the ID of a timer
-.. index:: rtems_timer_ident
CALLING SEQUENCE:
.. code-block:: c
@@ -281,11 +281,11 @@ NOTES:
\clearpage
.. _rtems_timer_cancel:
+.. index:: cancel a timer
+.. index:: rtems_timer_cancel
TIMER_CANCEL - Cancel a timer
-----------------------------
-.. index:: cancel a timer
-.. index:: rtems_timer_cancel
CALLING SEQUENCE:
.. code-block:: c
@@ -316,11 +316,11 @@ NOTES:
\clearpage
.. _rtems_timer_delete:
+.. index:: delete a timer
+.. index:: rtems_timer_delete
TIMER_DELETE - Delete a timer
-----------------------------
-.. index:: delete a timer
-.. index:: rtems_timer_delete
CALLING SEQUENCE:
.. code-block:: c
@@ -355,11 +355,11 @@ NOTES:
\clearpage
.. _rtems_timer_fire_after:
+.. index:: fire a timer after an interval
+.. index:: rtems_timer_fire_after
TIMER_FIRE_AFTER - Fire timer after interval
--------------------------------------------
-.. index:: fire a timer after an interval
-.. index:: rtems_timer_fire_after
CALLING SEQUENCE:
.. code-block:: c
@@ -399,11 +399,11 @@ NOTES:
\clearpage
.. _rtems_timer_fire_when:
+.. index:: fire a timer at wall time
+.. index:: rtems_timer_fire_when
TIMER_FIRE_WHEN - Fire timer when specified
-------------------------------------------
-.. index:: fire a timer at wall time
-.. index:: rtems_timer_fire_when
CALLING SEQUENCE:
.. code-block:: c
@@ -447,11 +447,11 @@ NOTES:
\clearpage
.. _rtems_timer_initiate_server:
+.. index:: initiate the Timer Server
+.. index:: rtems_timer_initiate_server
TIMER_INITIATE_SERVER - Initiate server for task-based timers
-------------------------------------------------------------
-.. index:: initiate the Timer Server
-.. index:: rtems_timer_initiate_server
CALLING SEQUENCE:
.. code-block:: c
@@ -492,11 +492,11 @@ NOTES:
\clearpage
.. _rtems_timer_server_fire_after:
+.. index:: fire task-based a timer after an interval
+.. index:: rtems_timer_server_fire_after
TIMER_SERVER_FIRE_AFTER - Fire task-based timer after interval
--------------------------------------------------------------
-.. index:: fire task-based a timer after an interval
-.. index:: rtems_timer_server_fire_after
CALLING SEQUENCE:
.. code-block:: c
@@ -540,11 +540,11 @@ NOTES:
\clearpage
.. _rtems_timer_server_fire_when:
+.. index:: fire a task-based timer at wall time
+.. index:: rtems_timer_server_fire_when
TIMER_SERVER_FIRE_WHEN - Fire task-based timer when specified
-------------------------------------------------------------
-.. index:: fire a task-based timer at wall time
-.. index:: rtems_timer_server_fire_when
CALLING SEQUENCE:
.. code-block:: c
@@ -592,11 +592,11 @@ NOTES:
\clearpage
.. _rtems_timer_reset:
+.. index:: reset a timer
+.. index:: rtems_timer_reset
TIMER_RESET - Reset an interval timer
-------------------------------------
-.. index:: reset a timer
-.. index:: rtems_timer_reset
CALLING SEQUENCE:
.. code-block:: c