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

FreeBSD Manual Pages

  
 
  

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

NAME
       std::shared_lock::try_lock_until	- std::shared_lock::try_lock_until

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

	  Tries	to lock	the associated mutex  in  shared  mode.	 Blocks	 until
       specified
	  timeout_time	has  been  reached  or the lock	is acquired, whichever
       comes first. On
	  successful lock acquisition returns true, otherwise  returns	false.
       May block for
	  longer than until timeout_time has been reached.

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

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

	  Clock	must meet the Clock requirements. The behavior is undefined if
       Mutex does not
	  meet the SharedTimedLockable 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_shared_for(time-
       out_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 the associated mutex
			 (public member	function)
	  try_lock	 tries to lock the associated mutex
			 (public member	function)
	  try_lock_for	 tries to lock the associated mutex, for the specified
       duration
			 (public member	function)
	  unlock	 unlocks the associated	mutex
			 (public member	function)
			 tries to lock (i.e., takes ownership of) the  associ-
       ated TimedLockable
	  try_lock_until  mutex, returns if the	mutex has been unavailable un-
       til specified time
			 point has been	reached
			 (public member	function of std::unique_lock<Mutex>)

http://cppreference.com		  2022.07.31	  std::shared..._lock_until(3)

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

home | help