include/corelib/ncbimtx.hpp File Reference

---

Detailed Description

Multi-threading -- mutexes; rw-locks; semaphore.

MUTEX:

MUTEX CLASSES:

• SSystemFastMutex -- platform-dependent mutex functionality
• SSystemMutex -- platform-dependent mutex functionality
• CFastMutex -- simple mutex with fast lock/unlock functions
• CMutex -- mutex that allows nesting (with runtime checks)
• CFastMutexGuard -- acquire fast mutex, then guarantee for its release
• CMutexGuard -- acquire mutex, then guarantee for its release

RW-LOCK:

• CInternalRWLock -- platform-dependent RW-lock structure (fwd-decl)
• CRWLock -- Read/Write lock related data and methods
• CAutoRW -- guarantee RW-lock release
• CReadLockGuard -- acquire R-lock, then guarantee for its release
• CWriteLockGuard -- acquire W-lock, then guarantee for its release

SEMAPHORE:

• CSemaphore -- application-wide semaphore

Definition in file ncbimtx.hpp.

#include <corelib/ncbithr_conf.hpp>
#include <corelib/ncbicntr.hpp>
#include <corelib/guard.hpp>
#include <corelib/ncbiobj.hpp>
#include <memory>
#include <deque>
#include <corelib/ncbimtx.inl>

Include dependency graph for ncbimtx.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	CThreadSystemID
	CThreadSystemID --. More...
class	CMutexException
	CMutexException --. More...
struct	SSystemFastMutex
	SSystemFastMutex --. More...
struct	SSystemMutex
	SSystemMutex --. More...
class	CAutoInitializeStaticFastMutex
	CAutoInitializeStaticFastMutex --. More...
class	CAutoInitializeStaticMutex
	CAutoInitializeStaticMutex --. More...
class	CFastMutex
	CFastMutex --. More...
class	CMutex
	CMutex --. More...
class	CSpinLock
	CSpinLock --. More...
struct	SSimpleReadLock< Class >
	SSimpleReadLock --. More...
struct	SSimpleWriteLock< Class >
	SSimpleWriteLock --. More...
class	CRWLock
	CRWLock --. More...
struct	SSimpleReadUnlock< Class >
	SSimpleReadUnlock --. More...
struct	SSimpleWriteUnlock< Class >
	SSimpleWriteUnlock --. More...
class	CFastRWLock
	CFastRWLock --. More...
class	IRWLockHolder_Listener
	Interface for receiving messages about state changes in CRWLockHolder. More...
class	IRWLockHolder_Factory
	Interface for factory creating CRWLockHolder objects. More...
class	CRWLockHolder
	Holder of the lock inside CYieldingRWLock. More...
class	CYieldingRWLock
	Read/write lock without blocking calls. More...
class	CSemaphore
	CSemaphore --. More...
Defines
#define	INTERNAL_MUTEX_DEBUG
	Mutex debug setting.
#define	WRITE_MUTEX_EVENT(mutex, message)   ((void)0)
#define	THREAD_SYSTEM_ID_INITIALIZER   { 0 }
	Use in defining initial value of system mutex.
#define	NEED_AUTO_INITIALIZE_MUTEX
	Auto initialization for mutex will be used.
#define	DEFINE_STATIC_FAST_MUTEX(id)   static NCBI_NS_NCBI::CAutoInitializeStaticFastMutex id
	Define auto-initialized static fast mutex.
#define	DECLARE_CLASS_STATIC_FAST_MUTEX(id)   static NCBI_NS_NCBI::CAutoInitializeStaticFastMutex id
	Declare auto-initialized static fast mutex.
#define	DEFINE_CLASS_STATIC_FAST_MUTEX(id)   NCBI_NS_NCBI::CAutoInitializeStaticFastMutex id
	Define auto-initialized mutex.
#define	DEFINE_STATIC_MUTEX(id)   static NCBI_NS_NCBI::CAutoInitializeStaticMutex id
	Define auto-initialized static mutex.
#define	DECLARE_CLASS_STATIC_MUTEX(id)   static NCBI_NS_NCBI::CAutoInitializeStaticMutex id
	Declare auto-initialized static mutex.
#define	DEFINE_CLASS_STATIC_MUTEX(id)   NCBI_NS_NCBI::CAutoInitializeStaticMutex id
	Define auto-initialized mutex.
Typedefs
typedef CGuard< SSystemFastMutex >	TFastMutexGuard
	typedefs for ease of use
typedef TFastMutexGuard	CFastMutexGuard
	...and backward compatibility
typedef CGuard< SSystemMutex >	TMutexGuard
	typedefs for ease of use
typedef TMutexGuard	CMutexGuard
	...and backward compatibility
typedef CNoLock	CNoMutex
	CNoMutex --.
typedef CGuard< CSpinLock >	CSpinGuard
typedef CGuard< CRWLock, SSimpleReadLock< CRWLock > >	TReadLockGuard
typedef TReadLockGuard	CReadLockGuard
typedef CGuard< CRWLock, SSimpleWriteLock< CRWLock > >	TWriteLockGuard
typedef TWriteLockGuard	CWriteLockGuard
typedef CGuard< CFastRWLock, SSimpleReadLock< CFastRWLock >, SSimpleReadUnlock< CFastRWLock > >	CFastReadGuard
typedef CGuard< CFastRWLock, SSimpleWriteLock< CFastRWLock >, SSimpleWriteUnlock< CFastRWLock > >	CFastWriteGuard
typedef CIRef< IRWLockHolder_Listener >	TRWLockHolder_ListenerRef
	Types of smart references to IRWLockHolder_Listener.
typedef CWeakIRef< IRWLockHolder_Listener >	TRWLockHolder_ListenerWeakRef
typedef CRef< CRWLockHolder >	TRWLockHolderRef
	Type that should be always used to store pointers to CRWLockHolder.
Enumerations
enum	ERWLockType { eReadLock = 0, eWriteLock = 1 }
	Type of locking provided by CYieldingRWLock. More...

---