2007-09-20 06:52:22 +00:00
|
|
|
.\" Copyright (c) 2007 by Michael Kerrisk <mtk.manpages@gmail.com>
|
2007-07-08 14:18:12 +00:00
|
|
|
.\"
|
|
|
|
.\" 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
|
2008-03-18 14:47:54 +00:00
|
|
|
.\" 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.
|
2007-07-08 14:18:12 +00:00
|
|
|
.\"
|
|
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
|
|
|
.\"
|
|
|
|
.\" 2007-07-31, mtk, Created
|
|
|
|
.\"
|
2009-02-25 17:44:15 +00:00
|
|
|
.TH TIMERADD 3 2009-02-26 "Linux" "Linux Programmer's Manual"
|
2007-07-08 14:18:12 +00:00
|
|
|
.SH NAME
|
2007-07-08 14:21:45 +00:00
|
|
|
timeradd, timersub, timercmp, timerclear, timerisset \- timeval operations
|
2007-07-08 14:18:12 +00:00
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
|
|
|
.B #include <sys/time.h>
|
|
|
|
|
|
|
|
.BI "void timeradd(struct timeval *" a ", struct timeval *" b ,
|
|
|
|
.BI " struct timeval *" res );
|
|
|
|
|
|
|
|
.BI "void timersub(struct timeval *" a ", struct timeval *" b ,
|
|
|
|
.BI " struct timeval *" res );
|
|
|
|
|
|
|
|
.BI "void timerclear(struct timeval *" tvp );
|
|
|
|
|
2009-02-25 17:44:15 +00:00
|
|
|
.BI "int timerisset(struct timeval *" tvp );
|
2007-07-08 14:18:12 +00:00
|
|
|
|
2009-02-25 17:44:15 +00:00
|
|
|
.BI "int timercmp(struct timeval *" a ", struct timeval *" b ", " CMP );
|
2007-07-08 14:18:12 +00:00
|
|
|
.fi
|
|
|
|
.sp
|
|
|
|
.in -4n
|
|
|
|
Feature Test Macro Requirements for glibc (see
|
|
|
|
.BR feature_test_macros (7)):
|
|
|
|
.in
|
|
|
|
.sp
|
2007-12-23 09:00:11 +00:00
|
|
|
All functions shown above:
|
2007-07-08 14:18:12 +00:00
|
|
|
_BSD_SOURCE
|
|
|
|
.SH DESCRIPTION
|
|
|
|
The macros are provided to operate on
|
|
|
|
.I timeval
|
|
|
|
structures, defined in
|
2007-09-20 16:26:31 +00:00
|
|
|
.I <sys/time.h>
|
2007-07-08 14:18:12 +00:00
|
|
|
as:
|
|
|
|
.sp
|
2007-12-19 06:57:44 +00:00
|
|
|
.in +4n
|
2007-07-08 14:18:12 +00:00
|
|
|
.nf
|
|
|
|
struct timeval {
|
|
|
|
time_t tv_sec; /* seconds */
|
|
|
|
suseconds_t tv_usec; /* microseconds */
|
|
|
|
};
|
|
|
|
.fi
|
2007-12-19 06:57:44 +00:00
|
|
|
.in
|
2007-07-08 14:18:12 +00:00
|
|
|
.PP
|
|
|
|
.BR timeradd ()
|
|
|
|
adds the time values in
|
|
|
|
.I a
|
|
|
|
and
|
|
|
|
.IR b ,
|
|
|
|
and places the sum in the
|
|
|
|
.I timeval
|
|
|
|
pointed to by
|
|
|
|
.IR res .
|
|
|
|
The result is normalized such that
|
2007-12-22 16:40:46 +00:00
|
|
|
.I res\->tv_usec
|
2007-07-08 14:18:12 +00:00
|
|
|
has a value in the range 0 to 999,999.
|
|
|
|
|
|
|
|
.BR timersub ()
|
2007-07-08 14:21:45 +00:00
|
|
|
subtracts the time value in
|
2007-07-08 14:18:12 +00:00
|
|
|
.I b
|
2007-07-08 14:21:45 +00:00
|
|
|
from the time value in
|
2007-07-08 14:18:12 +00:00
|
|
|
.IR a ,
|
|
|
|
and places the result in the
|
|
|
|
.I timeval
|
|
|
|
pointed to by
|
|
|
|
.IR res .
|
|
|
|
The result is normalized such that
|
2007-12-22 16:40:46 +00:00
|
|
|
.I res\->tv_usec
|
2007-07-08 14:18:12 +00:00
|
|
|
has a value in the range 0 to 999,999.
|
|
|
|
|
|
|
|
.BR timerclear ()
|
2008-03-19 09:04:12 +00:00
|
|
|
zeros out the
|
2007-07-08 14:18:12 +00:00
|
|
|
.I timeval
|
|
|
|
structure pointed to by
|
|
|
|
.IR tvp ,
|
|
|
|
so that it represents the time at midnight
|
|
|
|
on the morning of 1 January 1970 (the Epoch).
|
|
|
|
|
|
|
|
.BR timerisset ()
|
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
|
|
|
returns true (nonzero) if either field of the
|
2007-07-08 14:18:12 +00:00
|
|
|
.I timeval
|
|
|
|
structure pointed to by
|
2007-09-20 16:26:31 +00:00
|
|
|
.I tvp
|
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
|
|
|
contains a nonzero value.
|
2007-07-08 14:18:12 +00:00
|
|
|
|
|
|
|
.BR timercmp ()
|
|
|
|
compares the timer values in
|
|
|
|
.I a
|
|
|
|
and
|
2007-09-20 16:26:31 +00:00
|
|
|
.I b
|
2007-07-08 14:18:12 +00:00
|
|
|
using the comparison operator
|
|
|
|
.IR CMP ,
|
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
|
|
|
and returns true (nonzero) or false (0) depending on
|
2007-07-08 14:18:12 +00:00
|
|
|
the result of the comparison.
|
2009-02-25 19:42:26 +00:00
|
|
|
Some systems (but not Linux/glibc),
|
|
|
|
have a broken
|
|
|
|
.BR timercmp ()
|
|
|
|
implementation,
|
|
|
|
.\" HP-UX, Tru64, Irix have a definition like:
|
|
|
|
.\"#define timercmp(tvp, uvp, cmp) \
|
|
|
|
.\" ((tvp)->tv_sec cmp (uvp)->tv_sec || \
|
|
|
|
.\" (tvp)->tv_sec == (uvp)->tv_sec && (tvp)->tv_usec cmp (uvp)->tv_usec)
|
|
|
|
in which
|
|
|
|
.I CMP
|
|
|
|
of
|
|
|
|
.IR >= ,
|
|
|
|
.IR <= ,
|
|
|
|
and
|
|
|
|
.I ==
|
|
|
|
do not work;
|
|
|
|
portable applications can instead use
|
|
|
|
|
|
|
|
!timercmp(..., <)
|
|
|
|
!timercmp(..., >)
|
|
|
|
!timercmp(..., !=)
|
2007-07-08 14:18:12 +00:00
|
|
|
.SH RETURN VALUE
|
|
|
|
.BR timerisset ()
|
|
|
|
and
|
|
|
|
.BR timercmp ()
|
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
|
|
|
return true (nonzero) or false (0).
|
2007-07-08 14:18:12 +00:00
|
|
|
.SH ERRORS
|
|
|
|
No errors are defined.
|
|
|
|
.SH CONFORMING TO
|
|
|
|
Not in POSIX.1-2001.
|
|
|
|
Present on most BSD derivatives.
|
|
|
|
.SH "SEE ALSO"
|
|
|
|
.BR gettimeofday (2),
|
2008-07-14 15:52:21 +00:00
|
|
|
.BR time (7)
|