Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/thread/sleep for"

From cppreference.com
< cpp‎ | thread
(spacing)
m ({{c}}, headers sorted)
 
(34 intermediate revisions by 17 users not shown)
Line 1: Line 1:
 
{{cpp/title|n=this_thread::|sleep_for}}
 
{{cpp/title|n=this_thread::|sleep_for}}
 
{{cpp/thread/navbar}}
 
{{cpp/thread/navbar}}
−
{{ddcl | header=thread | notes={{mark since c++11}} | 1=
+
{{ddcl|header=thread|since=c++11|1=
 
template< class Rep, class Period >
 
template< class Rep, class Period >
−
void sleep_for( std::chrono::duration<Rep,Period> sleep_duration );
+
void sleep_for( const std::chrono::duration<Rep, Period>& sleep_duration );
 
}}
 
}}
  
−
Blocks the execution of the current thread for specified {{tt|sleep_duration}}. May block for longer than {{tt|sleep_duration}}.
+
Blocks the execution of the current thread for ''at least'' the specified {{c|sleep_duration}}.
 +
 
 +
This function may block for longer than {{c|sleep_duration}} due to scheduling or resource contention delays.
 +
 
 +
The standard recommends that a steady clock is used to measure the duration. If an implementation uses a system clock instead, the wait time may also be sensitive to clock adjustments.
  
 
===Parameters===
 
===Parameters===
−
{{param list begin}}
+
{{par begin}}
−
{{param list item | sleep_duration | time duration to sleep}}
+
{{par|sleep_duration|time duration to sleep}}
−
{{param list end}}
+
{{par end}}
  
 
===Return value===
 
===Return value===
Line 17: Line 21:
  
 
===Exceptions===
 
===Exceptions===
−
{{noexcept}}
+
Any exception thrown by {{tt|clock}}, {{tt|time_point}}, or {{tt|duration}} during the execution (clocks, time points, and durations provided by the standard library never throw).
  
 
===Example===
 
===Example===
−
{{example|
+
{{example
−
| code=
+
|code=
−
#include <iostream>
+
 
#include <chrono>
 
#include <chrono>
 +
#include <iostream>
 
#include <thread>
 
#include <thread>
−
 
+
 
int main()
 
int main()
 
{
 
{
−
     std::cout << "Hello waiter" << std::endl;
+
    using namespace std::chrono_literals;
−
     std::chrono::milliseconds dura( 2000 );
+
 
−
     std::this_thread::sleep_for( dura );
+
     std::cout << "Hello waiter\n" << std::flush;
−
     std::cout << "Waited 2000 ms\n";
+
 
 +
     const auto start = std::chrono::high_resolution_clock::now();
 +
     std::this_thread::sleep_for(2000ms);
 +
    const auto end = std::chrono::high_resolution_clock::now();
 +
    const std::chrono::duration<double, std::milli> elapsed = end - start;
 +
 
 +
     std::cout << "Waited " << elapsed << '\n';
 
}
 
}
−
| output=
+
|p=true
 +
|output=
 
Hello waiter
 
Hello waiter
−
Waited 2000 ms
+
Waited 2000.13 ms
 
}}
 
}}
  
 
===See also===
 
===See also===
−
{{dcl list begin}}
+
{{dsc begin}}
−
{{dcl list template | cpp/thread/dcl list sleep_until}}
+
{{dsc inc|cpp/thread/dsc sleep_until}}
−
{{dcl list end}}
+
{{dsc end}}
 +
 
 +
{{langlinks|de|es|fr|it|ja|pt|ru|zh}}

Latest revision as of 10:26, 23 October 2023

 
C++
 
Concurrency support library
Threads
(C++11)
(C++20)
(C++17)(C++17)
this_thread namespace
(C++11)
(C++11)
sleep_for
(C++11)
(C++11)
Cooperative cancellation
Mutual exclusion
(C++11)
(C++11)
(C++17)
Generic lock management
(C++11)
(C++11)
(C++17)
(C++11)
(C++14)
(C++11)
(C++11)
(C++11)
(C++11)(C++11)(C++11)(C++11)(C++11)(C++11)
Condition variables
(C++11)
(C++11)
(C++11)
(C++11)
Semaphores
(C++20)(C++20)
Latches and Barriers
(C++20)
(C++20)
Futures
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
Safe Reclamation
(C++26)
(C++26)
(C++26)
Hazard Pointers
(C++26)
(C++26)
(C++26)
Atomic types
(C++11)
(C++20)
(C++11)
Initialization of atomic types
(C++11)(deprecated in C++20)
(C++11)(deprecated in C++20)
(C++11)
Memory ordering
(C++11)
(C++11)
(C++11)
(C++11)
Free functions for atomic operations
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++26)(C++26)
(C++26)(C++26)
(C++11)
(C++20)(C++20)
(C++20)
(C++20)
Free functions for atomic flags
(C++11)(C++11)
(C++11)(C++11)
(C++20)(C++20)
(C++20)(C++20)
(C++20)
(C++20)
 
Defined in header <thread>
template< class Rep, class Period >
void sleep_for( const std::chrono::duration<Rep, Period>& sleep_duration );
 (since C++11)

Blocks the execution of the current thread for at least the specified sleep_duration.

This function may block for longer than sleep_duration due to scheduling or resource contention delays.

The standard recommends that a steady clock is used to measure the duration. If an implementation uses a system clock instead, the wait time may also be sensitive to clock adjustments.

Contents

[edit] Parameters

sleep_duration - time duration to sleep

[edit] Return value

(none)

[edit] Exceptions

Any exception thrown by clock, time_point, or duration during the execution (clocks, time points, and durations provided by the standard library never throw).

[edit] Example

Run this code
#include <chrono>
#include <iostream>
#include <thread>
 
int main()
{
    using namespace std::chrono_literals;
 
    std::cout << "Hello waiter\n" << std::flush;
 
    const auto start = std::chrono::high_resolution_clock::now();
    std::this_thread::sleep_for(2000ms);
    const auto end = std::chrono::high_resolution_clock::now();
    const std::chrono::duration<double, std::milli> elapsed = end - start;
 
    std::cout << "Waited " << elapsed << '\n';
}

Possible output: 

Hello waiter
Waited 2000.13 ms

[edit] See also

(C++11)
 stops the execution of the current thread until a specified time point
(function) [edit]
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/thread/sleep_for&oldid=161242"