xref: /netbsd-src/lib/libc/gen/sleep.3 (revision ae9172d6cd9432a6a1a56760d86b32c57a66c39c)
1.\" Copyright (c) 1986, 1991 Regents of the University of California.
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     from: @(#)sleep.3	6.3 (Berkeley) 4/19/91
33.\"	$Id: sleep.3,v 1.6 1994/12/11 17:50:52 mycroft Exp $
34.\"
35.Dd April 19, 1991
36.Dt SLEEP 3
37.Os
38.Sh NAME
39.Nm sleep
40.Nd suspend process execution for interval of seconds
41.Sh SYNOPSIS
42.Fd #include <unistd.h>
43.Ft unsigned int
44.Fn sleep "unsigned int seconds"
45.Sh DESCRIPTION
46The
47.Fn sleep
48function suspends execution of the calling process until either the
49number of seconds specified by
50.Fa seconds
51have elapsed or a signal is delivered to the calling process and its
52action is to invoke a signal-catching function or to terminate the
53process.  The suspension time may be longer than requested due to the
54scheduling of other activity by the system.
55.Pp
56If a timer is already running on the process its state is saved.
57If the value
58.Fa seconds
59is more than or equal to the remaining clock time for the saved timer,
60the sleep time is set to
61the remaining clock time.
62The state of the previous timer
63is restored after
64.Fa seconds
65has passed.
66.Pp
67This function is implemented using
68.Xr setitimer 2 ;
69it requires eight system calls each time it is invoked.
70A similar but less compatible function can be obtained with a single
71.Xr select 2 ;
72such a function would not restart after signals, but would not interfere
73with other uses of
74.Xr setitimer .
75.Sh RETURN VALUE
76If the
77.Fn sleep
78function returns because the requested time has elapsed, the value
79returned will be zero.  If the
80.Fn sleep
81function returns due to the delivery of a signal, the value returned
82will be the unslept amount (the request time minus the time actually
83slept) in seconds.
84.Sh SEE ALSO
85.Xr setitimer 2 ,
86.Xr sigaction 2 ,
87.Xr sigsuspend 2 ,
88.Xr alarm 3 ,
89.Xr pause 3 ,
90.Xr usleep 3
91.Sh STANDARDS
92The
93.Fn sleep
94function conforms to
95.St -p1003.1-90 .
96.Sh HISTORY
97A
98.Fn sleep
99function appeared in
100.At v7 .
101