Wraps a interprocess_upgradable_mutex that can be placed in shared memory and can be shared between processes. More...

#include <interprocess_upgradable_mutex.hpp>

Public Member Functions
	interprocess_upgradable_mutex ()
	Constructs the upgradable lock. More...

	~interprocess_upgradable_mutex ()
	Destroys the upgradable lock. More...

void	lock ()
	Effects: The calling thread tries to obtain exclusive ownership of the mutex, and if another thread has exclusive, sharable or upgradable ownership of the mutex, it waits until it can obtain the ownership. More...

bool	try_lock ()
	Effects: The calling thread tries to acquire exclusive ownership of the mutex without waiting. More...

bool	timed_lock (const boost::posix_time::ptime &abs_time)
	Effects: The calling thread tries to acquire exclusive ownership of the mutex waiting if necessary until no other thread has exclusive, sharable or upgradable ownership of the mutex or abs_time is reached. More...

void	unlock ()
	Precondition: The thread must have exclusive ownership of the mutex. More...

void	lock_sharable ()
	Effects: The calling thread tries to obtain sharable ownership of the mutex, and if another thread has exclusive ownership of the mutex, waits until it can obtain the ownership. More...

bool	try_lock_sharable ()
	Effects: The calling thread tries to acquire sharable ownership of the mutex without waiting. More...

bool	timed_lock_sharable (const boost::posix_time::ptime &abs_time)
	Effects: The calling thread tries to acquire sharable ownership of the mutex waiting if necessary until no other thread has exclusive ownership of the mutex or abs_time is reached. More...

void	unlock_sharable ()
	Precondition: The thread must have sharable ownership of the mutex. More...

void	lock_upgradable ()
	Effects: The calling thread tries to obtain upgradable ownership of the mutex, and if another thread has exclusive or upgradable ownership of the mutex, waits until it can obtain the ownership. More...

bool	try_lock_upgradable ()
	Effects: The calling thread tries to acquire upgradable ownership of the mutex without waiting. More...

bool	timed_lock_upgradable (const boost::posix_time::ptime &abs_time)
	Effects: The calling thread tries to acquire upgradable ownership of the mutex waiting if necessary until no other thread has exclusive or upgradable ownership of the mutex or abs_time is reached. More...

void	unlock_upgradable ()
	Precondition: The thread must have upgradable ownership of the mutex. More...

void	unlock_and_lock_upgradable ()
	Precondition: The thread must have exclusive ownership of the mutex. More...

void	unlock_and_lock_sharable ()
	Precondition: The thread must have exclusive ownership of the mutex. More...

void	unlock_upgradable_and_lock_sharable ()
	Precondition: The thread must have upgradable ownership of the mutex. More...

void	unlock_upgradable_and_lock ()
	Precondition: The thread must have upgradable ownership of the mutex. More...

bool	try_unlock_upgradable_and_lock ()
	Precondition: The thread must have upgradable ownership of the mutex. More...

*bool	timed_unlock_upgradable_and_lock (const boost::posix_time::ptime &abs_time)
	Precondition: The thread must have upgradable ownership of the mutex. More...

bool	try_unlock_sharable_and_lock ()
	Precondition: The thread must have sharable ownership of the mutex. More...

bool	try_unlock_sharable_and_lock_upgradable ()
	Precondition: The thread must have sharable ownership of the mutex. More...

Friends
class	interprocess_condition

Detailed Description

Wraps a interprocess_upgradable_mutex that can be placed in shared memory and can be shared between processes.

Allows timed lock tries

Constructor & Destructor Documentation

boost::interprocess::interprocess_upgradable_mutex::interprocess_upgradable_mutex ( )

inline

Constructs the upgradable lock.

Throws interprocess_exception on error.

boost::interprocess::interprocess_upgradable_mutex::~interprocess_upgradable_mutex ( )

inline

Destroys the upgradable lock.

Does not throw.

Member Function Documentation

void boost::interprocess::interprocess_upgradable_mutex::lock ( )

inline

Effects: The calling thread tries to obtain exclusive ownership of the mutex, and if another thread has exclusive, sharable or upgradable ownership of the mutex, it waits until it can obtain the ownership.

Throws: interprocess_exception on error.

References boost::multiprecision::backends::this, and boost::interprocess::interprocess_condition::wait().

void boost::interprocess::interprocess_upgradable_mutex::lock_sharable ( )

inline

Effects: The calling thread tries to obtain sharable ownership of the mutex, and if another thread has exclusive ownership of the mutex, waits until it can obtain the ownership.

