Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::null_mutex Class Reference

Implements a mutex that simulates a mutex without doing any operation and simulates a successful operation. More...

#include <null_mutex.hpp>

Public Member Functions

 BOOST_THREAD_NO_COPYABLE (null_mutex) null_mutex()
 
void lock ()
 Simulates a mutex lock() operation. Empty function. More...
 
bool try_lock ()
 Simulates a mutex try_lock() operation. More...
 
void unlock ()
 Simulates a mutex unlock() operation. More...
 
void lock_shared ()
 Simulates a mutex lock_shared() operation. More...
 
bool try_lock_shared ()
 Simulates a mutex try_lock_shared() operation. More...
 
void unlock_shared ()
 Simulates a mutex unlock_shared() operation. More...
 
template<typename Clock , typename Duration >
bool try_lock_shared_until (chrono::time_point< Clock, Duration > const &)
 Simulates a mutex try_lock_shared_until() operation. More...
 
template<typename Rep , typename Period >
bool try_lock_shared_for (chrono::duration< Rep, Period > const &)
 Simulates a mutex try_lock_shared_for() operation. More...
 
void lock_upgrade ()
 Simulates a mutex lock_upgrade() operation. More...
 
bool try_lock_upgrade ()
 Simulates a mutex try_lock_upgrade() operation. More...
 
void unlock_upgrade ()
 Simulates a mutex unlock_upgrade() operation. More...
 
template<typename Clock , typename Duration >
bool try_lock_upgrade_until (chrono::time_point< Clock, Duration > const &)
 Simulates a mutex try_lock_upgrade_until() operation. More...
 
template<typename Rep , typename Period >
bool try_lock_upgrade_for (chrono::duration< Rep, Period > const &)
 Simulates a mutex try_lock_upgrade_for() operation. More...
 
bool try_unlock_shared_and_lock ()
 Simulates a mutex try_unlock_shared_and_lock() operation. More...
 
void unlock_and_lock_shared ()
 Simulates unlock_and_lock_shared(). More...
 
bool try_unlock_shared_and_lock_upgrade ()
 Simulates a mutex try_unlock_shared_and_lock_upgrade() operation. More...
 
void unlock_and_lock_upgrade ()
 Simulates unlock_and_lock_upgrade(). More...
 
void unlock_upgrade_and_lock ()
 Simulates unlock_upgrade_and_lock(). More...
 
bool try_unlock_upgrade_and_lock ()
 Simulates a mutex try_unlock_upgrade_and_lock() operation. More...
 
void unlock_upgrade_and_lock_shared ()
 Simulates unlock_upgrade_and_lock_shared(). More...
 

Detailed Description

Implements a mutex that simulates a mutex without doing any operation and simulates a successful operation.

Member Function Documentation

boost::null_mutex::BOOST_THREAD_NO_COPYABLE ( null_mutex  )
inline
void boost::null_mutex::lock ( void  )
inline

Simulates a mutex lock() operation. Empty function.

void boost::null_mutex::lock_shared ( )
inline

Simulates a mutex lock_shared() operation.

Empty function.

void boost::null_mutex::lock_upgrade ( )
inline

Simulates a mutex lock_upgrade() operation.

Empty function.

bool boost::null_mutex::try_lock ( void  )
inline

Simulates a mutex try_lock() operation.

Equivalent to "return true;"

bool boost::null_mutex::try_lock_shared ( )
inline

Simulates a mutex try_lock_shared() operation.

Equivalent to "return true;"

template<typename Rep , typename Period >
bool boost::null_mutex::try_lock_shared_for ( chrono::duration< Rep, Period > const &  )
inline

Simulates a mutex try_lock_shared_for() operation.

Equivalent to "return true;"

template<typename Clock , typename Duration >
bool boost::null_mutex::try_lock_shared_until ( chrono::time_point< Clock, Duration > const &  )
inline

Simulates a mutex try_lock_shared_until() operation.

Equivalent to "return true;"

bool boost::null_mutex::try_lock_upgrade ( )
inline

Simulates a mutex try_lock_upgrade() operation.

Equivalent to "return true;"

template<typename Rep , typename Period >
bool boost::null_mutex::try_lock_upgrade_for ( chrono::duration< Rep, Period > const &  )
inline

Simulates a mutex try_lock_upgrade_for() operation.

Equivalent to "return true;"

template<typename Clock , typename Duration >
bool boost::null_mutex::try_lock_upgrade_until ( chrono::time_point< Clock, Duration > const &  )
inline

Simulates a mutex try_lock_upgrade_until() operation.

Equivalent to "return true;"

bool boost::null_mutex::try_unlock_shared_and_lock ( )
inline

Simulates a mutex try_unlock_shared_and_lock() operation.

Equivalent to "return true;"

bool boost::null_mutex::try_unlock_shared_and_lock_upgrade ( )
inline

Simulates a mutex try_unlock_shared_and_lock_upgrade() operation.

Equivalent to "return true;"

bool boost::null_mutex::try_unlock_upgrade_and_lock ( )
inline

Simulates a mutex try_unlock_upgrade_and_lock() operation.

Equivalent to "return true;"

void boost::null_mutex::unlock ( void  )
inline

Simulates a mutex unlock() operation.

Empty function.

void boost::null_mutex::unlock_and_lock_shared ( )
inline

Simulates unlock_and_lock_shared().

Empty function.

void boost::null_mutex::unlock_and_lock_upgrade ( )
inline

Simulates unlock_and_lock_upgrade().

Empty function.

void boost::null_mutex::unlock_shared ( )
inline

Simulates a mutex unlock_shared() operation.

Empty function.

void boost::null_mutex::unlock_upgrade ( )
inline

Simulates a mutex unlock_upgrade() operation.

Empty function.

void boost::null_mutex::unlock_upgrade_and_lock ( )
inline

Simulates unlock_upgrade_and_lock().

Empty function.

void boost::null_mutex::unlock_upgrade_and_lock_shared ( )
inline

Simulates unlock_upgrade_and_lock_shared().

Empty function.


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