diff options
author | Joel Sherrill <joel.sherrill@OARcorp.com> | 1999-11-23 17:05:19 +0000 |
---|---|---|
committer | Joel Sherrill <joel.sherrill@OARcorp.com> | 1999-11-23 17:05:19 +0000 |
commit | 5ab0ad6f2ca5161c02ea1ccbbea5620de6a14003 (patch) | |
tree | 4088d0a769e0ce272d92f216f08436ca0d6ed817 | |
parent | Readding files mistakenly removed. (diff) | |
download | rtems-5ab0ad6f2ca5161c02ea1ccbbea5620de6a14003.tar.bz2 |
New file.
-rw-r--r-- | doc/posix_users/timer.t | 196 |
1 files changed, 196 insertions, 0 deletions
diff --git a/doc/posix_users/timer.t b/doc/posix_users/timer.t new file mode 100644 index 0000000000..d879f24abb --- /dev/null +++ b/doc/posix_users/timer.t @@ -0,0 +1,196 @@ +@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. +@c +@c $Id$ +@c + +@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: + |