2009-02-10 00:35:46 +00:00
|
|
|
.\" Copyright (c) 2009 Linux Foundation, written by Michael Kerrisk
|
|
|
|
.\" <mtk.manpages@gmail.com>
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to make and distribute verbatim copies of this
|
|
|
|
.\" manual provided the copyright notice and this permission notice are
|
|
|
|
.\" preserved on all copies.
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to copy and distribute modified versions of this
|
|
|
|
.\" manual under the conditions for verbatim copying, provided that the
|
|
|
|
.\" entire resulting derived work is distributed under the terms of a
|
|
|
|
.\" permission notice identical to this one.
|
|
|
|
.\"
|
|
|
|
.\" Since the Linux kernel and libraries are constantly changing, this
|
|
|
|
.\" manual page may be incorrect or out-of-date. The author(s) assume no
|
|
|
|
.\" responsibility for errors or omissions, or for damages resulting from
|
|
|
|
.\" the use of the information contained herein. The author(s) may not
|
|
|
|
.\" have taken the same level of care in the production of this manual,
|
|
|
|
.\" which is licensed free of charge, as they might when working
|
|
|
|
.\" professionally.
|
|
|
|
.\"
|
|
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
2009-02-19 23:21:49 +00:00
|
|
|
.TH TIMER_SETTIME 2 2009-02-20 Linux "Linux Programmer's Manual"
|
2009-02-10 00:35:46 +00:00
|
|
|
.SH NAME
|
|
|
|
timer_settime, timer_gettime \- arm/disarm and fetch
|
|
|
|
state of POSIX per-process timer
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
|
|
|
.B #include <time.h>
|
|
|
|
|
|
|
|
.BI "int timer_settime(timer_t " timerid ", int " flags ,
|
|
|
|
.BI " const struct itimerspec *" new_value ,
|
|
|
|
.BI " struct itimerspec * " old_value );
|
|
|
|
.BI "int timer_gettime(timer_t " timerid ", struct itimerspec *" curr_value );
|
|
|
|
.fi
|
|
|
|
|
2009-02-23 18:46:09 +00:00
|
|
|
Link with \fI\-lrt\fP.
|
2009-02-10 00:35:46 +00:00
|
|
|
.sp
|
|
|
|
.in -4n
|
|
|
|
Feature Test Macro Requirements for glibc (see
|
|
|
|
.BR feature_test_macros (7)):
|
|
|
|
.in
|
|
|
|
.sp
|
|
|
|
.BR timer_settime (),
|
|
|
|
.BR timer_gettime ():
|
brk.2, chroot.2, faccessat.2, fchmodat.2, fchownat.2, fstatat.2, futimesat.2, getdtablesize.2, getpagesize.2, getsid.2, linkat.2, mkdirat.2, mknodat.2, openat.2, pread.2, readlinkat.2, renameat.2, setpgid.2, sigaltstack.2, symlinkat.2, sync.2, timer_create.2, timer_delete.2, timer_getoverrun.2, timer_settime.2, unlinkat.2, utimensat.2, vfork.2, acosh.3, asinh.3, atanh.3, dirfd.3, dprintf.3, ecvt.3, expm1.3, fexecve.3, fmemopen.3, gcvt.3, getcwd.3, gethostid.3, getpass.3, getsubopt.3, getw.3, mbsnrtowcs.3, mkfifoat.3, mkstemp.3, mktemp.3, opendir.3, posix_memalign.3, rint.3, siginterrupt.3, stpcpy.3, stpncpy.3, strdup.3, strerror.3, strnlen.3, strsignal.3, strtol.3, strtoul.3, ualarm.3, usleep.3, wcpcpy.3, wcpncpy.3, wcscasecmp.3, wcsdup.3, wcsncasecmp.3, wcsnlen.3, wcsnrtombs.3: ffix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-09-19 06:02:38 +00:00
|
|
|
_POSIX_C_SOURCE\ >=\ 199309L
|
2009-02-10 00:35:46 +00:00
|
|
|
.SH DESCRIPTION
|
|
|
|
.BR timer_settime ()
|
|
|
|
arms or disarms the timer identified by
|
|
|
|
.IR timerid .
|
|
|
|
The
|
|
|
|
.I new_value
|
|
|
|
argument is an
|
|
|
|
.I itimerspec
|
|
|
|
structure that specifies the new initial value and
|
|
|
|
the new interval for the timer.
|
|
|
|
The
|
|
|
|
.I itimerspec
|
|
|
|
structure is defined as follows:
|
|
|
|
|
|
|
|
.in +4n
|
|
|
|
.nf
|
|
|
|
struct timespec {
|
|
|
|
time_t tv_sec; /* Seconds */
|
|
|
|
long tv_nsec; /* Nanoseconds */
|
|
|
|
};
|
|
|
|
|
|
|
|
struct itimerspec {
|
|
|
|
struct timespec it_interval; /* Timer interval */
|
|
|
|
struct timespec it_value; /* Initial expiration */
|
|
|
|
};
|
|
|
|
.fi
|
|
|
|
.in
|
|
|
|
|
|
|
|
Each of the substructures of the
|
|
|
|
.I itimerspec
|
|
|
|
structure is a
|
|
|
|
.I timespec
|
|
|
|
structure that allows a time value to be specified
|
|
|
|
in seconds and nanoseconds.
|
|
|
|
These time values are measured according to the clock
|
|
|
|
that was specified when the timer was created by
|
Changes, clone.2, mount.2, nanosleep.2, sigaltstack.2, statfs.2, timer_settime.2, ctime.3, fmemopen.3, nl_langinfo.3, posix_memalign.3, pthread_attr_init.3, pthread_setaffinity_np.3, pthread_setschedprio.3, pthread_testcancel.3, setjmp.3, sigwait.3, tty_ioctl.4, epoll.7, posixoptions.7, unix.7: Add section number to references to functions documented in other pages
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-11-01 07:07:28 +00:00
|
|
|
.BR timer_create (2)
|
2009-02-10 00:35:46 +00:00
|
|
|
|
|
|
|
If
|
|
|
|
.I new_value->it_value
|
2010-01-16 16:57:16 +00:00
|
|
|
specifies a nonzero value (i.e., either subfield is nonzero), then
|
2009-02-10 00:35:46 +00:00
|
|
|
.BR timer_settime ()
|
|
|
|
arms (starts) the timer,
|
|
|
|
setting it to initially expire at the given time.
|
|
|
|
(If the timer was already armed,
|
|
|
|
then the previous settings are overwritten.)
|
|
|
|
If
|
|
|
|
.I new_value->it_value
|
|
|
|
specifies a zero value
|
|
|
|
(i.e., both subfields are zero),
|
|
|
|
then the timer is disarmed.
|
|
|
|
|
|
|
|
The
|
|
|
|
.I new_value->it_interval
|
|
|
|
field specifies the period of the timer, in seconds and nanoseconds.
|
intro.1, time.1, adjtimex.2, capget.2, eventfd.2, fcntl.2, getrlimit.2, getsockopt.2, gettimeofday.2, intro.2, ioctl_list.2, ioperm.2, mlock.2, pivot_root.2, poll.2, prctl.2, ptrace.2, sched_setscheduler.2, select_tut.2, semget.2, sigaltstack.2, signalfd.2, sysctl.2, timer_settime.2, timerfd_create.2, wait.2, CPU_SET.3, argz_add.3, assert_perror.3, atexit.3, backtrace.3, bcmp.3, clearenv.3, ctime.3, dl_iterate_phdr.3, dlopen.3, ecvt.3, errno.3, error.3, ether_aton.3, exit.3, fenv.3, ferror.3, finite.3, flockfile.3, fnmatch.3, fpathconf.3, fpclassify.3, ftime.3, ftok.3, ftw.3, fwide.3, getaddrinfo.3, gethostbyname.3, getlogin.3, getnameinfo.3, getnetent.3, getopt.3, getprotoent.3, getrpcent.3, getservent.3, glob.3, hsearch.3, inet.3, isalpha.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, longjmp.3, lsearch.3, malloc.3, matherr.3, mblen.3, mbsinit.3, mbtowc.3, on_exit.3, printf.3, pthread_attr_init.3, pthread_attr_setaffinity_np.3, pthread_attr_setdetachstate.3, pthread_attr_setguardsize.3, pthread_attr_setinheritsched.3, pthread_attr_setschedparam.3, pthread_attr_setschedpolicy.3, pthread_attr_setscope.3, pthread_attr_setstack.3, pthread_attr_setstackaddr.3, pthread_attr_setstacksize.3, pthread_cancel.3, pthread_cleanup_push.3, pthread_equal.3, pthread_getattr_np.3, pthread_getcpuclockid.3, pthread_setaffinity_np.3, pthread_setcancelstate.3, pthread_setconcurrency.3, pthread_setschedparam.3, pthread_setschedprio.3, ptsname.3, putenv.3, putgrent.3, raise.3, rcmd.3, regex.3, rexec.3, rpc.3, rpmatch.3, rtnetlink.3, scandir.3, sem_init.3, setaliasent.3, setbuf.3, setenv.3, setjmp.3, signbit.3, stdio_ext.3, strtod.3, strtol.3, strtoul.3, system.3, termios.3, timeradd.3, tzset.3, ualarm.3, wctomb.3, xdr.3, st.4, tty_ioctl.4, core.5, elf.5, proc.5, bootparam.7, capabilities.7, icmp.7, ip.7, ipv6.7, math_error.7, mdoc.samples.7, mq_overview.7, pthreads.7, raw.7, regex.7, socket.7, tcp.7, tzselect.8: Global fix: s/non-zero/nonzero/
The tendency in English, as prescribed in style guides like
Chicago MoS, is towards removing hyphens after prefixes
like "non-" etc.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-01-16 16:40:55 +00:00
|
|
|
If this field is nonzero, then each time that an armed timer expires,
|
2009-02-10 00:35:46 +00:00
|
|
|
the timer is reloaded from the value specified in
|
|
|
|
.IR new_value->it_interval .
|
|
|
|
If
|
|
|
|
.I new_value->it_interval
|
|
|
|
specifies a zero value
|
|
|
|
then the timer expires just once, at the time specified by
|
|
|
|
.IR it_value .
|
|
|
|
|
|
|
|
By default, the initial expiration time specified in
|
|
|
|
.I new_value->it_value
|
|
|
|
is interpreted relative to the current time on the timer's
|
|
|
|
clock at the time of the call.
|
|
|
|
This can be modified by specifying
|
|
|
|
.B TIMER_ABSTIME
|
|
|
|
in
|
|
|
|
.IR flags ,
|
|
|
|
in which case
|
|
|
|
.I new_value->it_value
|
|
|
|
is interpreted as an absolute value as measured on the timer's clock;
|
|
|
|
that is, the timer will expire when the clock value reaches the
|
|
|
|
value specified by
|
|
|
|
.IR new_value->it_value .
|
|
|
|
If the specified absolute time has already passed,
|
|
|
|
then the timer expires immediately,
|
|
|
|
and the overrun count (see
|
|
|
|
.BR timer_getoverrun (2))
|
|
|
|
will be set correctly.
|
|
|
|
.\" By experiment: the overrun count is set correctly, for CLOCK_REALTIME.
|
|
|
|
|
|
|
|
If the value of the
|
|
|
|
.B CLOCK_REALTIME
|
|
|
|
clock is adjusted while an absolute timer based on that clock is armed,
|
|
|
|
then the expiration of the timer will be appropriately adjusted.
|
|
|
|
Adjustments to the
|
|
|
|
.B CLOCK_REALTIME
|
|
|
|
clock have no effect on relative timers based on that clock.
|
|
|
|
.\" Similar remarks might apply with respect to process and thread CPU time
|
|
|
|
.\" clocks, but these clocks are not currently (2.6.28) settable on Linux.
|
|
|
|
|
|
|
|
If
|
|
|
|
.I old_value
|
|
|
|
is not NULL, then it returns the previous interval of the timer (in
|
|
|
|
.IR old_value->it_interval )
|
|
|
|
and the amount of time until the timer
|
|
|
|
would previously have next expired (in
|
|
|
|
.IR old_value->it_value ).
|
|
|
|
|
|
|
|
.BR timer_gettime ()
|
2009-09-27 07:26:33 +00:00
|
|
|
returns the time until next expiration, and the interval,
|
2009-02-10 00:35:46 +00:00
|
|
|
for the timer specified by
|
|
|
|
.IR timerid ,
|
|
|
|
in the buffer pointed to by
|
|
|
|
.IR curr_value .
|
|
|
|
The time remaining until the next timer expiration is returned in
|
2009-09-27 07:26:33 +00:00
|
|
|
.IR curr_value->it_value ;
|
2009-02-10 00:35:46 +00:00
|
|
|
this is always a relative value, regardless of whether the
|
|
|
|
.BR TIMER_ABSTIME
|
|
|
|
flag was used when arming the timer.
|
|
|
|
If the value returned in
|
2009-09-27 07:26:33 +00:00
|
|
|
.IR curr_value->it_value
|
2009-02-10 00:35:46 +00:00
|
|
|
is zero, then the timer is currently disarmed.
|
|
|
|
The timer interval is returned in
|
2009-09-27 07:26:33 +00:00
|
|
|
.IR curr_value->it_interval .
|
2009-02-10 00:35:46 +00:00
|
|
|
If the value returned in
|
2009-09-27 07:26:33 +00:00
|
|
|
.IR curr_value->it_interval
|
2009-02-10 00:35:46 +00:00
|
|
|
is zero, then this is a "one-shot" timer.
|
|
|
|
.SH RETURN VALUE
|
|
|
|
On success,
|
|
|
|
.BR timer_settime ()
|
|
|
|
and
|
|
|
|
.BR timer_gettime ()
|
|
|
|
return 0.
|
|
|
|
On error, \-1 is returned, and
|
|
|
|
.I errno
|
|
|
|
is set to indicate the error.
|
|
|
|
.SH ERRORS
|
|
|
|
These functions may fail with the following errors:
|
|
|
|
.TP
|
|
|
|
.B EFAULT
|
|
|
|
.IR new_value ,
|
|
|
|
.IR old_value ,
|
|
|
|
or
|
|
|
|
.I curr_value
|
2009-09-27 07:26:33 +00:00
|
|
|
is not a valid pointer.
|
2009-02-10 00:35:46 +00:00
|
|
|
.TP
|
|
|
|
.B EINVAL
|
|
|
|
.I timerid
|
|
|
|
is invalid.
|
|
|
|
.\" FIXME . eventually: invalid value in flags
|
|
|
|
.PP
|
|
|
|
.BR timer_settime ()
|
|
|
|
may fail with the following errors:
|
|
|
|
.TP
|
|
|
|
.B EINVAL
|
|
|
|
.I new_value.it_value
|
|
|
|
is negative; or
|
|
|
|
.I new_value.it_value.tv_nsec
|
|
|
|
is negative or greater than 999,999,999.
|
|
|
|
.SH VERSIONS
|
|
|
|
These system calls are available since Linux 2.6.
|
|
|
|
.SH CONFORMING TO
|
2010-11-01 06:21:04 +00:00
|
|
|
POSIX.1-2001.
|
2009-02-11 10:27:36 +00:00
|
|
|
.SH EXAMPLE
|
|
|
|
See
|
|
|
|
.BR timer_create (2).
|
2009-02-10 00:35:46 +00:00
|
|
|
.SH SEE ALSO
|
|
|
|
.BR timer_create (2),
|
|
|
|
.BR timer_getoverrun (2),
|
|
|
|
.BR time (7)
|