sys/nanosleep.2

   1 .\" $FreeBSD: src/lib/libc/sys/nanosleep.2,v 1.8.2.4 2001/12/14 18:34:01 ru Exp $
   2 .\"     $OpenBSD: nanosleep.2,v 1.1 1997/04/20 20:56:20 tholo Exp $
   3 .\"     $NetBSD: nanosleep.2,v 1.1 1997/04/17 18:12:02 jtc Exp $
   4 .\"
   5 .\" Copyright (c) 1986, 1991, 1993
   6 .\"     The Regents of the University of California.  All rights reserved.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgement:
  18 .\"     This product includes software developed by the University of
  19 .\"     California, Berkeley and its contributors.
  20 .\" 4. Neither the name of the University nor the names of its contributors
  21 .\"    may be used to endorse or promote products derived from this software
  22 .\"    without specific prior written permission.
  23 .\"
  24 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34 .\" SUCH DAMAGE.
  35 .\"
  36 .\"     @(#)sleep.3     8.1 (Berkeley) 6/4/93
  37 .\"
  38 .Dd April 17, 1997
  39 .Dt NANOSLEEP 2
  40 .Os
  41 .Sh NAME
  42 .Nm nanosleep
  43 .Nd suspend thread execution for an interval measured in nanoseconds
  44 .Sh LIBRARY
  45 .Lb libc
  46 .Sh SYNOPSIS
  47 .In time.h
  48 .Ft int
  49 .Fo nanosleep
  50 .Fa "const struct timespec *rqtp"
  51 .Fa "struct timespec *rmtp"
  52 .Fc
  53 .Sh DESCRIPTION
  54 The
  55 .Fn nanosleep
  56 function causes the calling thread to sleep
  57 for the amount of time specified in
  58 .Fa rqtp
  59 (the actual time slept may be longer, due to system latencies
  60 and possible limitations in the timer resolution of the hardware).
  61 An unmasked signal will
  62 cause
  63 .Fn nanosleep
  64 to terminate the sleep early, regardless of the
  65 .Dv SA_RESTART
  66 value on the interrupting signal.
  67 .Sh RETURN VALUES
  68 If
  69 .Fn nanosleep
  70 returns because the requested time has elapsed,
  71 the value returned will be zero.
  72 .Pp
  73 If
  74 .Fn nanosleep
  75 returns due to the delivery of a signal, the value returned
  76 will be the -1, and the global variable
  77 .Va errno
  78 will be set to indicate the interruption.
  79 If
  80 .Fa rmtp
  81 is
  82 .Pf non- Dv NULL ,
  83 the timespec structure it references is updated to contain the
  84 unslept amount (the request time minus the time actually slept).
  85 .Sh ERRORS
  86 The
  87 .Fn nanosleep
  88 call fails if:
  89 .Bl -tag -width Er
  90 .It Bq Er EINTR
  91 .Fn nanosleep
  92 was interrupted by the delivery of a signal.
  93 .It Bq Er EINVAL
  94 .Fa rqtp
  95 specified a nanosecond value less than zero
  96 or greater than or equal to 1000 million.
  97 .El
  98 .Sh SEE ALSO
  99 .Xr sigsuspend 2 ,
 100 .Xr sleep 3
 101 .Sh STANDARDS
 102 The
 103 .Fn nanosleep
 104 function conforms to
 105 .St -p1003.1b-93 .