summaryrefslogtreecommitdiffstats
path: root/posix_users/timer.rst
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2016-02-26 18:22:07 +1100
committerAmar Takhar <verm@darkbeer.org>2016-05-02 20:51:26 -0400
commitfa70fd20878e402610c263f129266593d31a0376 (patch)
treec609d33c7047b975cfe8e0ac0df020fb26dae255 /posix_users/timer.rst
parentUpdate the shell user's guide top level. (diff)
downloadrtems-docs-fa70fd20878e402610c263f129266593d31a0376.tar.bz2
POSIX User clean up.
Diffstat (limited to '')
-rw-r--r--posix_users/timer.rst70
1 files changed, 38 insertions, 32 deletions
diff --git a/posix_users/timer.rst b/posix_users/timer.rst
index 36801d8..f08bc04 100644
--- a/posix_users/timer.rst
+++ b/posix_users/timer.rst
@@ -1,3 +1,7 @@
+.. COMMENT: COPYRIGHT(c) 1988-2002.
+.. COMMENT: On-Line Applications Research Corporation(OAR).
+.. COMMENT: All rights reserved.
+
Timer Manager
#############
@@ -8,15 +12,15 @@ The timer manager is ...
The services provided by the timer manager are:
-- ``timer_create`` - Create a Per-Process Timer
+- timer_create_ - Create a Per-Process Timer
-- ``timer_delete`` - Delete a Per-Process Timer
+- timer_delete_ - Delete a Per-Process Timer
-- ``timer_settime`` - Set Next Timer Expiration
+- timer_settime_ - Set Next Timer Expiration
-- ``timer_gettime`` - Get Time Remaining on Timer
+- timer_gettime_ - Get Time Remaining on Timer
-- ``timer_getoverrun`` - Get Timer Overrun Count
+- timer_getoverrun_ - Get Timer Overrun Count
Background
==========
@@ -27,26 +31,27 @@ Operations
System Calls
============
-This section details the timer manager's services.
-A subsection is dedicated to each of this manager's services
-and describes the calling sequence, related constants, usage,
-and status codes.
+This section details the timer manager's services. A subsection is dedicated
+to each of this manager's services and describes the calling sequence, related
+constants, usage, and status codes.
.. COMMENT: timer_create
+.. _timer_create:
+
timer_create - Create a Per-Process Timer
-----------------------------------------
**CALLING SEQUENCE:**
-.. code:: c
+.. code-block:: c
#include <time.h>
#include <signal.h>
int timer_create(
- clockid_t clock_id,
- struct sigevent \*evp,
- timer_t \*timerid
+ clockid_t clock_id,
+ struct sigevent *evp,
+ timer_t *timerid
);
**STATUS CODES:**
@@ -59,16 +64,18 @@ timer_create - Create a Per-Process Timer
.. COMMENT: timer_delete
+.. _timer_delete:
+
timer_delete - Delete a Per-Process Timer
-----------------------------------------
**CALLING SEQUENCE:**
-.. code:: c
+.. code-block:: c
#include <time.h>
int timer_delete(
- timer_t timerid
+ timer_t timerid
);
**STATUS CODES:**
@@ -81,19 +88,21 @@ timer_delete - Delete a Per-Process Timer
.. COMMENT: timer_settime
+.. _timer_settime:
+
timer_settime - Set Next Timer Expiration
-----------------------------------------
**CALLING SEQUENCE:**
-.. code:: c
+.. code-block:: c
#include <time.h>
int timer_settime(
- timer_t timerid,
- int flags,
- const struct itimerspec \*value,
- struct itimerspec \*ovalue
+ timer_t timerid,
+ int flags,
+ const struct itimerspec *value,
+ struct itimerspec *ovalue
);
**STATUS CODES:**
@@ -106,17 +115,19 @@ timer_settime - Set Next Timer Expiration
.. COMMENT: timer_gettime
+.. _timer_gettime:
+
timer_gettime - Get Time Remaining on Timer
-------------------------------------------
**CALLING SEQUENCE:**
-.. code:: c
+.. code-block:: c
#include <time.h>
int timer_gettime(
- timer_t timerid,
- struct itimerspec \*value
+ timer_t timerid,
+ struct itimerspec *value
);
**STATUS CODES:**
@@ -129,16 +140,18 @@ timer_gettime - Get Time Remaining on Timer
.. COMMENT: timer_getoverrun
+.. _timer_getoverrun:
+
timer_getoverrun - Get Timer Overrun Count
------------------------------------------
**CALLING SEQUENCE:**
-.. code:: c
+.. code-block:: c
#include <time.h>
int timer_getoverrun(
- timer_t timerid
+ timer_t timerid
);
**STATUS CODES:**
@@ -148,10 +161,3 @@ timer_getoverrun - Get Timer Overrun Count
**DESCRIPTION:**
**NOTES:**
-
-.. COMMENT: COPYRIGHT(c) 1988-2002.
-
-.. COMMENT: On-Line Applications Research Corporation(OAR).
-
-.. COMMENT: All rights reserved.
-