ucommon/access.h File Reference

Locking classes for member function automatic operations. More...

#include <ucommon/platform.h>
Include dependency graph for access.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

class  Exclusive
 An exclusive locking protocol interface base. More...
class  Shared
 An exclusive locking protocol interface base. More...
class  exclusive_lock
 A kind of smart pointer object to support exclusive locking protocol. More...
class  shared_lock
 A kind of smart pointer object to support shared locking protocol. More...

Defines

#define exclusive_object()   exlock_t __autolock__ = this
#define protected_object()   shlock_t __autolock__ = this
#define exclusive_access(x)   exlock_t __autolock__ = &x
#define protected_access(x)   shlock_t __autolock__ = &x

Typedefs

typedef exclusive_lock exlock_t
 Convenience type to use for object referencing an exclusive object.
typedef shared_lock shlock_t
 Convenience type to use for object referencing a shared object.

Functions

void lock (Exclusive *object)
 Convenience function to exclusively lock an object through it's protocol.
void unlock (Exclusive *object)
 Convenience function to unlock an exclusive object through it's protocol.
void access (Shared *object)
 Convenience function to access (lock) shared object through it's protocol.
void release (Shared *object)
 Convenience function to unlock shared object through it's protocol.
void exclusive (Shared *object)
 Convenience function to exclusive lock shared object through it's protocol.
void share (Shared *object)
 Convenience function to restore shared locking for object through it's protocol.
void release (exlock_t &reference)
 Convenience function to release a reference to an exclusive lock.
void release (shlock_t &reference)
 Convenience function to release a reference to a shared lock.

Detailed Description

Locking classes for member function automatic operations.

This header covers ucommon access related classes. These are used to provide automatic management of locks and sychronization objects through common virtual base classes which can be used with automatic objects. These classes are intended to be used much like "protocols" in conjunction with smart pointer/referencing classes. This protocol interface supports member functions to aquire a lock when entered and automatically release the lock when the member function returns that are used in conjunction with special referencing smart pointers.

Author:
David Sugar <dyfet@gnutelephony.org>

Definition in file access.h.


Function Documentation

void access ( Shared object  )  [inline]

Convenience function to access (lock) shared object through it's protocol.

Parameters:
object to share lock.

Definition at line 238 of file access.h.

void exclusive ( Shared object  )  [inline]

Convenience function to exclusive lock shared object through it's protocol.

Parameters:
object to exclusive lock.

Definition at line 252 of file access.h.

void lock ( Exclusive object  )  [inline]

Convenience function to exclusively lock an object through it's protocol.

Parameters:
object to lock.

Definition at line 224 of file access.h.

void release ( shlock_t reference  )  [inline]

Convenience function to release a reference to a shared lock.

Parameters:
reference to object referencing shared locked object.

Definition at line 283 of file access.h.

Here is the call graph for this function:

void release ( exlock_t reference  )  [inline]

Convenience function to release a reference to an exclusive lock.

Parameters:
reference to object referencing exclusive locked object.

Definition at line 276 of file access.h.

Here is the call graph for this function:

void release ( Shared object  )  [inline]

Convenience function to unlock shared object through it's protocol.

Parameters:
object to unlock.

Definition at line 245 of file access.h.

void share ( Shared object  )  [inline]

Convenience function to restore shared locking for object through it's protocol.

Parameters:
object to restore shared locking.

Definition at line 259 of file access.h.

void unlock ( Exclusive object  )  [inline]

Convenience function to unlock an exclusive object through it's protocol.

Parameters:
object to unlock.

Definition at line 231 of file access.h.


Generated on 18 Dec 2009 for UCommon by  doxygen 1.6.1