ucommon

shared_lock Class Reference

A kind of smart pointer object to support shared locking protocol. More...

#include <access.h>

Collaboration diagram for shared_lock:

Public Member Functions

void exclusive (void)
 Call exclusive access on referenced objects protocol.
 operator bool () const
 Test if the reference holds an active lock.
bool operator! () const
 Test if the reference holds an active lock.
void release (void)
 Release a held lock programmatically.
void share (void)
 Restore shared access on referenced objects protocol.
 shared_lock (Shared *object)
 Create an instance of an exclusive object reference.
 ~shared_lock ()
 Destroy reference to shared locked object, release lock.

Detailed Description

A kind of smart pointer object to support shared locking protocol.

This object initiates a shared lock for the object being referenced when it is instantiated, and releases the shared lock when it is destroyed. You would pass the pointer an object that has the Shared as a base class.

Author:
David Sugar <dyfet@gnutelephony.org>

Definition at line 172 of file access.h.


Constructor & Destructor Documentation

shared_lock::shared_lock ( Shared object)

Create an instance of an exclusive object reference.

Parameters:
objectcontaining Exclusive base class protocol to lock.

Member Function Documentation

shared_lock::operator bool ( ) const [inline]

Test if the reference holds an active lock.

Returns:
true if locking an object.

Definition at line 202 of file access.h.

Here is the call graph for this function:

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

Test if the reference holds an active lock.

Returns:
true if is not locking an object.

Definition at line 195 of file access.h.

Here is the call graph for this function:

void shared_lock::release ( void  )

Release a held lock programmatically.

This can be used to de-reference the object being share locked without having to wait for the destructor to be called when the shared_lock falls out of scope.


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