1 .\" 2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for 3 .\" permission to reproduce portions of its copyrighted documentation. 4 .\" Original documentation from The Open Group can be obtained online at 5 .\" http://www.opengroup.org/bookstore/. 6 .\" 7 .\" The Institute of Electrical and Electronics Engineers and The Open 8 .\" Group, have given us permission to reprint portions of their 9 .\" documentation. 10 .\" 11 .\" In the following statement, the phrase ``this text'' refers to portions 12 .\" of the system documentation. 13 .\" 14 .\" Portions of this text are reprinted and reproduced in electronic form 15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition, 16 .\" Standard for Information Technology -- Portable Operating System 17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6, 18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics 19 .\" Engineers, Inc and The Open Group. In the event of any discrepancy 20 .\" between these versions and the original IEEE and The Open Group 21 .\" Standard, the original IEEE and The Open Group Standard is the referee 22 .\" document. The original Standard can be obtained online at 23 .\" http://www.opengroup.org/unix/online.html. 24 .\" 25 .\" This notice shall appear on any product containing this material. 26 .\" 27 .\" The contents of this file are subject to the terms of the 28 .\" Common Development and Distribution License (the "License"). 29 .\" You may not use this file except in compliance with the License. 30 .\" 31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 32 .\" or http://www.opensolaris.org/os/licensing. 33 .\" See the License for the specific language governing permissions 34 .\" and limitations under the License. 35 .\" 36 .\" When distributing Covered Code, include this CDDL HEADER in each 37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE. 38 .\" If applicable, add the following below this CDDL HEADER, with the 39 .\" fields enclosed by brackets "[]" replaced with your own identifying 40 .\" information: Portions Copyright [yyyy] [name of copyright owner] 41 .\" 42 .\" 43 .\" Copyright 1989 AT&T 44 .\" Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved 45 .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved. 46 .\" Copyright 2016 Joyent, Inc. 47 .\" 48 .TH NANOSLEEP 3C "Mar 27, 2016" 49 .SH NAME 50 nanosleep, thrd_sleep \- high resolution sleep 51 .SH SYNOPSIS 52 .LP 53 .nf 54 #include <time.h> 55 56 \fBint\fR \fBnanosleep\fR(\fBconst struct timespec *\fR\fIrqtp\fR, 57 \fBstruct timespec *\fR\fIrmtp\fR); 58 .fi 59 60 .nf 61 #include <threads.h> 62 63 \fBint\fR \fBthrd_sleep\fR(\fBconst struct timespec *\fR\fIrqtp\fR, 64 \fBstruct timespec *\fR\fIrmtp\fR); 65 66 .SH DESCRIPTION 67 .LP 68 The \fBnanosleep()\fR and \fBthrd_sleep()\fR functions cause the current thread 69 to be suspended from execution until either the time interval specified by the 70 \fIrqtp\fR argument has elapsed or a signal is delivered to the calling thread 71 and its action is to invoke a signal-catching function or to terminate the 72 process. The suspension time may be longer than requested because the argument 73 value is rounded up to an integer multiple of the sleep resolution or because of 74 the scheduling of other activity by the system. But, except for the case of 75 being interrupted by a signal, the suspension time will not be less than the 76 time specified by \fIrqtp\fR, as measured by the system clock, 77 \fBCLOCK_REALTIME\fR. 78 .sp 79 .LP 80 The use of the \fBnanosleep()\fR and \fBthrd_sleep()\fR functions has no effect 81 on the action or blockage of any signal. 82 .SH RETURN VALUES 83 .LP 84 If the \fBnanosleep()\fR or \fBthrd_sleep()\fR function returns because the 85 requested time has elapsed, its return value is \fB0\fR. 86 .sp 87 .LP 88 If the \fBnanosleep()\fR function returns because it has been interrupted by a 89 signal, the function returns a value of \(mi1 and sets \fBerrno\fR to indicate 90 the interruption. If the \fIrmtp\fR argument is non-\fINULL\fR, the 91 \fBtimespec\fR structure referenced by it is updated to contain the amount of 92 time remaining in the interval (the requested time minus the time actually 93 slept). If the \fIrmtp\fR argument is \fINULL\fR, the remaining time is not 94 returned. 95 .sp 96 .LP 97 If \fBnanosleep()\fR fails, it returns \fB\(mi1\fR and sets \fBerrno\fR to 98 indicate the error. 99 .sp 100 .LP 101 102 The 103 .B thrd_sleep() 104 function may fail for identical reasons as the 105 .B nanosleep() 106 function and returns \(mi1; however, the C11 standard does not define that 107 .B errno 108 should be set, therefore callers of \fBthrd_sleep()\fR cannot rely on 109 .B errno 110 being set or staying the same across a call to 111 .B thrd_sleep() . 112 113 .SH ERRORS 114 .LP 115 The \fBnanosleep()\fR function will fail if: 116 .sp 117 .ne 2 118 .na 119 \fB\fBEINTR\fR\fR 120 .ad 121 .RS 10n 122 The \fBnanosleep()\fR function was interrupted by a signal. 123 .RE 124 125 .sp 126 .ne 2 127 .na 128 \fB\fBEINVAL\fR\fR 129 .ad 130 .RS 10n 131 The \fIrqtp\fR argument specified a nanosecond value less than zero or greater 132 than or equal to 1000 million. 133 .RE 134 135 .sp 136 .ne 2 137 .na 138 \fB\fBENOSYS\fR\fR 139 .ad 140 .RS 10n 141 The \fBnanosleep()\fR function is not supported by this implementation. 142 .RE 143 144 .SH ATTRIBUTES 145 .LP 146 See \fBattributes\fR(5) for descriptions of the following attributes: 147 .sp 148 149 .sp 150 .TS 151 box; 152 c | c 153 l | l . 154 ATTRIBUTE TYPE ATTRIBUTE VALUE 155 _ 156 Interface Stability Committed 157 _ 158 MT-Level MT-Safe 159 _ 160 Standard See \fBstandards\fR(5). 161 .TE 162 163 .SH SEE ALSO 164 .LP 165 \fBsleep\fR(3C), \fBtime.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5)