source: rtems-docs/posix_users/timer.rst @ d389819

4.115
Last change on this file since d389819 was d389819, checked in by Amar Takhar <amar@…>, on 01/18/16 at 05:37:40

Convert all Unicode to ASCII(128)
  • Property mode set to 100644
File size: 2.4 KB
Line 
1Timer Manager
2#############
3
4Introduction
5============
6
7The timer manager is ...
8
9The services provided by the timer manager are:
10
11- ``timer_create`` - Create a Per-Process Timer
12
13- ``timer_delete`` - Delete a Per-Process Timer
14
15- ``timer_settime`` - Set Next Timer Expiration
16
17- ``timer_gettime`` - Get Time Remaining on Timer
18
19- ``timer_getoverrun`` - Get Timer Overrun Count
20
21Background
22==========
23
24Operations
25==========
26
27System Calls
28============
29
30This section details the timer manager's services.
31A subsection is dedicated to each of this manager's services
32and describes the calling sequence, related constants, usage,
33and status codes.
34
35.. COMMENT: timer_create
36
37timer_create - Create a Per-Process Timer
38-----------------------------------------
39
40**CALLING SEQUENCE:**
41
42.. code:: c
43
44    #include <time.h>
45    #include <signal.h>
46    int timer_create(
47    clockid_t        clock_id,
48    struct sigevent \*evp,
49    timer_t         \*timerid
50    );
51
52**STATUS CODES:**
53
54``EXXX`` -
55
56**DESCRIPTION:**
57
58**NOTES:**
59
60.. COMMENT: timer_delete
61
62timer_delete - Delete a Per-Process Timer
63-----------------------------------------
64
65**CALLING SEQUENCE:**
66
67.. code:: c
68
69    #include <time.h>
70    int timer_delete(
71    timer_t timerid
72    );
73
74**STATUS CODES:**
75
76``EXXX`` -
77
78**DESCRIPTION:**
79
80**NOTES:**
81
82.. COMMENT: timer_settime
83
84timer_settime - Set Next Timer Expiration
85-----------------------------------------
86
87**CALLING SEQUENCE:**
88
89.. code:: c
90
91    #include <time.h>
92    int timer_settime(
93    timer_t                  timerid,
94    int                      flags,
95    const struct itimerspec \*value,
96    struct itimerspec       \*ovalue
97    );
98
99**STATUS CODES:**
100
101``EXXX`` -
102
103**DESCRIPTION:**
104
105**NOTES:**
106
107.. COMMENT: timer_gettime
108
109timer_gettime - Get Time Remaining on Timer
110-------------------------------------------
111
112**CALLING SEQUENCE:**
113
114.. code:: c
115
116    #include <time.h>
117    int timer_gettime(
118    timer_t            timerid,
119    struct itimerspec \*value
120    );
121
122**STATUS CODES:**
123
124``EXXX`` -
125
126**DESCRIPTION:**
127
128**NOTES:**
129
130.. COMMENT: timer_getoverrun
131
132timer_getoverrun - Get Timer Overrun Count
133------------------------------------------
134
135**CALLING SEQUENCE:**
136
137.. code:: c
138
139    #include <time.h>
140    int timer_getoverrun(
141    timer_t   timerid
142    );
143
144**STATUS CODES:**
145
146``EXXX`` -
147
148**DESCRIPTION:**
149
150**NOTES:**
151
152.. COMMENT: COPYRIGHT(c) 1988-2002.
153
154.. COMMENT: On-Line Applications Research Corporation(OAR).
155
156.. COMMENT: All rights reserved.
157
Note: See TracBrowser for help on using the repository browser.