Throws: interprocess_exception on error.

References boost::multiprecision::backends::this, and boost::interprocess::interprocess_condition::wait().

void boost::interprocess::interprocess_upgradable_mutex::lock_upgradable ( )

inline

Effects: The calling thread tries to obtain upgradable ownership of the mutex, and if another thread has exclusive or upgradable ownership of the mutex, waits until it can obtain the ownership.

Throws: interprocess_exception on error.

References boost::multiprecision::backends::this, and boost::interprocess::interprocess_condition::wait().

bool boost::interprocess::interprocess_upgradable_mutex::timed_lock ( const boost::posix_time::ptime & abs_time )

inline

Effects: The calling thread tries to acquire exclusive ownership of the mutex waiting if necessary until no other thread has exclusive, sharable or upgradable ownership of the mutex or abs_time is reached.

Returns: If acquires exclusive ownership, returns true. Otherwise returns false. Throws: interprocess_exception on error.

References boost::interprocess::scoped_lock< Mutex >::owns(), boost::multiprecision::backends::this, and boost::interprocess::interprocess_condition::timed_wait().

bool boost::interprocess::interprocess_upgradable_mutex::timed_lock_sharable ( const boost::posix_time::ptime & abs_time )

inline

Effects: The calling thread tries to acquire sharable ownership of the mutex waiting if necessary until no other thread has exclusive ownership of the mutex or abs_time is reached.

Returns: If acquires sharable ownership, returns true. Otherwise returns false. Throws: interprocess_exception on error.

References boost::interprocess::scoped_lock< Mutex >::owns(), boost::multiprecision::backends::this, and boost::interprocess::interprocess_condition::timed_wait().

bool boost::interprocess::interprocess_upgradable_mutex::timed_lock_upgradable ( const boost::posix_time::ptime & abs_time )

inline

Effects: The calling thread tries to acquire upgradable ownership of the mutex waiting if necessary until no other thread has exclusive or upgradable ownership of the mutex or abs_time is reached.

Returns: If acquires upgradable ownership, returns true. Otherwise returns false. Throws: interprocess_exception on error.

References boost::interprocess::scoped_lock< Mutex >::owns(), boost::multiprecision::backends::this, and boost::interprocess::interprocess_condition::timed_wait().

bool boost::interprocess::interprocess_upgradable_mutex::timed_unlock_upgradable_and_lock ( const boost::posix_time::ptime & abs_time )

inline

Precondition: The thread must have upgradable ownership of the mutex.

Effects: The thread atomically releases upgradable ownership and tries to acquire exclusive ownership, waiting if necessary until abs_time. This operation will fail if there are threads with sharable ownership or timeout reaches, but it will maintain upgradable ownership. Returns: If acquires exclusive ownership, returns true. Otherwise returns false. Throws: An exception derived from interprocess_exception on error.

References boost::interprocess::scoped_lock< Mutex >::owns(), and boost::interprocess::interprocess_condition::timed_wait().

bool boost::interprocess::interprocess_upgradable_mutex::try_lock ( )

inline

Effects: The calling thread tries to acquire exclusive ownership of the mutex without waiting.

If no other thread has exclusive, sharable or upgradable ownership of the mutex this succeeds. Returns: If it can acquire exclusive ownership immediately returns true. If it has to wait, returns false. Throws: interprocess_exception on error.

References boost::interprocess::scoped_lock< Mutex >::owns(), and boost::try_to_lock.

bool boost::interprocess::interprocess_upgradable_mutex::try_lock_sharable ( )

inline

Effects: The calling thread tries to acquire sharable ownership of the mutex without waiting.

If no other thread has exclusive ownership of the mutex this succeeds. Returns: If it can acquire sharable ownership immediately returns true. If it has to wait, returns false. Throws: interprocess_exception on error.

References boost::interprocess::scoped_lock< Mutex >::owns(), and boost::try_to_lock.

bool boost::interprocess::interprocess_upgradable_mutex::try_lock_upgradable ( )

inline

Effects: The calling thread tries to acquire upgradable ownership of the mutex without waiting.

If no other thread has exclusive or upgradable ownership of the mutex this succeeds. Returns: If it can acquire upgradable ownership immediately returns true. If it has to wait, returns false. Throws: interprocess_exception on error.

References boost::interprocess::scoped_lock< Mutex >::owns(), and boost::try_to_lock.

