release/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 .SH 名前
  32 timeradd, timersub, timercmp, timerclear, timerisset \- timeval の操作
  33 .SH 書式
  34 .nf
  35 .B #include <sys/time.h>
  36
  37 .BI "void timeradd(struct timeval *" a ", struct timeval *" b ,
  38 .BI "              struct timeval *" res );
  39
  40 .BI "void timersub(struct timeval *" a ", struct timeval *" b ,
  41 .BI "              struct timeval *" res );
  42
  43 .BI "void timerclear(struct timeval *" tvp );
  44
  45 .BI "int timerisset(struct timeval *" tvp );
  46
  47 .BI "int timercmp(struct timeval *" a ", struct timeval *" b ", " CMP );
  48 .fi
  49 .sp
  50 .in -4n
  51 glibc 向けの機能検査マクロの要件
  52 .RB ( feature_test_macros (7)
  53 参照):
  54 .in
  55 .sp
  56 上記の全ての関数:
  57 _BSD_SOURCE
  58 .SH 説明
  59 .I timeval
  60 構造体を操作するためのマクロが提供されている。
  61 .I timeval
  62 構造体は
  63 .I <sys/time.h>
  64 で以下のように定義されている。
  65 .sp
  66 .in +4n
  67 .nf
  68 struct timeval {
  69     time_t      tv_sec;     /* 秒 */
  70     suseconds_t tv_usec;    /* マイクロ秒 */
  71 };
  72 .fi
  73 .in
  74 .PP
  75 .BR timeradd ()
  76 は、
  77 .I a
  78 と
  79 .I b
  80 の時刻値を加算し、その合計を
  81 .I res
  82 により参照される
  83 .I timeval
  84 構造体に格納する。結果は、
  85 .I res\->tv_usec
  86 の値が 0 から 999,999 の範囲に入るように正規化される。
  87
  88 .BR timersub ()
  89 は、
  90 .I a
  91 の時刻値から
  92 .I b
  93 の時刻値を減算し、その結果を
  94 .I res
  95 により参照される
  96 .I timeval
  97 構造体に格納する。結果は、
  98 .I res\->tv_usec
  99 の値が 0 から 999,999 の範囲に入るように正規化される。
 100
 101 .BR timerclear ()
 102 は
 103 .I tvp
 104 により参照される
 105 .I timeval
 106 構造体を 0 で埋める。
 107 0 で埋められた
 108 .I timeval
 109 構造体は、時刻紀元 (Epoch; 1970-01-01 00:00:00 +0000 (UTC)) を表す。
 110
 111 .BR timerisset ()
 112 は、
 113 .I tvp
 114 により参照される
 115 .I timeval
 116 構造体のいずれか一方のフィールドに 0 以外の値が入っていれば、
 117 真 (0 以外) を返す。
 118
 119 .BR timercmp ()
 120 は
 121 .I a
 122 と
 123 .I b
 124 の時刻値を比較演算子
 125 .I CMP
 126 を使って比較し、比較結果に基づき、真 (0 以外) か偽 (0) を返す。
 127 (Linux/glibc はそうではないが)
 128 いくつかのシステムでは、
 129 .BRr timercmp ()
 130 の実装がおかしく、
 131 .\" HP-UX, Tru64, Irix では以下のように定義されている。
 132 .\"#define timercmp(tvp, uvp, cmp) \
 133 .\"    ((tvp)->tv_sec cmp (uvp)->tv_sec || \
 134 .\"    (tvp)->tv_sec == (uvp)->tv_sec && (tvp)->tv_usec cmp (uvp)->tv_usec)
 135 .I CMP
 136 に
 137 .IR >= ,
 138 .IR <= ,
 139 .I ==
 140 を指定すると正しく動作しない。
 141 移植性が必要なアプリケーションでは、
 142 代わりに以下を使うこと。
 143
 144     !timercmp(..., <)
 145     !timercmp(..., >)
 146     !timercmp(..., !=)
 147 .SH 返り値
 148 .BR timerisset ()
 149 と
 150 .BR timercmp ()
 151 は、真 (0 以外) か偽 (0) を返す。
 152 .BR
 153 .SH エラー
 154 エラーは定義されていない。
 155 .SH 準拠
 156 POSIX.1-2001 にはない。
 157 ほとんどの BSD 由来のシステムには存在する。
 158 .SH 関連項目
 159 .BR gettimeofday (2),
 160 .BR time (7)