summaryrefslogtreecommitdiffstats
path: root/doc/posix_users/timer.t
blob: 6ee3e5c8089b7f70cae3bb9c9943a9ec81c64ff2 (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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
@c
@c  This is the chapter from the RTEMS POSIX 1003.1b API User's Guide that
@c  documents the services provided by the timer @c  manager.

@chapter Timer Manager

@section Introduction

The timer manager is ...

The services provided by the timer manager are:

@itemize @bullet
@item @code{timer_create} - Create a Per-Process Timer
@item @code{timer_delete} - Delete a Per-Process Timer
@item @code{timer_settime} - Set Next Timer Expiration
@item @code{timer_gettime} - Get Time Remaining on Timer
@item @code{timer_getoverrun} - Get Timer Overrun Count
@end itemize

@section Background

@section Operations

@section 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.


@c
@c  timer_create
@c

@page
@subsection timer_create - Create a Per-Process Timer

@subheading CALLING SEQUENCE:

@ifset is-C
@example
#include <time.h>
#include <signal.h>

int timer_create(
  clockid_t        clock_id,
  struct sigevent *evp,
  timer_t         *timerid
);
@end example
@end ifset

@ifset is-Ada
@end ifset

@subheading STATUS CODES:

@code{EXXX} - 

@subheading DESCRIPTION:

@subheading NOTES:


@c
@c  timer_delete
@c

@page
@subsection timer_delete - Delete a Per-Process Timer

@subheading CALLING SEQUENCE:

@ifset is-C
@example
#include <time.h>

int timer_delete(
  timer_t timerid
);
@end example
@end ifset

@ifset is-Ada
@end ifset

@subheading STATUS CODES:

@code{EXXX} - 

@subheading DESCRIPTION:

@subheading NOTES:


@c
@c  timer_settime
@c

@page
@subsection timer_settime - Set Next Timer Expiration

@subheading CALLING SEQUENCE:

@ifset is-C
@example
#include <time.h>

int timer_settime(
  timer_t                  timerid,
  int                      flags,
  const struct itimerspec *value,
  struct itimerspec       *ovalue
);
@end example
@end ifset

@ifset is-Ada
@end ifset

@subheading STATUS CODES:

@code{EXXX} - 

@subheading DESCRIPTION:

@subheading NOTES:


@c
@c  timer_gettime
@c

@page
@subsection timer_gettime - Get Time Remaining on Timer

@subheading CALLING SEQUENCE:

@ifset is-C
@example
#include <time.h>

int timer_gettime(
  timer_t            timerid,
  struct itimerspec *value
);
@end example
@end ifset

@ifset is-Ada
@end ifset

@subheading STATUS CODES:

@code{EXXX} - 

@subheading DESCRIPTION:

@subheading NOTES:


@c
@c  timer_getoverrun
@c

@page
@subsection timer_getoverrun - Get Timer Overrun Count

@subheading CALLING SEQUENCE:

@ifset is-C
@example
#include <time.h>

int timer_getoverrun(
  timer_t   timerid
);
@end example
@end ifset

@ifset is-Ada
@end ifset

@subheading STATUS CODES:

@code{EXXX} - 

@subheading DESCRIPTION:

@subheading NOTES: