share/man/man9/itimerfix.9

   1 .\"     $NetBSD: itimerfix.9,v 1.6 2006/06/17 04:58:15 reed Exp $
   2 .\"
   3 .\" Copyright (c) 2001 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Christos Zoulas.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd November 23, 2001
  31 .Dt ITIMERFIX 9
  32 .Os
  33 .Sh NAME
  34 .Nm itimerfix
  35 .Nd check that a timeval value is valid, and correct
  36 .Sh SYNOPSIS
  37 .In sys/time.h
  38 .Ft int
  39 .Fn itimerfix "struct timeval *tv"
  40 .Sh DESCRIPTION
  41 The
  42 .Nm
  43 function checks that the value in
  44 .Fa tv
  45 is valid (0 \*[Le] tv-\*[Gt]tv_sec \*[Am]\*[Am]  0 \*[Le] tv-\*[Gt]tv_usec \*[Lt] 1000000), and that the
  46 total time represented is at least one
  47 .Em tick ,
  48 or zero.
  49 .Pp
  50 If the total represented time is nonzero and smaller than tick,
  51 it is adjusted to exactly one tick.
  52 .Sh RETURN VALUES
  53 .Nm
  54 returns 0 on success or
  55 .Er EINVAL
  56 if
  57 .Fa tv
  58 is invalid.
  59 .Sh SEE ALSO
  60 .Xr nanosleep 2 ,
  61 .Xr poll 2 ,
  62 .Xr select 2 ,
  63 .Xr setitimer 2