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