lib/libc/sys/nanosleep.2

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