Thread portable class


Gate portable class


Timer class


Pool class


Terimber 2.0


About C++


Downloads Products & Services Support Clients Open Source About



Home / Open source / Terimber 2.0

keylocker_client Class Reference

class supports automatic entry/leave of gate More...

#include <keymaker.h>

List of all members.

Public Member Functions

 keylocker_client (const keylocker &locker, size_t timeout=INFINITE)
 constructor
 ~keylocker_client ()
 destructor
 operator bool () const
 checks access flag
bool operator! () const
 checks access flag
void leave () const
 unlocks explicitly
void enter (size_t timeout=INFINITE) const
 locks explicitly

Private Attributes

bool _inside
 flag client entered
const keylocker_locker
 keylocker object


Detailed Description

class supports automatic entry/leave of gate

Definition at line 112 of file keymaker.h.


Constructor & Destructor Documentation

keylocker_client::keylocker_client ( const keylocker locker,
size_t  timeout = INFINITE 
) [inline]

constructor

Parameters:
locker  keylocker object
timeout  timeout in milliseconds

Definition at line 285 of file keymaker.hpp.

References _inside, _locker, and keylocker::enter().

keylocker_client::~keylocker_client (  )  [inline]

destructor

Definition at line 294 of file keymaker.hpp.

References _inside, _locker, and keylocker::leave().


Member Function Documentation

keylocker_client::operator bool (  )  const [inline]

checks access flag

Definition at line 302 of file keymaker.hpp.

References _inside.

bool keylocker_client::operator! (  )  const [inline]

checks access flag

Definition at line 309 of file keymaker.hpp.

References _inside.

void keylocker_client::leave (  )  const [inline]

unlocks explicitly

Definition at line 317 of file keymaker.hpp.

References _inside, _locker, and keylocker::leave().

void keylocker_client::enter ( size_t  timeout = INFINITE  )  const [inline]

locks explicitly

Definition at line 326 of file keymaker.hpp.

References _inside, _locker, and keylocker::enter().


Member Data Documentation

bool keylocker_client::_inside [mutable, private]

flag client entered

Definition at line 139 of file keymaker.h.

Referenced by enter(), keylocker_client(), leave(), operator bool(), operator!(), and ~keylocker_client().

keylocker object

Definition at line 140 of file keymaker.h.

Referenced by enter(), keylocker_client(), leave(), and ~keylocker_client().


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


© Copyright Terimber 2003-.