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)
|
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 .nf
53 #include <time.h>
54
55 \fBint\fR \fBnanosleep\fR(\fBconst struct timespec *\fR\fIrqtp\fR,
56 \fBstruct timespec *\fR\fIrmtp\fR);
57 .fi
58
59 .nf
60 #include <threads.h>
61
62 \fBint\fR \fBthrd_sleep\fR(\fBconst struct timespec *\fR\fIrqtp\fR,
63 \fBstruct timespec *\fR\fIrmtp\fR);
64
65 .SH DESCRIPTION
66 The \fBnanosleep()\fR and \fBthrd_sleep()\fR functions cause the current thread
67 to be suspended from execution until either the time interval specified by the
68 \fIrqtp\fR argument has elapsed or a signal is delivered to the calling thread
69 and its action is to invoke a signal-catching function or to terminate the
70 process. The suspension time may be longer than requested because the argument
71 value is rounded up to an integer multiple of the sleep resolution or because of
72 the scheduling of other activity by the system. But, except for the case of
73 being interrupted by a signal, the suspension time will not be less than the
74 time specified by \fIrqtp\fR, as measured by the system clock,
75 \fBCLOCK_REALTIME\fR.
76 .sp
77 .LP
78 The use of the \fBnanosleep()\fR and \fBthrd_sleep()\fR functions has no effect
79 on the action or blockage of any signal.
80 .SH RETURN VALUES
81 If the \fBnanosleep()\fR or \fBthrd_sleep()\fR function returns because the
82 requested time has elapsed, its return value is \fB0\fR.
83 .sp
84 .LP
85 If the \fBnanosleep()\fR function returns because it has been interrupted by a
86 signal, the function returns a value of \(mi1 and sets \fBerrno\fR to indicate
87 the interruption. If the \fIrmtp\fR argument is non-\fINULL\fR, the
88 \fBtimespec\fR structure referenced by it is updated to contain the amount of
89 time remaining in the interval (the requested time minus the time actually
90 slept). If the \fIrmtp\fR argument is \fINULL\fR, the remaining time is not
91 returned.
92 .sp
93 .LP
94 If \fBnanosleep()\fR fails, it returns \fB\(mi1\fR and sets \fBerrno\fR to
95 indicate the error.
96 .sp
97 .LP
98 The
99 .B thrd_sleep()
100 function may fail for identical reasons as the
101 .B nanosleep()
102 function and returns \(mi1; however, the C11 standard does not define that
103 .B errno
104 should be set, therefore callers of \fBthrd_sleep()\fR cannot rely on
105 .B errno
106 being set or staying the same across a call to
107 .B thrd_sleep() .
108
109 .SH ERRORS
110 The \fBnanosleep()\fR function will fail if:
111 .sp
112 .ne 2
113 .na
114 \fB\fBEINTR\fR\fR
115 .ad
116 .RS 10n
117 The \fBnanosleep()\fR function was interrupted by a signal.
118 .RE
119
120 .sp
121 .ne 2
122 .na
123 \fB\fBEINVAL\fR\fR
124 .ad
125 .RS 10n
126 The \fIrqtp\fR argument specified a nanosecond value less than zero or greater
127 than or equal to 1000 million.
128 .RE
129
130 .sp
131 .ne 2
132 .na
133 \fB\fBENOSYS\fR\fR
134 .ad
135 .RS 10n
136 The \fBnanosleep()\fR function is not supported by this implementation.
137 .RE
138
139 .SH ATTRIBUTES
140 See \fBattributes\fR(5) for descriptions of the following attributes:
141 .sp
142
143 .sp
144 .TS
145 box;
146 c | c
147 l | l .
148 ATTRIBUTE TYPE ATTRIBUTE VALUE
149 _
150 Interface Stability Committed
151 _
152 MT-Level MT-Safe
153 _
154 Standard See \fBstandards\fR(5).
155 .TE
156
157 .SH SEE ALSO
158 \fBsleep\fR(3C), \fBtime.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5)
|