usr/src/man/man3c/nanosleep.3c

   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" Copyright 2016 Joyent, Inc.
   4 .\" Copyright 1989 AT&T
   5 .\" Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
   6 .\" 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
   7 .\" http://www.opengroup.org/bookstore/.
   8 .\" 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 Sun OS 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.
   9 .\"  This notice shall appear on any product containing this material.
  10 .\" 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.
  11 .\" 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.
  12 .\" 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]
  13 .TH NANOSLEEP 3C "Mar 27, 2016"
  14 .SH NAME
  15 nanosleep, thrd_sleep \- high resolution sleep
  16 .SH SYNOPSIS
  17 .LP
  18 .nf
  19 #include <time.h>
  20
  21 \fBint\fR \fBnanosleep\fR(\fBconst struct timespec *\fR\fIrqtp\fR,
  22      \fBstruct timespec *\fR\fIrmtp\fR);
  23 .fi
  24
  25 .nf
  26 #include <threads.h>
  27
  28 \fBint\fR \fBthrd_sleep\fR(\fBconst struct timespec *\fR\fIrqtp\fR,
  29      \fBstruct timespec *\fR\fIrmtp\fR);
  30
  31 .SH DESCRIPTION
  32 .LP
  33 The \fBnanosleep()\fR and \fBthrd_sleep()\fR functions cause the current thread
  34 to be suspended from execution until either the time interval specified by the
  35 \fIrqtp\fR argument has elapsed or a signal is delivered to the calling thread
  36 and its action is to invoke a signal-catching function or to terminate the
  37 process. The suspension time may be longer than requested because the argument
  38 value is rounded up to an integer multiple of the sleep resolution or because of
  39 the scheduling of other activity by the system. But, except for the case of
  40 being interrupted by a signal, the suspension time will not be less than the
  41 time specified by \fIrqtp\fR, as measured by the system clock,
  42 \fBCLOCK_REALTIME\fR.
  43 .sp
  44 .LP
  45 The use of the \fBnanosleep()\fR and \fBthrd_sleep()\fR functions has no effect
  46 on the action or blockage of any signal.
  47 .SH RETURN VALUES
  48 .LP
  49 If the \fBnanosleep()\fR or \fBthrd_sleep()\fR function returns because the
  50 requested time has elapsed, its return value is \fB0\fR.
  51 .sp
  52 .LP
  53 If the \fBnanosleep()\fR function returns because it has been interrupted by a
  54 signal, the function returns a value of \(mi1 and sets \fBerrno\fR to indicate
  55 the interruption. If the \fIrmtp\fR argument is non-\fINULL\fR, the
  56 \fBtimespec\fR structure referenced by it is updated to contain the amount of
  57 time remaining in the interval (the requested time minus the time actually
  58 slept). If the \fIrmtp\fR argument is \fINULL\fR, the remaining time is not
  59 returned.
  60 .sp
  61 .LP
  62 If \fBnanosleep()\fR fails, it returns \fB\(mi1\fR and sets \fBerrno\fR to
  63 indicate the error.
  64 .sp
  65 .LP
  66
  67 The
  68 .B thrd_sleep()
  69 function may fail for identical reasons as the
  70 .B nanosleep()
  71 function and returns \(mi1; however, the C11 standard does not define that
  72 .B errno
  73 should be set, therefore callers of \fBthrd_sleep()\fR cannot rely on
  74 .B errno
  75 being set or staying the same across a call to
  76 .B thrd_sleep() .
  77
  78 .SH ERRORS
  79 .LP
  80 The \fBnanosleep()\fR function will fail if:
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fBEINTR\fR\fR
  85 .ad
  86 .RS 10n
  87 The \fBnanosleep()\fR function was interrupted by a signal.
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fBEINVAL\fR\fR
  94 .ad
  95 .RS 10n
  96 The \fIrqtp\fR argument specified a nanosecond value less than zero or greater
  97 than or equal to 1000 million.
  98 .RE
  99
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fBENOSYS\fR\fR
 104 .ad
 105 .RS 10n
 106 The \fBnanosleep()\fR function is not supported by this implementation.
 107 .RE
 108
 109 .SH ATTRIBUTES
 110 .LP
 111 See \fBattributes\fR(5) for descriptions of the following attributes:
 112 .sp
 113
 114 .sp
 115 .TS
 116 box;
 117 c | c
 118 l | l .
 119 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 120 _
 121 Interface Stability     Committed
 122 _
 123 MT-Level        MT-Safe
 124 _
 125 Standard        See \fBstandards\fR(5).
 126 .TE
 127
 128 .SH SEE ALSO
 129 .LP
 130 \fBsleep\fR(3C), \fBtime.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5)