std::counting_semaphore<LeastMaxValue>::try_acquire_for

From cppreference.com
 
C++
 
Concurrency support library
Threads
(C++11)
(C++20)
(C++20)
(C++20)
(C++20)
(C++17)(C++17)    
this_thread namespace
(C++11)
(C++11)
(C++11)
(C++11)
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)
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++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)
Memory ordering
(C++11)
(C++11)
(C++11)
(C++11)
Mutual exclusion
(C++11)
(C++11)
(C++17)
Generic lock management
(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)
(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)
 
std::counting_semaphore
 
template<class Rep, class Period>
bool try_acquire_for( const std::chrono::duration<Rep, Period>& rel_time );
 (since C++20)

Tries to atomically decrement the internal counter by 1 if it is greater than ​0​; otherwise blocks until it is greater than ​0​ and can successfully decrement the internal counter, or the rel_time duration has been exceeded.

Preconditions

(none)

Parameters

rel_time - the minimum duration the function must wait for to fail

Return value

true if it decremented the internal counter, otherwise false

Exceptions

May throw std::system_error or a timeout-related exception.

Notes

In practice the function may take longer than rel_time to fail.

Implementations are allowed to fail to decrement the counter even if it was greater than ​0​ - i.e., they are allowed to spuriously fail and return false.

Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/thread/counting_semaphore/try_acquire_for&oldid=119408"