[apple/libc.git] / sys / nanosleep.2

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