thrd_sleep

 

C

Language

Headers

Type support

Program utilities

Variadic function support

Error handling

Dynamic memory management

Date and time utilities

Strings library

Algorithms

Numerics

Input/output support

Localization support

Atomic operations (C11)

Thread support (C11)

Technical Specifications

 

Thread support library

Threads
thrd_create thrd_equal thrd_current thrd_sleep thrd_yield thrd_exit	thrd_detach thrd_join thrd_successthrd_timedoutthrd_busythrd_nomemthrd_error
Mutual exclusion
mtx_init mtx_lock mtx_timedlock mtx_trylock call_once	mtx_unlock mtx_destroy mtx_plainmtx_recursivemtx_timed
Condition variables
cnd_init cnd_signal cnd_broadcast	cnd_wait cnd_timedwait cnd_destroy
Thread-local storage
thread_local TSS_DTOR_ITERATIONS tss_create	tss_get tss_set tss_delete

 

Defined in header <threads.h>
int thrd_sleep( const struct timespec* duration,                 struct timespec* remaining );		(since C11)

Blocks the execution of the current thread for at least until the TIME_UTC based duration pointed to by duration has elapsed.

The sleep may resume earlier if a signal that is not ignored is received. In such case, if remaining is not NULL, the remaining time duration is stored into the object pointed to by remaining.

Parameters

duration	-	pointer to the duration to sleep for
remaining	-	pointer to the object to put the remaining time on interruption. May be NULL, in which case it is ignored

Return value

​0​ on successful sleep, -1 if a signal occurred, other negative value if an error occurred.

Notes

duration and remaining may point at the same object, which simplifies re-running the function after a signal.

The actual sleep time may be longer than requested because it is rounded up to the timer granularity and because of scheduling and context switching overhead.

The POSIX equivalent of this function is nanosleep

Example

Run this code

#include <threads.h>
#include <time.h>
#include <stdio.h>
 
int main(void)
{
    printf("Time: %s", ctime(&(time_t){time(NULL)}));
    thrd_sleep(&(struct timespec){.tv_sec=1}, NULL); // sleep 1 sec
    printf("Time: %s", ctime(&(time_t){time(NULL)}));
}

Output:

Time: Mon Feb  2 16:18:41 2015
Time: Mon Feb  2 16:18:42 2015

References

• C11 standard (ISO/IEC 9899:2011):

• 7.26.5.7 The thrd_sleep function (p: 385)

See also

thrd_yield (C11)	yields the current time slice (function)
C++ documentation for sleep_for