source: rtems/doc/posix_users/timer.t @ 5ab0ad6

4.104.114.84.95
Last change on this file since 5ab0ad6 was 5ab0ad6, checked in by Joel Sherrill <joel.sherrill@…>, on Nov 23, 1999 at 5:05:19 PM

New file.

  • Property mode set to 100644
File size: 2.7 KB
Line 
1@c
2@c  This is the chapter from the RTEMS POSIX 1003.1b API User's Guide that
3@c  documents the services provided by the timer @c  manager.
4@c
5@c  $Id$
6@c
7
8@chapter Timer Manager
9
10@section Introduction
11
12The timer manager is ...
13
14The services provided by the timer manager are:
15
16@itemize @bullet
17@item @code{timer_create} - Create a Per-Process Timer
18@item @code{timer_delete} - Delete a Per-Process Timer
19@item @code{timer_settime} - Set Next Timer Expiration
20@item @code{timer_gettime} - Get Time Remaining on Timer
21@item @code{timer_getoverrun} - Get Timer Overrun Count
22@end itemize
23
24@section Background
25
26@section Operations
27
28@section System Calls
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
36@c
37@c  timer_create
38@c
39
40@page
41@subsection timer_create - Create a Per-Process Timer
42
43@subheading CALLING SEQUENCE:
44
45@ifset is-C
46@example
47#include <time.h>
48#include <signal.h>
49
50int timer_create(
51  clockid_t        clock_id,
52  struct sigevent *evp,
53  timer_t         *timerid
54);
55@end example
56@end ifset
57
58@ifset is-Ada
59@end ifset
60
61@subheading STATUS CODES:
62
63@code{EXXX} -
64
65@subheading DESCRIPTION:
66
67@subheading NOTES:
68
69
70@c
71@c  timer_delete
72@c
73
74@page
75@subsection timer_delete - Delete a Per-Process Timer
76
77@subheading CALLING SEQUENCE:
78
79@ifset is-C
80@example
81#include <time.h>
82
83int timer_delete(
84  timer_t timerid
85);
86@end example
87@end ifset
88
89@ifset is-Ada
90@end ifset
91
92@subheading STATUS CODES:
93
94@code{EXXX} -
95
96@subheading DESCRIPTION:
97
98@subheading NOTES:
99
100
101@c
102@c  timer_settime
103@c
104
105@page
106@subsection timer_settime - Set Next Timer Expiration
107
108@subheading CALLING SEQUENCE:
109
110@ifset is-C
111@example
112#include <time.h>
113
114int timer_settime(
115  timer_t                  timerid,
116  int                      flags,
117  const struct itimerspec *value,
118  struct itimerspec       *ovalue
119);
120@end example
121@end ifset
122
123@ifset is-Ada
124@end ifset
125
126@subheading STATUS CODES:
127
128@code{EXXX} -
129
130@subheading DESCRIPTION:
131
132@subheading NOTES:
133
134
135@c
136@c  timer_gettime
137@c
138
139@page
140@subsection timer_gettime - Get Time Remaining on Timer
141
142@subheading CALLING SEQUENCE:
143
144@ifset is-C
145@example
146#include <time.h>
147
148int timer_gettime(
149  timer_t            timerid,
150  struct itimerspec *value
151);
152@end example
153@end ifset
154
155@ifset is-Ada
156@end ifset
157
158@subheading STATUS CODES:
159
160@code{EXXX} -
161
162@subheading DESCRIPTION:
163
164@subheading NOTES:
165
166
167@c
168@c  timer_getoverrun
169@c
170
171@page
172@subsection timer_getoverrun - Get Timer Overrun Count
173
174@subheading CALLING SEQUENCE:
175
176@ifset is-C
177@example
178#include <time.h>
179
180int timer_getoverrun(
181  timer_t   timerid
182);
183@end example
184@end ifset
185
186@ifset is-Ada
187@end ifset
188
189@subheading STATUS CODES:
190
191@code{EXXX} -
192
193@subheading DESCRIPTION:
194
195@subheading NOTES:
196
Note: See TracBrowser for help on using the repository browser.