lib/libc/sys/nanosleep.2

   1 .\"     $Id: nanosleep.2,v 1.3 1997/08/21 19:44:41 bde 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 .Nm signanosleep
  44 .Sh SYNOPSIS
  45 .Fd #include <time.h>
  46 .Ft int
  47 .Fn nanosleep "const struct timespec *rqtp" "struct timespec *rmtp"
  48 .Pp
  49 .Fd #include <signal.h>
  50 .Fd #include <time.h>
  51 .Ft int
  52 .Fn signanosleep "const struct timespec *rqtp" "struct timespec *rmtp" "sigset_t *mask"
  53 .Sh DESCRIPTION
  54 .Fn Nanosleep
  55 causes the process to sleep for the specified time.  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 .Pp
  60 The
  61 .Fn signanosleep
  62 function temporarily (and atomically) sets the signal mask of the process
  63 for the duration of the system call so that specific signals can be
  64 nominated to cause an early termination of the sleep.
  65 .Sh RETURN VALUE
  66 If the
  67 .Fn nanosleep
  68 function returns because the requested time has elapsed, the value
  69 returned will be zero.
  70 .Pp
  71 If the
  72 .Fn nanosleep
  73 function returns due to the delivery of a signal, the value returned
  74 will be the -1, and the global variable
  75 .Va errno
  76 will be set to indicate the interruption.
  77 If
  78 .Fa rmtp
  79 is
  80 .Pf non- Dv NULL ,
  81 the timespec structure it references is updated to contain the
  82 unslept amount (the request time minus the time actually slept).
  83 .Sh ERRORS
  84 If any of the following conditions occur, the
  85 .Nm
  86 function shall return -1 and set
  87 .Va errno
  88 to the corresponding value.
  89 .Bl -tag -width Er
  90 .It Bq Er EFAULT
  91 Either
  92 .Fa rqtp
  93 or
  94 .Fa rmtp
  95 points to memory that is not a valid part of the process
  96 address space.
  97 .It Bq Er EINTR
  98 .Nm
  99 was interrupted by the delivery of a signal.
 100 .It Bq Er EINVAL
 101 .Fa rqtp
 102 specified a nanosecond value less than zero
 103 or greater than or equal to 1000 million.
 104 .It Bq Er ENOSYS
 105 .Nm
 106 is not supported by this implementation.
 107 .El
 108 .Sh SEE ALSO
 109 .Xr sigsuspend 2 ,
 110 .Xr sleep 3
 111 .Sh STANDARDS
 112 The
 113 .Fn nanosleep
 114 function conforms to
 115 .St -p1003.1b-93 .
 116 .Pp
 117 The
 118 .Fn signanosleep
 119 function is an extenstion that first appeared in
 120 .Fx 3.0