blocxx
|
COWIntrusiveReference A smart pointer that uses intrusive reference counting. More...
#include <COWIntrusiveReference.hpp>
Public Types | |
typedef T | element_type |
typedef T *this_type:: | unspecified_bool_type |
Public Member Functions | |
COWIntrusiveReference () | |
Default constructor The underlying object pointer will be NULL. | |
COWIntrusiveReference (T *p, bool addRef=true) | |
Construct a COWIntrusiveReference that will contain a pointer to a COWIntrusiveCountableBase object. | |
template<class U > | |
COWIntrusiveReference (COWIntrusiveReference< U > const &rhs) | |
Copy constructor. | |
COWIntrusiveReference (COWIntrusiveReference const &rhs) | |
Copy constructor. | |
~COWIntrusiveReference () | |
Destroy this COWIntrusiveReference. | |
template<class U > | |
COWIntrusiveReference & | operator= (COWIntrusiveReference< U > const &rhs) |
Assignment operator that that takes a COWIntrusiveReference of a type derived from T. | |
COWIntrusiveReference & | operator= (COWIntrusiveReference const &rhs) |
Assignment operator. | |
COWIntrusiveReference & | operator= (T *rhs) |
Assignment operator. | |
const T * | getPtr () const |
const T & | operator* () const |
const T * | operator-> () const |
T & | operator* () |
T * | operator-> () |
operator unspecified_bool_type () const | |
bool | operator! () const |
Negation operator. | |
void | swap (COWIntrusiveReference &rhs) |
Private Types | |
typedef COWIntrusiveReference | this_type |
Private Member Functions | |
void | getWriteLock () |
Create a clone of the COWIntrusiveCountableBase object if there is more than one reference to it. | |
Private Attributes | |
T * | m_pObj |
Friends | |
class | COWIntrusiveReference |
COWIntrusiveReference A smart pointer that uses intrusive reference counting.
It supports 'copy on write' functionality. The 'intrusive' in the class names comes from the fact that referenced objects are required to be sub-classes of COWIntrusiveCountableBase. If your looking for a non-intrusive smart smart pointer class that providers copy on write functionality, check out the COWReference class.
This class relies on calls to
void COWIntrusiveReferenceAddRef(T* p); void COWIntrusiveReferenceRelease(T* p); bool COWIntrusiveReferenceUnique(T* p); T* COWIntrusiveReferenceClone(T* p);
(p != 0)
The object is responsible for destroying itself.
If you want your class to be managed by COWIntrusiveReference, you can derive it from COWIntrusiveCountableBase, or write your own set of functions.
Definition at line 83 of file COWIntrusiveReference.hpp.
typedef T BLOCXX_NAMESPACE::COWIntrusiveReference< T >::element_type |
Definition at line 88 of file COWIntrusiveReference.hpp.
typedef COWIntrusiveReference BLOCXX_NAMESPACE::COWIntrusiveReference< T >::this_type [private] |
Definition at line 86 of file COWIntrusiveReference.hpp.
typedef T* this_type:: BLOCXX_NAMESPACE::COWIntrusiveReference< T >::unspecified_bool_type |
Definition at line 251 of file COWIntrusiveReference.hpp.
BLOCXX_NAMESPACE::COWIntrusiveReference< T >::COWIntrusiveReference | ( | ) | [inline] |
Default constructor The underlying object pointer will be NULL.
Definition at line 94 of file COWIntrusiveReference.hpp.
BLOCXX_NAMESPACE::COWIntrusiveReference< T >::COWIntrusiveReference | ( | T * | p, |
bool | addRef = true |
||
) | [inline] |
Construct a COWIntrusiveReference that will contain a pointer to a COWIntrusiveCountableBase object.
p | A pointer to a COWIntrusiveCountableBase derivative. |
addRef | If true the reference count will be incremented before the constructor returns. Otherwise thre reference count is left alone. |
Definition at line 104 of file COWIntrusiveReference.hpp.
BLOCXX_NAMESPACE::COWIntrusiveReference< T >::COWIntrusiveReference | ( | COWIntrusiveReference< U > const & | rhs | ) | [inline] |
Copy constructor.
This takes a COWIntrusiveReference of a type derived from T. This constructor will cause this COWIntrusiveReference object to share the same underlying COWIntrusiveCountableBase pointer with another. This will cause the reference count to get incremented on the underlying object.
rhs | The object to copy the COWIntrusiveCountableBase pointer from. |
Definition at line 118 of file COWIntrusiveReference.hpp.
BLOCXX_NAMESPACE::COWIntrusiveReference< T >::COWIntrusiveReference | ( | COWIntrusiveReference< T > const & | rhs | ) | [inline] |
Copy constructor.
This constructor will cause this COWIntrusiveReference object to share the same underlying COWIntrusiveCountableBase pointer with another. This will cause the reference count to get incremented on the underlying object.
rhs | The object to copy the COWIntrusiveCountableBase pointer from. |
Definition at line 130 of file COWIntrusiveReference.hpp.
BLOCXX_NAMESPACE::COWIntrusiveReference< T >::~COWIntrusiveReference | ( | ) | [inline] |
Destroy this COWIntrusiveReference.
If the reference count to the underlying COWIntrusiveCountableBase object is zero after it is decremented in this method it will be deleted.
Definition at line 139 of file COWIntrusiveReference.hpp.
const T* BLOCXX_NAMESPACE::COWIntrusiveReference< T >::getPtr | ( | ) | const [inline] |
Definition at line 192 of file COWIntrusiveReference.hpp.
Referenced by BLOCXX_NAMESPACE::operator!=(), BLOCXX_NAMESPACE::operator<(), and BLOCXX_NAMESPACE::operator==().
void BLOCXX_NAMESPACE::COWIntrusiveReference< T >::getWriteLock | ( | ) | [inline, private] |
Create a clone of the COWIntrusiveCountableBase object if there is more than one reference to it.
This method is used to support the copy on write functionality.
Definition at line 285 of file COWIntrusiveReference.hpp.
Referenced by BLOCXX_NAMESPACE::COWIntrusiveReference< ByteBuf >::operator*(), and BLOCXX_NAMESPACE::COWIntrusiveReference< ByteBuf >::operator->().
BLOCXX_NAMESPACE::COWIntrusiveReference< T >::operator unspecified_bool_type | ( | ) | const [inline] |
Definition at line 252 of file COWIntrusiveReference.hpp.
bool BLOCXX_NAMESPACE::COWIntrusiveReference< T >::operator! | ( | ) | const [inline] |
Negation operator.
Definition at line 262 of file COWIntrusiveReference.hpp.
const T& BLOCXX_NAMESPACE::COWIntrusiveReference< T >::operator* | ( | ) | const [inline] |
Definition at line 201 of file COWIntrusiveReference.hpp.
T& BLOCXX_NAMESPACE::COWIntrusiveReference< T >::operator* | ( | ) | [inline] |
Definition at line 227 of file COWIntrusiveReference.hpp.
T* BLOCXX_NAMESPACE::COWIntrusiveReference< T >::operator-> | ( | ) | [inline] |
Definition at line 241 of file COWIntrusiveReference.hpp.
const T* BLOCXX_NAMESPACE::COWIntrusiveReference< T >::operator-> | ( | ) | const [inline] |
Definition at line 214 of file COWIntrusiveReference.hpp.
COWIntrusiveReference& BLOCXX_NAMESPACE::COWIntrusiveReference< T >::operator= | ( | COWIntrusiveReference< U > const & | rhs | ) | [inline] |
Assignment operator that that takes a COWIntrusiveReference of a type derived from T.
This method will cause this COWIntrusiveReference object to share the same underlying COWIntrusiveCountableBase pointer with another. This will cause the reference count to get incremented on the underlying object.
rhs | The object to copy the COWIntrusiveCountableBase pointer from. |
Definition at line 155 of file COWIntrusiveReference.hpp.
COWIntrusiveReference& BLOCXX_NAMESPACE::COWIntrusiveReference< T >::operator= | ( | COWIntrusiveReference< T > const & | rhs | ) | [inline] |
Assignment operator.
This method will cause this COWIntrusiveReference object to share the same underlying COWIntrusiveCountableBase pointer with another. This will cause the reference count to get incremented on the underlying object.
rhs | The object to copy the COWIntrusiveCountableBase pointer from. |
Definition at line 170 of file COWIntrusiveReference.hpp.
COWIntrusiveReference& BLOCXX_NAMESPACE::COWIntrusiveReference< T >::operator= | ( | T * | rhs | ) | [inline] |
Assignment operator.
This changes the underlying COWIntrusiveCountableBase pointer to the one passed to this method.
rhs | A pointer to a COWIntrusiveCountableBase object. this will be the new underlying pointer for this object. |
Definition at line 183 of file COWIntrusiveReference.hpp.
void BLOCXX_NAMESPACE::COWIntrusiveReference< T >::swap | ( | COWIntrusiveReference< T > & | rhs | ) | [inline] |
Definition at line 267 of file COWIntrusiveReference.hpp.
Referenced by BLOCXX_NAMESPACE::COWIntrusiveReference< ByteBuf >::operator=(), BLOCXX_NAMESPACE::String::swap(), and BLOCXX_NAMESPACE::swap().
friend class COWIntrusiveReference [friend] |
Definition at line 276 of file COWIntrusiveReference.hpp.
T* BLOCXX_NAMESPACE::COWIntrusiveReference< T >::m_pObj [private] |
Definition at line 294 of file COWIntrusiveReference.hpp.
Referenced by BLOCXX_NAMESPACE::COWIntrusiveReference< ByteBuf >::COWIntrusiveReference(), BLOCXX_NAMESPACE::COWIntrusiveReference< ByteBuf >::getPtr(), BLOCXX_NAMESPACE::COWIntrusiveReference< ByteBuf >::getWriteLock(), BLOCXX_NAMESPACE::COWIntrusiveReference< ByteBuf >::operator unspecified_bool_type(), BLOCXX_NAMESPACE::COWIntrusiveReference< ByteBuf >::operator!(), BLOCXX_NAMESPACE::COWIntrusiveReference< ByteBuf >::operator*(), BLOCXX_NAMESPACE::COWIntrusiveReference< ByteBuf >::operator->(), BLOCXX_NAMESPACE::COWIntrusiveReference< ByteBuf >::swap(), and BLOCXX_NAMESPACE::COWIntrusiveReference< ByteBuf >::~COWIntrusiveReference().