keylocker Class Reference

class supports the locking on demand functionality More...

#include <keymaker.h>

List of all members.

Public Member Functions
	keylocker (size_t capacity=os_def_size)
	constructor
bool	enter (size_t timeout) const
	read-only lock
void	leave () const
	read-only unlock
bool	lock (size_t timeout) const
	writes lock
void	unlock () const
	writes unlock
Private Attributes
const size_t	_capacity
	max read-onlyy clients allowed
bool	_opened
	flag if read-only door is open
size_t	_clients
	number read-only clients entered
event	_ev_open
	signal to client that locker is open
event	_ev_close
	signal to server that all clients left locker
event	_ev_client
	signal to client that any client left locker
event	_ev_server
	signal to server that one server unlock locker
mutex	_access_mtx
	access to resources
mutex	_server_mtx
	multiple server exclusion

---

Detailed Description

class supports the locking on demand functionality

Definition at line 38 of file keymaker.h.

---

Constructor & Destructor Documentation

BEGIN_TERIMBER_NAMESPACE keylocker::keylocker

(

size_t

capacity = os_def_size

)

[inline]

constructor

Parameters:

capacity

max locker capacity for read-only locks

Definition at line 38 of file keymaker.hpp.

---

Member Function Documentation

bool keylocker::enter

(

size_t

timeout

)

const [inline]

read-only lock

client functions

Parameters:

timeout

timeout in milliseconds

Definition at line 52 of file keymaker.hpp.

References _access_mtx, _capacity, _clients, _ev_client, _ev_open, _opened, date::get_difference(), mutex_keeper::lock(), mutex_keeper::unlock(), and event::wait().

Referenced by keylocker_client::enter(), keylocker_client::keylocker_client(), msg_communicator::loan_communicator(), and pool< C >::loan_object().

void keylocker::leave

(

)

const [inline]

read-only unlock

Definition at line 106 of file keymaker.hpp.

References _access_mtx, _clients, _ev_client, _ev_close, _opened, event::signal(), and mutex_keeper::unlock().

Referenced by keylocker_client::leave(), msg_communicator::loan_communicator(), pool< C >::loan_object(), msg_communicator::return_communicator(), pool< C >::return_object(), and keylocker_client::~keylocker_client().

bool keylocker::lock

(

size_t

timeout

)

const [inline]

writes lock

server functions

Parameters:

timeout

timeout in milliseconds

Definition at line 129 of file keymaker.hpp.

References _access_mtx, _clients, _ev_close, _ev_open, _ev_server, _opened, _server_mtx, date::get_difference(), mutex_keeper::lock(), mutex::lock(), event::nonsignal(), event::signal(), mutex::unlock(), mutex_keeper::unlock(), and event::wait().

Referenced by keylocker_server::keylocker_server(), and keylocker_server::lock().

void keylocker::unlock

(

)

const [inline]

writes unlock

Definition at line 206 of file keymaker.hpp.

References _access_mtx, _ev_open, _ev_server, _opened, _server_mtx, event::signal(), mutex::unlock(), and mutex_keeper::unlock().

Referenced by keylocker_server::unlock(), and keylocker_server::~keylocker_server().

---

Member Data Documentation

const size_t keylocker::_capacity [private]

max read-onlyy clients allowed

Definition at line 66 of file keymaker.h.

Referenced by enter().

bool keylocker::_opened [mutable, private]

flag if read-only door is open

Definition at line 67 of file keymaker.h.

Referenced by enter(), leave(), lock(), and unlock().

size_t keylocker::_clients [mutable, private]

number read-only clients entered

Definition at line 68 of file keymaker.h.

Referenced by enter(), leave(), and lock().

event keylocker::_ev_open [private]

signal to client that locker is open

Definition at line 69 of file keymaker.h.

Referenced by enter(), lock(), and unlock().

event keylocker::_ev_close [private]

signal to server that all clients left locker

Definition at line 70 of file keymaker.h.

Referenced by leave(), and lock().

event keylocker::_ev_client [private]

signal to client that any client left locker

Definition at line 71 of file keymaker.h.

Referenced by enter(), and leave().

event keylocker::_ev_server [private]

signal to server that one server unlock locker

Definition at line 72 of file keymaker.h.

Referenced by lock(), and unlock().

mutex keylocker::_access_mtx [private]

access to resources

Definition at line 73 of file keymaker.h.

Referenced by enter(), leave(), lock(), and unlock().

mutex keylocker::_server_mtx [private]

multiple server exclusion

Definition at line 74 of file keymaker.h.

Referenced by lock(), and unlock().

---

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

• keymaker.h
• keymaker.hpp