basis::mutex Class Reference

#include <mutex.h>

Inheritance diagram for basis::mutex:

Collaboration diagram for basis::mutex:

Public Member Functions
	mutex ()
	Constructs a new mutex. More...
virtual	~mutex ()
	Destroys the mutex. It should not be locked upon destruction. More...
void	construct ()
	Constructor for use with malloc/free instead of new/delete. More...
void	destruct ()
	Destructor for use with malloc/free instead of new/delete. More...
void	lock ()
	Clamps down on the mutex, if possible. More...
void	unlock ()
	Gives up the possession of the mutex. More...
virtual void	establish_lock ()
	Satisfies base class requirements for locking. More...
virtual void	repeal_lock ()
	Satisfies base class requirements for unlocking. More...

Detailed Description

Definition at line 32 of file mutex.h.

Constructor & Destructor Documentation

mutex()

basis::mutex::mutex

(

)

Constructs a new mutex.

Definition at line 42 of file mutex.cpp.

References construct().

~mutex()

basis::mutex::~mutex ( )

virtual

Destroys the mutex. It should not be locked upon destruction.

Definition at line 44 of file mutex.cpp.

References destruct().

Member Function Documentation

construct()

void basis::mutex::construct

(

)

Constructor for use with malloc/free instead of new/delete.

Definition at line 50 of file mutex.cpp.

References NULL_POINTER.

Referenced by mutex().

destruct()

void basis::mutex::destruct

(

)

Destructor for use with malloc/free instead of new/delete.

Definition at line 75 of file mutex.cpp.

Referenced by ~mutex().

establish_lock()

void basis::mutex::establish_lock ( )

virtual

Satisfies base class requirements for locking.

Implements basis::base_synchronizer.

Definition at line 46 of file mutex.cpp.

References lock().

lock()

void basis::mutex::lock

(

)

Clamps down on the mutex, if possible.

Otherwise the current thread is blocked until the mutex is unlocked.

Definition at line 95 of file mutex.cpp.

Referenced by processes::safe_roller::current(), processes::safe_callback::end_availability(), establish_lock(), octopi::octopus::evaluate(), octopi::file_transfer_tentacle::lock_directory(), sockets::socket_minder::lock_socket_data(), octopi::octopus::lock_tentacle(), octopi::octopus::lock_tentacles(), processes::safe_roller::next_id(), octopi::octopus::remove_tentacle(), processes::safe_roller::set_current(), test_recursive_locking(), and timely::timer_driver::~timer_driver().

repeal_lock()

void basis::mutex::repeal_lock ( )

virtual

Satisfies base class requirements for unlocking.

Implements basis::base_synchronizer.

Definition at line 48 of file mutex.cpp.

References unlock().

unlock()

void basis::mutex::unlock

(

)

Gives up the possession of the mutex.

Definition at line 107 of file mutex.cpp.

Referenced by processes::safe_roller::current(), processes::safe_callback::end_availability(), octopi::octopus::evaluate(), octopi::file_transfer_tentacle::lock_directory(), sockets::socket_minder::lock_socket_data(), octopi::octopus::lock_tentacle(), processes::safe_roller::next_id(), octopi::octopus::remove_tentacle(), repeal_lock(), processes::safe_roller::set_current(), test_recursive_locking(), octopi::file_transfer_tentacle::unlock_directory(), sockets::socket_minder::unlock_socket_data(), octopi::octopus::unlock_tentacle(), octopi::octopus::unlock_tentacles(), and timely::timer_driver::~timer_driver().

---

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

• /opt/feistymeow.org/feisty_meow/nucleus/library/basis/mutex.h
• /opt/feistymeow.org/feisty_meow/nucleus/library/basis/mutex.cpp