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

A templated smart pointer instance for shared singleton typed objects. More...

#include <thread.h>

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

Public Member Functions

const T * get (void) const
 Access pointer to typed singleton object this instance locks and references.
 
const T & operator* () const
 Access shared typed singleton object this instance locks and references.
 
const T * operator-> () const
 Access member of shared typed singleton object this instance locks and references.
 
 shared_instance ()
 Construct empty instance to reference shared typed singleton.
 
 shared_instance (shared_pointer< T > &pointer)
 Construct shared access instance of shared typed singleton from matching shared_pointer. More...
 
- Public Member Functions inherited from ucommon::shared_release
SharedObjectget (void)
 Get pointer to singleton object that we have shared lock for. More...
 
shared_releaseoperator= (SharedPointer &pointer)
 Assign shared lock access to shared singleton. More...
 
void release (void)
 Manually release access to shared singleton object.
 
 shared_release (SharedPointer &pointer)
 Access lock a shared singleton instance from a SharedPointer. More...
 
 ~shared_release ()
 Auto-unlock shared lock for singleton instance protected by shared pointer. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ucommon::shared_release
 shared_release ()
 Create an unassigned shared singleton object pointer base.
 
 shared_release (const shared_release &object)
 Construct a shared object instance base from an existing instance. More...
 
- Protected Attributes inherited from ucommon::shared_release
SharedPointerptr
 Shared lock for protected singleton.
 

Detailed Description

template<class T>
class ucommon::shared_instance< T >

A templated smart pointer instance for shared singleton typed objects.

This is used to access the shared lock instance of the singleton.

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

Definition at line 1786 of file thread.h.

Constructor & Destructor Documentation

template<class T >
ucommon::shared_instance< T >::shared_instance ( shared_pointer< T > &  pointer)
inline

Construct shared access instance of shared typed singleton from matching shared_pointer.

Parameters
pointerto get instance from.

Definition at line 1799 of file thread.h.


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