boost::upgrade_lock< Mutex > Class Template Reference

#include <lock_types.hpp>

Public Types
typedef Mutex	mutex_type

Public Member Functions
	upgrade_lock () BOOST_NOEXCEPT
	upgrade_lock (Mutex &m_)
	upgrade_lock (Mutex &m_, adopt_lock_t)
	upgrade_lock (Mutex &m_, defer_lock_t) BOOST_NOEXCEPT
	upgrade_lock (Mutex &m_, try_to_lock_t)
	upgrade_lock (BOOST_THREAD_RV_REF_BEG upgrade_lock< Mutex > BOOST_THREAD_RV_REF_END other) BOOST_NOEXCEPT
BOOST_THREAD_EXPLICIT_LOCK_CONVERSION	upgrade_lock (BOOST_THREAD_RV_REF_BEG unique_lock< Mutex > BOOST_THREAD_RV_REF_END other)
upgrade_lock &	operator= (BOOST_THREAD_RV_REF_BEG upgrade_lock< Mutex > BOOST_THREAD_RV_REF_END other)
upgrade_lock &	operator= (BOOST_THREAD_RV_REF_BEG unique_lock< Mutex > BOOST_THREAD_RV_REF_END other)
void	swap (upgrade_lock &other) BOOST_NOEXCEPT
Mutex *	mutex () const BOOST_NOEXCEPT
Mutex *	release () BOOST_NOEXCEPT
	~upgrade_lock ()
void	lock ()
bool	try_lock ()
void	unlock ()
	operator bool () const BOOST_NOEXCEPT
bool	owns_lock () const BOOST_NOEXCEPT

Protected Attributes
Mutex *	m
bool	is_locked

Friends
class	shared_lock< Mutex >
class	unique_lock< Mutex >

Member Typedef Documentation

template<typename Mutex >

typedef Mutex boost::upgrade_lock< Mutex >::mutex_type

Constructor & Destructor Documentation

template<typename Mutex >

boost::upgrade_lock< Mutex >::upgrade_lock ( )

inline

template<typename Mutex >

boost::upgrade_lock< Mutex >::upgrade_lock ( Mutex &  m_ )

inlineexplicit

References boost::upgrade_lock< Mutex >::lock().

template<typename Mutex >

boost::upgrade_lock< Mutex >::upgrade_lock ( Mutex &  m_, adopt_lock_t    )

inline

References BOOST_ASSERT, and boost::is_locked_by_this_thread().

template<typename Mutex >

boost::upgrade_lock< Mutex >::upgrade_lock ( Mutex &  m_, defer_lock_t    )

inline

template<typename Mutex >

boost::upgrade_lock< Mutex >::upgrade_lock ( Mutex &  m_, try_to_lock_t    )

inline

References boost::upgrade_lock< Mutex >::try_lock().

template<typename Mutex >

boost::upgrade_lock< Mutex >::upgrade_lock ( BOOST_THREAD_RV_REF_BEG upgrade_lock< Mutex > BOOST_THREAD_RV_REF_END  other )

inline

References boost::spirit::x3::unicode::other.

template<typename Mutex >

BOOST_THREAD_EXPLICIT_LOCK_CONVERSION boost::upgrade_lock< Mutex >::upgrade_lock ( BOOST_THREAD_RV_REF_BEG unique_lock< Mutex > BOOST_THREAD_RV_REF_END  other )

inline

template<typename Mutex >

boost::upgrade_lock< Mutex >::~upgrade_lock ( )

inline

References boost::upgrade_lock< Mutex >::owns_lock().

Member Function Documentation

template<typename Mutex >

void boost::upgrade_lock< Mutex >::lock ( void  )

inline

References boost::system::errc::operation_not_permitted, boost::upgrade_lock< Mutex >::owns_lock(), boost::system::errc::resource_deadlock_would_occur, and boost::throw_exception().

Referenced by boost::upgrade_lock< Mutex >::upgrade_lock().

template<typename Mutex >

Mutex* boost::upgrade_lock< Mutex >::mutex ( ) const

inline

References boost::upgrade_lock< Mutex >::m.

template<typename Mutex >

boost::upgrade_lock< Mutex >::operator bool ( ) const

inlineexplicit

References boost::upgrade_lock< Mutex >::owns_lock().

template<typename Mutex >

upgrade_lock& boost::upgrade_lock< Mutex >::operator= ( BOOST_THREAD_RV_REF_BEG upgrade_lock< Mutex > BOOST_THREAD_RV_REF_END  other )

inline

References boost::move(), and boost::upgrade_lock< Mutex >::swap().

template<typename Mutex >

upgrade_lock& boost::upgrade_lock< Mutex >::operator= ( BOOST_THREAD_RV_REF_BEG unique_lock< Mutex > BOOST_THREAD_RV_REF_END  other )

inline

References boost::move(), and boost::upgrade_lock< Mutex >::swap().

template<typename Mutex >

bool boost::upgrade_lock< Mutex >::owns_lock ( ) const

inline

References boost::upgrade_lock< Mutex >::is_locked.

Referenced by boost::upgrade_lock< Mutex >::lock(), boost::upgrade_lock< Mutex >::operator bool(), boost::upgrade_lock< Mutex >::try_lock(), boost::upgrade_lock< Mutex >::unlock(), and boost::upgrade_lock< Mutex >::~upgrade_lock().

template<typename Mutex >

Mutex* boost::upgrade_lock< Mutex >::release ( )

inline

References boost::upgrade_lock< Mutex >::m.

template<typename Mutex >

void boost::upgrade_lock< Mutex >::swap ( upgrade_lock< Mutex > &  other )

inline

References boost::spirit::x3::unicode::other, and boost::swap().

Referenced by boost::upgrade_lock< Mutex >::operator=().

template<typename Mutex >

bool boost::upgrade_lock< Mutex >::try_lock ( void  )

inline

References boost::upgrade_lock< Mutex >::is_locked, boost::system::errc::operation_not_permitted, boost::upgrade_lock< Mutex >::owns_lock(), boost::system::errc::resource_deadlock_would_occur, and boost::throw_exception().

Referenced by boost::upgrade_lock< Mutex >::upgrade_lock().

template<typename Mutex >

void boost::upgrade_lock< Mutex >::unlock ( void  )

inline

References boost::system::errc::operation_not_permitted, boost::upgrade_lock< Mutex >::owns_lock(), and boost::throw_exception().

Friends And Related Function Documentation

template<typename Mutex >

friend class shared_lock< Mutex >

friend

template<typename Mutex >

friend class unique_lock< Mutex >

friend

Member Data Documentation

template<typename Mutex >

bool boost::upgrade_lock< Mutex >::is_locked

protected

Referenced by boost::upgrade_lock< Mutex >::owns_lock(), and boost::upgrade_lock< Mutex >::try_lock().

template<typename Mutex >

Mutex* boost::upgrade_lock< Mutex >::m

protected

Referenced by boost::upgrade_lock< Mutex >::mutex(), and boost::upgrade_lock< Mutex >::release().

---

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

• boost_1_57_0/boost/thread/lock_types.hpp