Auto-pointer support class for locked objects. More...
#include <thread.h>
Public Member Functions | |
| locked_release (LockedPointer &pointer) | |
| Construct a locked object instance base from a LockedPointer. | |
| locked_release & | operator= (LockedPointer &pointer) |
| Assign a locked object pointer. | |
| void | release (void) |
| Manually release the object reference. | |
| ~locked_release () | |
| Auto-release pointer to locked object instance. | |
Protected Member Functions | |
| 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 | |
| ObjectProtocol * | object |
| locked object protected by locked_release | |
Detailed Description
Auto-pointer support class for locked objects.
This is used as a base class for the templated locked_instance class that uses the managed LockedPointer to assign a reference to an object. When the locked instance falls out of scope, the object is derefenced. Ideally the pointer typed object should be based on the reference counted object class.
Constructor & Destructor Documentation
| ucommon::locked_release::locked_release | ( | locked_release & | object | ) | [protected] |
Construct a locked object instance base from an existing instance.
This will create a duplicate (retained) reference.
- Parameters:
-
object to copy from.
| ucommon::locked_release::locked_release | ( | LockedPointer & | pointer | ) |
Construct a locked object instance base from a LockedPointer.
References a retained instance of the underlying object from the LockedPointer.
- Parameters:
-
pointer of locked pointer to assign from.
Auto-release pointer to locked object instance.
This is used to release a reference when the pointer template falls out of scope.
Member Function Documentation
| locked_release& ucommon::locked_release::operator= | ( | LockedPointer & | pointer | ) |
Assign a locked object pointer.
If an existing object is already assigned, the existing pointer is released.
- Parameters:
-
pointer reference through locked object.
The documentation for this class was generated from the following file:
- ucommon/thread.h
