summaryrefslogtreecommitdiffstats
path: root/posix-users/timer.rst
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2016-11-03 16:58:08 +1100
committerChris Johns <chrisj@rtems.org>2016-11-03 16:58:08 +1100
commit72a62ad88f82fe1ffee50024db4dd0f3fa5806f7 (patch)
tree6b0e527e67141f8126ba56b8a3c1eb90aeed5849 /posix-users/timer.rst
parent6207c37d9c8a3d75e67c10671fe2c309c805bbed (diff)
downloadrtems-docs-72a62ad88f82fe1ffee50024db4dd0f3fa5806f7.tar.bz2
Rename all manuals with an _ to have a -. It helps released naming of files.
Diffstat (limited to 'posix-users/timer.rst')
-rw-r--r--posix-users/timer.rst165
1 files changed, 165 insertions, 0 deletions
diff --git a/posix-users/timer.rst b/posix-users/timer.rst
new file mode 100644
index 0000000..f5be6c8
--- /dev/null
+++ b/posix-users/timer.rst
@@ -0,0 +1,165 @@
+.. comment SPDX-License-Identifier: CC-BY-SA-4.0
+
+.. COMMENT: COPYRIGHT(c) 1988-2002.
+.. COMMENT: On-Line Applications Research Corporation(OAR).
+.. COMMENT: All rights reserved.
+
+Timer Manager
+#############
+
+Introduction
+============
+
+The timer manager is ...
+
+The services provided by the timer manager are:
+
+- timer_create_ - Create a Per-Process Timer
+
+- timer_delete_ - Delete a Per-Process Timer
+
+- timer_settime_ - Set Next Timer Expiration
+
+- timer_gettime_ - Get Time Remaining on Timer
+
+- timer_getoverrun_ - Get Timer Overrun Count
+
+Background
+==========
+
+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.
+
+.. COMMENT: timer_create
+
+.. _timer_create:
+
+timer_create - Create a Per-Process Timer
+-----------------------------------------
+
+**CALLING SEQUENCE:**
+
+.. code-block:: c
+
+ #include <time.h>
+ #include <signal.h>
+ int timer_create(
+ clockid_t clock_id,
+ struct sigevent *evp,
+ timer_t *timerid
+ );
+
+**STATUS CODES:**
+
+``EXXX`` -
+
+**DESCRIPTION:**
+
+**NOTES:**
+
+.. COMMENT: timer_delete
+
+.. _timer_delete:
+
+timer_delete - Delete a Per-Process Timer
+-----------------------------------------
+
+**CALLING SEQUENCE:**
+
+.. code-block:: c
+
+ #include <time.h>
+ int timer_delete(
+ timer_t timerid
+ );
+
+**STATUS CODES:**
+
+``EXXX`` -
+
+**DESCRIPTION:**
+
+**NOTES:**
+
+.. COMMENT: timer_settime
+
+.. _timer_settime:
+
+timer_settime - Set Next Timer Expiration
+-----------------------------------------
+
+**CALLING SEQUENCE:**
+
+.. code-block:: c
+
+ #include <time.h>
+ int timer_settime(
+ timer_t timerid,
+ int flags,
+ const struct itimerspec *value,
+ struct itimerspec *ovalue
+ );
+
+**STATUS CODES:**
+
+``EXXX`` -
+
+**DESCRIPTION:**
+
+**NOTES:**
+
+.. COMMENT: timer_gettime
+
+.. _timer_gettime:
+
+timer_gettime - Get Time Remaining on Timer
+-------------------------------------------
+
+**CALLING SEQUENCE:**
+
+.. code-block:: c
+
+ #include <time.h>
+ int timer_gettime(
+ timer_t timerid,
+ struct itimerspec *value
+ );
+
+**STATUS CODES:**
+
+``EXXX`` -
+
+**DESCRIPTION:**
+
+**NOTES:**
+
+.. COMMENT: timer_getoverrun
+
+.. _timer_getoverrun:
+
+timer_getoverrun - Get Timer Overrun Count
+------------------------------------------
+
+**CALLING SEQUENCE:**
+
+.. code-block:: c
+
+ #include <time.h>
+ int timer_getoverrun(
+ timer_t timerid
+ );
+
+**STATUS CODES:**
+
+``EXXX`` -
+
+**DESCRIPTION:**
+
+**NOTES:**