summaryrefslogtreecommitdiffstats
path: root/posix_users/timer.rst
blob: f5be6c8a8756ab3ae09a9ec4800a2ac38a05a2bc (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
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:**