nanosleep(3) Library Functions Manual nanosleep(3)NAME
nanosleep - Suspends a process from execution for the specified timer interval (P1003.1b)
LIBRARY
Realtime Library (librt.so, librt.a)
SYNOPSIS
#include <time.h>
int nanosleep (
const struct timespec *rqtp,
struct timespec *rmtp);
PARAMETERS
*rqtp A pointer to the timespec data structure that defines the time interval during which the calling process is suspended.
*rmtp A pointer to the timespec data structure that receives the amount of time remaining in the previously requested interval, or zero
if the full interval has elapsed.
DESCRIPTION
The nanosleep function suspends a process until one of the following conditions is met:
o The time interval specified in rqtp has elapsed.
o A signal is delivered to the calling process and the action is to deliver a signal to 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 clock resolution,
or due to the scheduling of other activity. Except when it is interrupted by a signal, the suspension time is not less than the time speci-
fied by the rqtp argument (as measured by the system clock).
RETURN VALUES
When the nanosleep function returns because the requested time has elapsed, the call is successful and a value of 0 (zero) is returned.
If the nanosleep function returns because it was interrupted by a signal, a value of -1 is returned. If the rmtp argument is not NULL, the
timespec structure referenced by the call is updated to contain the time remaining in the interval. If the rmtp argument is NULL, the
remaining time is not returned.
On an unsuccessful call, a value of -1 is returned and errno is set to indicate that an error occurred.
ERRORS
The nanosleep function fails under the following conditions:
[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.
RELATED INFORMATION
Functions: sleep(1)
Guide to Realtime Programming delim off
nanosleep(3)
Check Out this Related Man Page
clock_nanosleep(3C) Standard C Library Functions clock_nanosleep(3C)NAME
clock_nanosleep - high resolution sleep with specifiable clock
SYNOPSIS
#include <time.h>
int clock_nanosleep(clockid_t clock_id, int flags,
const struct timespec *rqtp, struct timespec *rmtp);
DESCRIPTION
If the flag TIMER_ABSTIME is not set in the flags argument, the clock_nanosleep() function causes 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 the process is terminated. The clock used to measure the time is the clock specified by
clock_id.
If the flag TIMER_ABSTIME is set in the flags argument, the clock_nanosleep() function causes the current thread to be suspended from exe-
cution until either the time value of the clock specified by clock_id reaches the absolute time specified by the rqtp argument, or a signal
is delivered to the calling thread and its action is to invoke a signal-catching function, or the process is terminated. If, at the time of
the call, the time value specified by rqtp is less than or equal to the time value of the specified clock, then clock_nanosleep() returns
immediately and the calling process is not suspended.
The suspension time caused by this function can 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 sig-
nal, the suspension time for the relative clock_nanosleep() function (that is, with the TIMER_ABSTIME flag not set) will not be less than
the time interval specified by rqtp, as measured by the corresponding clock. The suspension for the absolute clock_nanosleep() function
(that is, with the TIMER_ABSTIME flag set) will be in effect at least until the value of the corresponding clock reaches the absolute time
specified by rqtp, except for the case of being interrupted by a signal.
The use of the clock_nanosleep() function has no effect on the action or blockage of any signal.
The clock_nanosleep() function fails if the clock_id argument refers to the CPU-time clock of the calling thread. It is unspecified if
clock_id values of other CPU-time clocks are allowed.
RETURN VALUES
If the clock_nanosleep() function returns because the requested time has elapsed, its return value is 0.
If the clock_nanosleep() function returns because it has been interrupted by a signal, it returns the corresponding error value. For the
relative clock_nanosleep() function, 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. The absolute clock_nanosleep() function has no effect on the structure referenced by rmtp.
If clock_nanosleep() fails, it shall return the corresponding error value.
ERRORS
The clock_nanosleep() function will fail if:
EINTR The clock_nanosleep() function was interrupted by a signal.
EINVAL The rqtp argument specified a nanosecond value less than zero or greater than or equal to 1,000 million; or the TIMER_ABSTIME
flag was specified in flags and the rqtp argument is outside the range for the clock specified by clock_id; or the clock_id
argument does not specify a known clock, or specifies the CPU-time clock of the calling thread.
ENOTSUP The clock_id argument specifies a clock for which clock_nanosleep() is not supported, such as a CPU-time clock.
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 clock_getres(3C), nanosleep(3C), pthread_cond_timedwait(3C), sleep(3C), attributes(5), standards(5)SunOS 5.11 5 Feb 2008 clock_nanosleep(3C)