std::shared...y_lock_until(3)

💅 std::shared...y_lock_until(3) 💅

okay so welcome to the C++ Standard Libary manual, bestie — yes, "Libary" is exactly how it's spelled here, and we are not fixing it. This page is all about std::shared_timed_mutex::try_lock_until, and it's giving deadline energy fr fr.

---

🌸 NAME 🌸

• std::shared_timed_mutex::try_lock_until — std::shared_timed_mutex::try_lock_until, bestie. That's the member function, that's the whole name section, periodt.

---

✨ Synopsis ✨

Here's the synopsis as it shows up on the page, line breaks and all:

template< class Clock, class Duration >
bool try_lock_until( const std::chrono::time_point<Clock, Duration>&
(since C++14)
timeout_time );

Okay so what does it actually do? It tries to lock the mutex. It blocks until the specified timeout_time has been reached (that's the timeout) or the lock is acquired (meaning it owns the mutex), whichever comes first. On successful lock acquisition it returns true, otherwise it returns false.

If timeout_time has already passed, this function behaves like try_lock().

Clock must meet the Clock requirements. The program is ill-formed if std::chrono::is_clock_v<Clock> is false. (since C++20)

The standard recommends that the clock tied to timeout_time be used, in which case adjustments of the clock may be taken into account. Thus, the duration of the block might be more or less than timeout_time - Clock::now() at the time of the call, depending on the direction of the adjustment and whether it is honored by the implementation. The function also may block until after timeout_time has been reached due to process scheduling or resource contention delays. Scheduling really said "I'll do what I want" 😭.

As with try_lock(), this function is allowed to fail spuriously and return false even if the mutex was not locked by any other thread at some point before timeout_time. So a false does not always mean someone else had it, bestie.

Prior unlock() operation on the same mutex synchronizes-with (as defined in std::memory_order) this operation if it returns true.

If try_lock_until is called by a thread that already owns the mutex in any mode (shared or exclusive), the behavior is undefined. That's the danger zone, bestie — do not do that.

---

🫶 Parameters 🫶

• timeout_time — maximum time point to block until.

---

💖 Return value 💖

• true if the lock was acquired successfully, otherwise false.

---

😭 Exceptions 😭

Any exception thrown by timeout_time (clocks, time points, and durations provided by the standard library never throw). That's the whole exception story, ngl.

---

🎀 Example 🎀

This section is incomplete Reason: no example

---

👑 See also 👑

• lock — locks the mutex, blocks if the mutex is not available (public member function).
• try_lock — tries to lock the mutex, returns if the mutex is not available (public member function).
• try_lock_for — tries to lock the mutex, returns if the mutex has been unavailable for the specified timeout duration (public member function).
• unlock — unlocks the mutex (public member function).
• C documentation for mtx_timedlock.

---

🧚 Category 🧚

• * Todo no example — yeah, that's the category tag. The page is filed under Todo no example.

---

okay bye bestie, stay locked and loaded 💖 source: http://cppreference.com • date/version: 2024.06.10