Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
std::unique..._lock_until(3)  C++ Standard Libary std::unique..._lock_until(3)

NAME
       std::unique_lock::try_lock_until	- std::unique_lock::try_lock_until

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

	  Tries	 to  lock  (i.e.,  takes  ownership  of) the associated	mutex.
       Blocks until
	  specified timeout_time has been reached or  the  lock	 is  acquired,
       whichever comes
	  first.  On  successful  lock acquisition returns true, otherwise re-
       turns false. May
	  block	for longer than	timeout_time until has been reached.

	  Effectively calls mutex()->try_lock_until(timeout_time).

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

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

Parameters
	  timeout_time - maximum time point to block until

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

Exceptions
	    * Any exceptions thrown by mutex()->try_lock_until(timeout_time).
	    * 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.

Example
	   This	section	is incomplete
	   Reason: no example

See also
	  lock	       locks (i.e., takes ownership of)	the associated mutex
		       (public member function)
		       tries to	lock (i.e., takes ownership of)	the associated
       mutex without
	  try_lock     blocking
		       (public member function)
		       attempts	to lock	(i.e., takes ownership of) the associ-
       ated
	  try_lock_for TimedLockable mutex, returns if the mutex has been  un-
       available for the
		       specified time duration
		       (public member function)
	  unlock	unlocks	 (i.e.,	 releases ownership of)	the associated
       mutex
		       (public member function)

Category:
	    * Todo no example

http://cppreference.com		  2024.06.10	  std::unique..._lock_until(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=std::unique_lock::try_lock_until&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help