xref: /illumos-gate/usr/src/man/man3c/nanosleep.3c (revision 78801af7286cd73dbc996d470f789e75993cf15d)

Sun Microsystems, Inc. gratefully acknowledges The Open Group for
permission to reproduce portions of its copyrighted documentation.
Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.

The Institute of Electrical and Electronics Engineers and The Open
Group, have given us permission to reprint portions of their
documentation.

In the following statement, the phrase ``this text'' refers to portions
of the system documentation.

Portions of this text are reprinted and reproduced in electronic form
in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
Standard for Information Technology -- Portable Operating System
Interface (POSIX), The Open Group Base Specifications Issue 6,
Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
Engineers, Inc and The Open Group. In the event of any discrepancy
between these versions and the original IEEE and The Open Group
Standard, the original IEEE and The Open Group Standard is the referee
document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html.

This notice shall appear on any product containing this material.

The contents of this file are subject to the terms of the
Common Development and Distribution License (the "License").
You may not use this file except in compliance with the License.

You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions
and limitations under the License.

When distributing Covered Code, include this CDDL HEADER in each
file and include the License file at usr/src/OPENSOLARIS.LICENSE.
If applicable, add the following below this CDDL HEADER, with the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]


Copyright 1989 AT&T
Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved
Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.
Copyright 2016 Joyent, Inc.

NANOSLEEP 3C "Mar 27, 2016"
NAME
nanosleep, thrd_sleep - high resolution sleep
SYNOPSIS
#include <time.h>

int nanosleep(const struct timespec *rqtp,
 struct timespec *rmtp);
#include <threads.h>

int thrd_sleep(const struct timespec *rqtp,
 struct timespec *rmtp);

DESCRIPTION
The nanosleep() and thrd_sleep() functions cause the current thread to be suspended from execution until either the time interval specified by the rqtp argument has elapsed or a signal is delivered to the calling thread and its action is to invoke a signal-catching function or to terminate the process. The suspension time may be longer than requested because the argument value is rounded up to an integer multiple of the sleep resolution or because of the scheduling of other activity by the system. But, except for the case of being interrupted by a signal, the suspension time will not be less than the time specified by rqtp, as measured by the system clock, CLOCK_REALTIME.

The use of the nanosleep() and thrd_sleep() functions has no effect on the action or blockage of any signal.

RETURN VALUES
If the nanosleep() or thrd_sleep() function returns because the requested time has elapsed, its return value is 0.

If the nanosleep() function returns because it has been interrupted by a signal, the function returns a value of -1 and sets errno to indicate the interruption. If the rmtp argument is non-NULL, the timespec structure referenced by it is updated to contain the amount of time remaining in the interval (the requested time minus the time actually slept). If the rmtp argument is NULL, the remaining time is not returned.

If nanosleep() fails, it returns -1 and sets errno to indicate the error.

The thrd_sleep() function may fail for identical reasons as the nanosleep() function and returns -1; however, the C11 standard does not define that errno should be set, therefore callers of thrd_sleep() cannot rely on errno being set or staying the same across a call to thrd_sleep() .

ERRORS
The nanosleep() function will fail if: EINTR

The nanosleep() function was interrupted by a signal.

EINVAL

The rqtp argument specified a nanosecond value less than zero or greater than or equal to 1000 million.

ENOSYS

The nanosleep() function is not supported by this implementation.

ATTRIBUTES
See attributes(5) for descriptions of the following attributes:
ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Committed
MT-Level MT-Safe
Standard See standards(5).
SEE ALSO
sleep(3C), time.h(3HEAD), attributes(5), standards(5)