UCommon
Public Member Functions
ucommon::locked_instance Class Reference

A templated smart pointer instance for lock protected objects. More...

#include <thread.h>

Inheritance diagram for ucommon::locked_instance:
Inheritance graph
[legend]
Collaboration diagram for ucommon::locked_instance:
Collaboration graph
[legend]

Public Member Functions

T * get (void) const
 Get pointer to instance of locked typed object.
 locked_instance ()
 Construct empty locked instance of typed object.
 locked_instance (locked_pointer< T > &pointer)
 Construct locked instance of typed object from matching locked_pointer.
T & operator* () const
 Extract instance of locked typed object by pointer reference.
T * operator-> () const
 Access member of instance of locked typed object by member reference.

Detailed Description

A templated smart pointer instance for lock protected objects.

This is used to reference an instance of a typed locked_pointer.

Author:
David Sugar <dyfet@gnutelephony.org>

Constructor & Destructor Documentation

ucommon::locked_instance::locked_instance ( locked_pointer< T > &  pointer) [inline]

Construct locked instance of typed object from matching locked_pointer.

Parameters:
pointerto get instance from.

Definition at line 1936 of file thread.h.


Member Function Documentation

T* ucommon::locked_instance::get ( void  ) const [inline]

Get pointer to instance of locked typed object.

Returns:
instance of typed object.

Definition at line 1956 of file thread.h.

T& ucommon::locked_instance::operator* ( ) const [inline]

Extract instance of locked typed object by pointer reference.

Returns:
instance of typed object.

Definition at line 1942 of file thread.h.

T* ucommon::locked_instance::operator-> ( ) const [inline]

Access member of instance of locked typed object by member reference.

Returns:
instance of typed object.

Definition at line 1949 of file thread.h.


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