thrd_sleep - cppreference.com

##### cppreference.com

##### Search

Create account

##### Namespaces

- Page
- Discussion

##### Variants

##### Views

- View
- Edit
- History

##### Actions

# thrd_sleep

From cppreference.com
< c‎ | thread

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

Blocks the execution of the current thread for at least until the TIME_UTC based time point pointed to by `time_point` has been reached.

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`.

### [edit] Parameters

time_point | - | pointer to the time point to sleep until
remaining | - | pointer to the object to put the remaining time on interruption. May be NULL, in which case it is ignored

### [edit] Return value

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

### [edit] Notes

`time_point` 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

### [edit] 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

### [edit] References

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

  - 7.26.5.7 The thrd_sleep function (p: 385)

### [edit] See also

thrd_yield (C11) | yields the current time slice (function) [edit]
C++ documentation for sleep_until

Retrieved from "http://en.cppreference.com/mwiki/index.php?title=c/thread/thrd_sleep&oldid=90294"