std::unique_lock::try_lock_for - cppreference.com

##### cppreference.com

##### Search

Create account

##### Namespaces

- Page
- Discussion

##### Variants

##### Views

- View
- Edit
- History

##### Actions

# std::unique_lock::try_lock_for

From cppreference.com
< cpp‎ | thread‎ | unique lock

template< class Rep, class Period > bool try_lock_for( const std::chrono::duration<Rep,Period>& timeout_duration ); |  | (since C++11)

Tries to lock the associated mutex. Blocks until specified `timeout_duration` has elapsed or the lock is acquired, whichever comes first. On successful lock acquisition returns true, otherwise returns false. Effectively calls mutex()->try_lock_for(timeout_duration).

A steady clock is used to measure the duration. This function may block for longer than `timeout_duration` due to scheduling or resource contention delays.

std::system_error is thrown if there is no associated mutex or if the mutex is already locked.

### [edit] Parameters

timeout_duration | - | maximum duration to block for

### [edit] Return value

true if the ownership of the mutex has been acquired successfully, false otherwise.

### [edit] Exceptions

- Any exceptions thrown by mutex()->try_lock_for(timeout_duration)

- If there is no associated mutex, std::system_error with an error code of std::errc::operation_not_permitted

- If the mutex is already locked, std::system_error with an error code of std::errc::resource_deadlock_would_occur

### [edit] Example

| This section is incomplete Reason: no example

### [edit] See also

lock | locks the associated mutex (public member function) [edit]
try_lock | tries to lock the associated mutex, returns if the mutex is not available (public member function) [edit]
try_lock_until | tries to lock the associated `TimedLockable` mutex, returns if the mutex has been unavailable until specified time point has been reached (public member function) [edit]
unlock | unlocks the associated mutex (public member function) [edit]

Retrieved from "http://en.cppreference.com/mwiki/index.php?title=cpp/thread/unique_lock/try_lock_for&oldid=62995"
Category:

- Todo no example