mutex_keeper Class Reference

automatic mutex locker More...

#include <primitives.h>

List of all members.

Public Member Functions
	mutex_keeper (const mutex &mtx, bool use_try=false)
	constructor
	~mutex_keeper ()
	destructor
void	unlock () const
	unlocks explicitly
void	lock () const
	locks explicitly
	operator bool () const
	checks the lock state
bool	operator! () const
	checks the lock state
Private Attributes
const mutex &	_mtx
	mutex reference
bool	_locked
	lock flag for explicit unlock

---

Detailed Description

automatic mutex locker

Definition at line 87 of file primitives.h.

---

Constructor & Destructor Documentation

mutex_keeper::mutex_keeper	(	const mutex &	mtx,
		bool	use_try = false
	)			[inline]

constructor

Parameters:

mtx	mutex reference
use_try	try lock or make a blocking call

Definition at line 91 of file primitives.h.

References _locked, _mtx, mutex::lock(), and mutex::trylock().

mutex_keeper::~mutex_keeper

(

)

[inline]

destructor

Definition at line 98 of file primitives.h.

References _locked, _mtx, and mutex::unlock().

---

Member Function Documentation

void mutex_keeper::unlock

(

)

const [inline]

unlocks explicitly

Definition at line 106 of file primitives.h.

References _locked, _mtx, and mutex::unlock().

Referenced by fuzzy_wrapper_impl::add(), thread::assign_job(), threadpool::borrow_from_range(), threadpool::borrow_thread(), thread::cancel_job(), aiosock::close(), aiogate::close(), aiosock::complete_block(), aiofile::complete_block(), threadpool::doxray(), msg_communicator::doxray(), aiosock::doxray(), aiogate::doxray(), aiofile::doxray(), keylocker::enter(), thread::execute(), aiogate::final_close(), aiogate::initiate_close(), keylocker::leave(), aiosock::listen(), pool< C >::loan_object(), keylocker::lock(), aiogate::lock_pin(), fuzzy_wrapper_impl::match(), threadpool::off(), aiosock::process_timeouted_blocks(), aiofile::process_timeouted_blocks(), fuzzy_wrapper_impl::remove(), msg_communicator::remove_connection_config(), msg_communicator::remove_listener_config(), pool< C >::return_object(), thread::sleep(), keylocker::unlock(), aiogate::unlock_pin(), threadpool::v_do_job(), msg_communicator::v_do_job(), aiosock::v_do_job(), aiogate::v_do_job(), aiofile::v_do_job(), threadpool::v_has_job(), aiogate::v_on_connect(), aiogate::v_on_error(), aiogate::v_on_receive(), and aiogate::v_on_send().

void mutex_keeper::lock

(

)

const [inline]

locks explicitly

Definition at line 117 of file primitives.h.

References _locked, _mtx, and mutex::lock().

Referenced by fuzzy_wrapper_impl::add(), aiosock::close(), keylocker::enter(), keylocker::lock(), fuzzy_wrapper_impl::match(), threadpool::off(), aiosock::process_timeouted_blocks(), aiofile::process_timeouted_blocks(), fuzzy_wrapper_impl::remove(), aiogate::unlock_pin(), msg_communicator::v_do_job(), aiosock::v_do_job(), aiofile::v_do_job(), and threadpool::v_has_job().

mutex_keeper::operator bool

(

)

const [inline]

checks the lock state

Definition at line 127 of file primitives.h.

References _locked.

bool mutex_keeper::operator!

(

)

const [inline]

checks the lock state

Definition at line 134 of file primitives.h.

References _locked.

---

Member Data Documentation

const mutex& mutex_keeper::_mtx [private]

mutex reference

Definition at line 139 of file primitives.h.

Referenced by lock(), mutex_keeper(), unlock(), and ~mutex_keeper().

bool mutex_keeper::_locked [mutable, private]

lock flag for explicit unlock

Definition at line 140 of file primitives.h.

Referenced by lock(), mutex_keeper(), operator bool(), operator!(), unlock(), and ~mutex_keeper().

---

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

• primitives.h