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

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

#include <thread.h>

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

Public Member Functions

T * get (void)
 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* ()
 Extract instance of locked typed object by pointer reference.
T * operator-> ()
 Access member of instance of locked typed object by member reference.
- Public Member Functions inherited from ucommon::locked_release
 locked_release (LockedPointer &pointer)
 Construct a locked object instance base from a LockedPointer.
locked_releaseoperator= (LockedPointer &pointer)
 Assign a locked object pointer.
void release (void)
 Manually release the object reference.
 ~locked_release ()
 Auto-release pointer to locked object instance.

Additional Inherited Members

- Protected Member Functions inherited from ucommon::locked_release
 locked_release ()
 Create an unassigned locked object pointer base.
 locked_release (locked_release &object)
 Construct a locked object instance base from an existing instance.
- Protected Attributes inherited from ucommon::locked_release
ObjectProtocolobject
 locked object protected by locked_release

Detailed Description

template<class T>
class ucommon::locked_instance< T >

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.nosp@m.@gnu.nosp@m.telep.nosp@m.hony.nosp@m..org

Definition at line 1924 of file thread.h.


Constructor & Destructor Documentation

template<class T >
ucommon::locked_instance< T >::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

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

Get pointer to instance of locked typed object.

Returns:
instance of typed object.

Definition at line 1956 of file thread.h.

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

Extract instance of locked typed object by pointer reference.

Returns:
instance of typed object.

Definition at line 1942 of file thread.h.

template<class T >
T* ucommon::locked_instance< T >::operator-> ( )
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: