UCommon
Public Member Functions
ucommon::mutex_pointer< T > Class Template Reference

Typed smart locked pointer class. More...

#include <thread.h>

Inheritance diagram for ucommon::mutex_pointer< T >:
Inheritance graph
[legend]
Collaboration diagram for ucommon::mutex_pointer< T >:
Collaboration graph
[legend]

Public Member Functions

T * get (void) const
 Get pointer to object.
 mutex_pointer ()
 Create a pointer with no reference.
 mutex_pointer (T *object)
 Create a pointer with a reference to a heap object.
T & operator* () const
 Reference object we are pointing to through pointer indirection.
T * operator-> () const
 Reference member of object we are pointing to.
- Public Member Functions inherited from ucommon::auto_protect
 auto_protect (void *object)
 Construct a protected pointer referencing an existing object.
 operator bool () const
 Test if the pointer is referencing an object.
bool operator! () const
 Test if the pointer is not set.
void operator= (void *object)
 Set our pointer to a specific object.
void release (void)
 Manually release the pointer.
 ~auto_protect ()
 Delete protected pointer.

Additional Inherited Members

- Protected Attributes inherited from ucommon::auto_protect
void * object

Detailed Description

template<class T>
class ucommon::mutex_pointer< T >

Typed smart locked pointer class.

This is used to manage references to objects which are protected by an auto-generated mutex. The mutex is released when the pointer falls out of scope.

Author
David Sugar dyfet.nosp@m.@gnu.nosp@m.telep.nosp@m.hony.nosp@m..org

Definition at line 2009 of file thread.h.

Constructor & Destructor Documentation

template<class T >
ucommon::mutex_pointer< T >::mutex_pointer ( T *  object)
inline

Create a pointer with a reference to a heap object.

Parameters
objectwe are referencing.

Definition at line 2021 of file thread.h.

Member Function Documentation

template<class T >
T* ucommon::mutex_pointer< T >::get ( void  ) const
inline

Get pointer to object.

Returns
pointer or NULL if we are not referencing an object.

Definition at line 2041 of file thread.h.

template<class T >
T& ucommon::mutex_pointer< T >::operator* ( ) const
inline

Reference object we are pointing to through pointer indirection.

Returns
object we are pointing to.

Definition at line 2027 of file thread.h.

template<class T >
T* ucommon::mutex_pointer< T >::operator-> ( ) const
inline

Reference member of object we are pointing to.

Returns
reference to member of pointed object.

Definition at line 2034 of file thread.h.


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