bool boost::interprocess::interprocess_upgradable_mutex::try_unlock_sharable_and_lock ( )

inline

Precondition: The thread must have sharable ownership of the mutex.

Effects: The thread atomically releases sharable ownership and tries to acquire exclusive ownership. This operation will fail if there are threads with sharable or upgradable ownership, but it will maintain sharable ownership. Returns: If acquires exclusive ownership, returns true. Otherwise returns false. Throws: An exception derived from interprocess_exception on error.

References boost::interprocess::scoped_lock< Mutex >::owns(), and boost::try_to_lock.

bool boost::interprocess::interprocess_upgradable_mutex::try_unlock_sharable_and_lock_upgradable ( )

inline

Precondition: The thread must have sharable ownership of the mutex.

Effects: The thread atomically releases sharable ownership and tries to acquire upgradable ownership. This operation will fail if there are threads with sharable or upgradable ownership, but it will maintain sharable ownership. Returns: If acquires upgradable ownership, returns true. Otherwise returns false. Throws: An exception derived from interprocess_exception on error.

References boost::interprocess::scoped_lock< Mutex >::owns(), and boost::try_to_lock.

bool boost::interprocess::interprocess_upgradable_mutex::try_unlock_upgradable_and_lock ( )

inline

Precondition: The thread must have upgradable ownership of the mutex.

Effects: The thread atomically releases upgradable ownership and tries to acquire exclusive ownership. This operation will fail if there are threads with sharable ownership, but it will maintain upgradable ownership. Returns: If acquires exclusive ownership, returns true. Otherwise returns false. Throws: An exception derived from interprocess_exception on error.

References boost::interprocess::scoped_lock< Mutex >::owns(), and boost::try_to_lock.

void boost::interprocess::interprocess_upgradable_mutex::unlock ( )

inline

Precondition: The thread must have exclusive ownership of the mutex.

Effects: The calling thread releases the exclusive ownership of the mutex. Throws: An exception derived from interprocess_exception on error.

References boost::interprocess::interprocess_condition::notify_all().

void boost::interprocess::interprocess_upgradable_mutex::unlock_and_lock_sharable ( )

inline

Precondition: The thread must have exclusive ownership of the mutex.

Effects: The thread atomically releases exclusive ownership and acquires sharable ownership. This operation is non-blocking. Throws: An exception derived from interprocess_exception on error.

References boost::interprocess::interprocess_condition::notify_all().

void boost::interprocess::interprocess_upgradable_mutex::unlock_and_lock_upgradable ( )

inline

Precondition: The thread must have exclusive ownership of the mutex.

Effects: The thread atomically releases exclusive ownership and acquires upgradable ownership. This operation is non-blocking. Throws: An exception derived from interprocess_exception on error.

References boost::interprocess::interprocess_condition::notify_all().

void boost::interprocess::interprocess_upgradable_mutex::unlock_sharable ( )

inline

Precondition: The thread must have sharable ownership of the mutex.

Effects: The calling thread releases the sharable ownership of the mutex. Throws: An exception derived from interprocess_exception on error.

References boost::interprocess::interprocess_condition::notify_all(), and boost::interprocess::interprocess_condition::notify_one().

void boost::interprocess::interprocess_upgradable_mutex::unlock_upgradable ( )

inline

Precondition: The thread must have upgradable ownership of the mutex.

Effects: The calling thread releases the upgradable ownership of the mutex. Throws: An exception derived from interprocess_exception on error.

References boost::interprocess::interprocess_condition::notify_all().

void boost::interprocess::interprocess_upgradable_mutex::unlock_upgradable_and_lock ( )

inline

Precondition: The thread must have upgradable ownership of the mutex.

Effects: The thread atomically releases upgradable ownership and acquires exclusive ownership. This operation will block until all threads with sharable ownership release their sharable lock. Throws: An exception derived from interprocess_exception on error.

References boost::interprocess::interprocess_condition::wait().

void boost::interprocess::interprocess_upgradable_mutex::unlock_upgradable_and_lock_sharable ( )

inline

Precondition: The thread must have upgradable ownership of the mutex.

Effects: The thread atomically releases upgradable ownership and acquires sharable ownership. This operation is non-blocking. Throws: An exception derived from interprocess_exception on error.

References boost::interprocess::interprocess_condition::notify_all().

Friends And Related Function Documentation

friend class interprocess_condition

friend

The documentation for this class was generated from the following file:

boost_1_57_0/boost/interprocess/sync/interprocess_upgradable_mutex.hpp

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation