draft/man3/timeradd.3

   1 .\" Copyright (c) 2007 by Michael Kerrisk <mtk.manpages@gmail.com>
   2 .\"
   3 .\" Permission is granted to make and distribute verbatim copies of this
   4 .\" manual provided the copyright notice and this permission notice are
   5 .\" preserved on all copies.
   6 .\"
   7 .\" Permission is granted to copy and distribute modified versions of this
   8 .\" manual under the conditions for verbatim copying, provided that the
   9 .\" entire resulting derived work is distributed under the terms of a
  10 .\" permission notice identical to this one.
  11 .\"
  12 .\" Since the Linux kernel and libraries are constantly changing, this
  13 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  14 .\" responsibility for errors or omissions, or for damages resulting from
  15 .\" the use of the information contained herein.  The author(s) may not
  16 .\" have taken the same level of care in the production of this manual,
  17 .\" which is licensed free of charge, as they might when working
  18 .\" professionally.
  19 .\"
  20 .\" Formatted or processed versions of this manual, if unaccompanied by
  21 .\" the source, must acknowledge the copyright and authors of this work.
  22 .\"
  23 .\" 2007-07-31, mtk, Created
  24 .\"
  25 .\" Japanese Version Copyright (c) 2007  Akihiro MOTOKI
  26 .\"         all rights reserved.
  27 .\" Translated 2007-10-16, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v2.66
  28 .\" Updated 2009-04-24, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v3.20
  29 .\"
  30 .TH TIMERADD 3 2010-02-25 "Linux" "Linux Programmer's Manual"
  31 .\"O .SH NAME
  32 .SH Ì¾Á°
  33 .\"O timeradd, timersub, timercmp, timerclear, timerisset \- timeval operations
  34 timeradd, timersub, timercmp, timerclear, timerisset \- timeval ¤ÎÁàºî
  35 .\"O .SH SYNOPSIS
  36 .SH ½ñ¼°
  37 .nf
  38 .B #include <sys/time.h>
  39
  40 .BI "void timeradd(struct timeval *" a ", struct timeval *" b ,
  41 .BI "              struct timeval *" res );
  42
  43 .BI "void timersub(struct timeval *" a ", struct timeval *" b ,
  44 .BI "              struct timeval *" res );
  45
  46 .BI "void timerclear(struct timeval *" tvp );
  47
  48 .BI "int timerisset(struct timeval *" tvp );
  49
  50 .BI "int timercmp(struct timeval *" a ", struct timeval *" b ", " CMP );
  51 .fi
  52 .sp
  53 .in -4n
  54 .\"O Feature Test Macro Requirements for glibc (see
  55 .\"O .BR feature_test_macros (7)):
  56 glibc ¸þ¤±¤Îµ¡Ç½¸¡ºº¥Þ¥¯¥í¤ÎÍ×·ï
  57 .RB ( feature_test_macros (7)
  58 »²¾È):
  59 .in
  60 .sp
  61 .\"O All functions shown above:
  62 ¾åµ¤ÎÁ´¤Æ¤Î´Ø¿ô:
  63 _BSD_SOURCE
  64 .\"O .SH DESCRIPTION
  65 .SH ÀâÌÀ
  66 .\"O The macros are provided to operate on
  67 .\"O .I timeval
  68 .\"O structures, defined in
  69 .\"O .I <sys/time.h>
  70 .\"O as:
  71 .I timeval
  72 ¹½Â¤ÂÎ¤òÁàºî¤¹¤ë¤¿¤á¤Î¥Þ¥¯¥í¤¬Äó¶¡¤µ¤ì¤Æ¤¤¤ë¡£
  73 .I timeval
  74 ¹½Â¤ÂÎ¤Ï
  75 .I <sys/time.h>
  76 ¤Ç°Ê²¼¤Î¤è¤¦¤ËÄêµÁ¤µ¤ì¤Æ¤¤¤ë¡£
  77 .sp
  78 .in +4n
  79 .nf
  80 struct timeval {
  81 .\"O     time_t      tv_sec;     /* seconds */
  82 .\"O     suseconds_t tv_usec;    /* microseconds */
  83     time_t      tv_sec;     /* ÉÃ */
  84     suseconds_t tv_usec;    /* ¥Þ¥¤¥¯¥íÉÃ */
  85 };
  86 .fi
  87 .in
  88 .PP
  89 .\"O .BR timeradd ()
  90 .\"O adds the time values in
  91 .\"O .I a
  92 .\"O and
  93 .\"O .IR b ,
  94 .\"O and places the sum in the
  95 .\"O .I timeval
  96 .\"O pointed to by
  97 .\"O .IR res .
  98 .\"O The result is normalized such that
  99 .\"O .I res\->tv_usec
 100 .\"O has a value in the range 0 to 999,999.
 101 .BR timeradd ()
 102 ¤Ï¡¢
 103 .I a
 104 ¤È
 105 .I b
 106 ¤Î»þ¹ïÃÍ¤ò²Ã»»¤·¡¢¤½¤Î¹ç·×¤ò
 107 .I res
 108 ¤Ë¤è¤ê»²¾È¤µ¤ì¤ë
 109 .I timeval
 110 ¹½Â¤ÂÎ¤Ë³ÊÇ¼¤¹¤ë¡£·ë²Ì¤Ï¡¢
 111 .I res\->tv_usec
 112 ¤ÎÃÍ¤¬ 0 ¤«¤é 999,999 ¤ÎÈÏ°Ï¤ËÆþ¤ë¤è¤¦¤ËÀµµ¬²½¤µ¤ì¤ë¡£
 113
 114 .\"O .BR timersub ()
 115 .\"O subtracts the time value in
 116 .\"O .I b
 117 .\"O from the time value in
 118 .\"O .IR a ,
 119 .\"O and places the result in the
 120 .\"O .I timeval
 121 .\"O pointed to by
 122 .\"O .IR res .
 123 .\"O The result is normalized such that
 124 .\"O .I res\->tv_usec
 125 .\"O has a value in the range 0 to 999,999.
 126 .BR timersub ()
 127 ¤Ï¡¢
 128 .I a
 129 ¤Î»þ¹ïÃÍ¤«¤é
 130 .I b
 131 ¤Î»þ¹ïÃÍ¤ò¸º»»¤·¡¢¤½¤Î·ë²Ì¤ò
 132 .I res
 133 ¤Ë¤è¤ê»²¾È¤µ¤ì¤ë
 134 .I timeval
 135 ¹½Â¤ÂÎ¤Ë³ÊÇ¼¤¹¤ë¡£·ë²Ì¤Ï¡¢
 136 .I res\->tv_usec
 137 ¤ÎÃÍ¤¬ 0 ¤«¤é 999,999 ¤ÎÈÏ°Ï¤ËÆþ¤ë¤è¤¦¤ËÀµµ¬²½¤µ¤ì¤ë¡£
 138
 139 .\"O .BR timerclear ()
 140 .\"O zeros out the
 141 .\"O .I timeval
 142 .\"O structure pointed to by
 143 .\"O .IR tvp ,
 144 .\"O so that it represents the Epoch: 1970-01-01 00:00:00 +0000 (UTC).
 145 .BR timerclear ()
 146 ¤Ï
 147 .I tvp
 148 ¤Ë¤è¤ê»²¾È¤µ¤ì¤ë
 149 .I timeval
 150 ¹½Â¤ÂÎ¤ò 0 ¤ÇËä¤á¤ë¡£
 151 0 ¤ÇËä¤á¤é¤ì¤¿
 152 .I timeval
 153 ¹½Â¤ÂÎ¤Ï¡¢»þ¹ïµª¸µ (Epoch; 1970-01-01 00:00:00 +0000 (UTC)) ¤òÉ½¤¹¡£
 154
 155 .\"O .BR timerisset ()
 156 .\"O returns true (nonzero) if either field of the
 157 .\"O .I timeval
 158 .\"O structure pointed to by
 159 .\"O .I tvp
 160 .\"O contains a nonzero value.
 161 .BR timerisset ()
 162 ¤Ï¡¢
 163 .I tvp
 164 ¤Ë¤è¤ê»²¾È¤µ¤ì¤ë
 165 .I timeval
 166 ¹½Â¤ÂÎ¤Î¤¤¤º¤ì¤«°ìÊý¤Î¥Õ¥£¡¼¥ë¥É¤Ë 0 °Ê³°¤ÎÃÍ¤¬Æþ¤Ã¤Æ¤¤¤ì¤Ð¡¢
 167 ¿¿ (0 °Ê³°) ¤òÊÖ¤¹¡£
 168
 169 .\"O .BR timercmp ()
 170 .\"O compares the timer values in
 171 .\"O .I a
 172 .\"O and
 173 .\"O .I b
 174 .\"O using the comparison operator
 175 .\"O .IR CMP ,
 176 .\"O and returns true (nonzero) or false (0) depending on
 177 .\"O the result of the comparison.
 178 .BR timercmp ()
 179 ¤Ï
 180 .I a
 181 ¤È
 182 .I b
 183 ¤Î»þ¹ïÃÍ¤òÈæ³Ó±é»»»Ò
 184 .I CMP
 185 ¤ò»È¤Ã¤ÆÈæ³Ó¤·¡¢Èæ³Ó·ë²Ì¤Ë´ð¤Å¤¡¢¿¿ (0 °Ê³°) ¤«µ¶ (0) ¤òÊÖ¤¹¡£
 186 .\"O Some systems (but not Linux/glibc),
 187 .\"O have a broken
 188 .\"O .BR timercmp ()
 189 .\"O implementation,
 190 .\"O .\" HP-UX, Tru64, Irix have a definition like:
 191 .\"O .\"#define timercmp(tvp, uvp, cmp) \
 192 .\"O .\"    ((tvp)->tv_sec cmp (uvp)->tv_sec || \
 193 .\"O .\"    (tvp)->tv_sec == (uvp)->tv_sec && (tvp)->tv_usec cmp (uvp)->tv_usec)
 194 .\"O in which
 195 .\"O .I CMP
 196 .\"O of
 197 .\"O .IR >= ,
 198 .\"O .IR <= ,
 199 .\"O and
 200 .\"O .I ==
 201 .\"O do not work;
 202 (Linux/glibc ¤Ï¤½¤¦¤Ç¤Ï¤Ê¤¤¤¬)
 203 ¤¤¤¯¤Ä¤«¤Î¥·¥¹¥Æ¥à¤Ç¤Ï¡¢
 204 .BRr timercmp ()
 205 ¤Î¼ÂÁõ¤¬¤ª¤«¤·¤¯¡¢
 206 .\" HP-UX, Tru64, Irix ¤Ç¤Ï°Ê²¼¤Î¤è¤¦¤ËÄêµÁ¤µ¤ì¤Æ¤¤¤ë¡£
 207 .\"#define timercmp(tvp, uvp, cmp) \
 208 .\"    ((tvp)->tv_sec cmp (uvp)->tv_sec || \
 209 .\"    (tvp)->tv_sec == (uvp)->tv_sec && (tvp)->tv_usec cmp (uvp)->tv_usec)
 210 .I CMP
 211 ¤Ë
 212 .IR >= ,
 213 .IR <= ,
 214 .I ==
 215 ¤ò»ØÄê¤¹¤ë¤ÈÀµ¤·¤¯Æ°ºî¤·¤Ê¤¤¡£
 216 .\"O portable applications can instead use
 217 °Ü¿¢À¤¬É¬Í×¤Ê¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¤Ç¤Ï¡¢
 218 Âå¤ï¤ê¤Ë°Ê²¼¤ò»È¤¦¤³¤È¡£
 219
 220     !timercmp(..., <)
 221     !timercmp(..., >)
 222     !timercmp(..., !=)
 223 .\"O .SH RETURN VALUE
 224 .SH ÊÖ¤êÃÍ
 225 .\"O .BR timerisset ()
 226 .\"O and
 227 .\"O .BR timercmp ()
 228 .\"O return true (nonzero) or false (0).
 229 .BR timerisset ()
 230 ¤È
 231 .BR timercmp ()
 232 ¤Ï¡¢¿¿ (0 °Ê³°) ¤«µ¶ (0) ¤òÊÖ¤¹¡£
 233 .BR
 234 .\"O .SH ERRORS
 235 .SH ¥¨¥é¡¼
 236 .\"O No errors are defined.
 237 ¥¨¥é¡¼¤ÏÄêµÁ¤µ¤ì¤Æ¤¤¤Ê¤¤¡£
 238 .\"O .SH CONFORMING TO
 239 .SH ½àµò
 240 .\"O Not in POSIX.1-2001.
 241 .\"O Present on most BSD derivatives.
 242 POSIX.1-2001 ¤Ë¤Ï¤Ê¤¤¡£
 243 ¤Û¤È¤ó¤É¤Î BSD Í³Íè¤Î¥·¥¹¥Æ¥à¤Ë¤ÏÂ¸ºß¤¹¤ë¡£
 244 .\"O .SH "SEE ALSO"
 245 .SH ´ØÏ¢¹àÌÜ
 246 .BR gettimeofday (2),
 247 .BR time (7)