ACE_Refcounted_Auto_Ptr< X, ACE_LOCK > Class Template Reference

This class implements support for a reference counted unique_ptr. Assigning or copying instances of an ACE_Refcounted_Auto_Ptr will automatically increment the reference count. When the last instance that references a ACE_Refcounted_Auto_Ptr instance is destroyed or overwritten, it will invoke delete on its underlying pointer. More...

#include <Refcounted_Auto_Ptr.h>

Collaboration diagram for ACE_Refcounted_Auto_Ptr< X, ACE_LOCK >:

Public Member Functions
	ACE_Refcounted_Auto_Ptr (X *p=nullptr)
	ACE_Refcounted_Auto_Ptr (const ACE_Refcounted_Auto_Ptr< X, ACE_LOCK > &r)
virtual	~ACE_Refcounted_Auto_Ptr ()
void	operator= (const ACE_Refcounted_Auto_Ptr< X, ACE_LOCK > &r)
bool	operator== (const ACE_Refcounted_Auto_Ptr< X, ACE_LOCK > &r) const
bool	operator!= (const ACE_Refcounted_Auto_Ptr< X, ACE_LOCK > &r) const
	Inequality operator, which is the opposite of equality.
X *	operator-> () const
	Redirection operator.
X &	operator* () const
	Accessor method.
bool	operator! () const
	Check rep easily.
	operator unspecified_bool_type () const
	Check rep easily.
X *	release ()
void	reset (X *p=nullptr)
X *	get () const
	Get the pointer value.
long	count () const
	Get the reference count value.
bool	null () const
	Returns true if this object does not contain a valid pointer.

Public Attributes
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks.

Protected Types
typedef ACE_Refcounted_Auto_Ptr_Rep< X, ACE_LOCK >	AUTO_REFCOUNTED_PTR_REP
	the ACE_Refcounted_Auto_Ptr_Rep

Protected Attributes
AUTO_REFCOUNTED_PTR_REP *	rep_
	Protect operations on the ACE_Refcounted_Auto_Ptr.

Private Types
typedef void(*	unspecified_bool_type) (ACE_Refcounted_Auto_Ptr< X, ACE_LOCK > ***)

Static Private Member Functions
static void	unspecified_bool (ACE_Refcounted_Auto_Ptr< X, ACE_LOCK > ***)
	Used to define a proper boolean conversion for "if (sp) ...".

Detailed Description

template<class X, class ACE_LOCK>
class ACE_Refcounted_Auto_Ptr< X, ACE_LOCK >

This class implements support for a reference counted unique_ptr. Assigning or copying instances of an ACE_Refcounted_Auto_Ptr will automatically increment the reference count. When the last instance that references a ACE_Refcounted_Auto_Ptr instance is destroyed or overwritten, it will invoke delete on its underlying pointer.

The ACE_Refcounted_Auto_Ptr works by maintaining a reference to a separate representation object, ACE_Refcounted_Auto_Ptr_Rep. That separate representation object contains the reference count and the actual pointer value.

Member Typedef Documentation

AUTO_REFCOUNTED_PTR_REP

template<class X , class ACE_LOCK >

typedef ACE_Refcounted_Auto_Ptr_Rep<X, ACE_LOCK> ACE_Refcounted_Auto_Ptr< X, ACE_LOCK >::AUTO_REFCOUNTED_PTR_REP

protected

the ACE_Refcounted_Auto_Ptr_Rep

unspecified_bool_type

template<class X , class ACE_LOCK >

typedef void(* ACE_Refcounted_Auto_Ptr< X, ACE_LOCK >::unspecified_bool_type) (ACE_Refcounted_Auto_Ptr< X, ACE_LOCK > ***)

private

Constructor & Destructor Documentation

ACE_Refcounted_Auto_Ptr() [1/2]

template<class X , class ACE_LOCK >

ACE_Refcounted_Auto_Ptr< X, ACE_LOCK >::ACE_Refcounted_Auto_Ptr ( X * p = nullptr )

inlineexplicit

Constructor that initializes an ACE_Refcounted_Auto_Ptr to the specified pointer value.

ACE_Refcounted_Auto_Ptr() [2/2]

template<class X , class ACE_LOCK >

ACE_Refcounted_Auto_Ptr< X, ACE_LOCK >::ACE_Refcounted_Auto_Ptr ( const ACE_Refcounted_Auto_Ptr< X, ACE_LOCK > & r )

inline

Copy constructor binds the new ACE_Refcounted_Auto_Ptr to the representation object referenced by r. An ACE_Refcounted_Auto_Ptr_Rep is created if necessary.

~ACE_Refcounted_Auto_Ptr()

template<class X , class ACE_LOCK >

class ACE_LOCK ACE_Refcounted_Auto_Ptr< X, ACE_LOCK >::~ACE_Refcounted_Auto_Ptr ( )

virtual

Destructor. Releases the reference to the underlying representation. If the release of that reference causes its reference count to reach 0, the representation object will also be destroyed.

Member Function Documentation

count()

template<class X , class ACE_LOCK >

long ACE_Refcounted_Auto_Ptr< X, ACE_LOCK >::count ( ) const

inline

Get the reference count value.

get()

template<class X , class ACE_LOCK >

X * ACE_Refcounted_Auto_Ptr< X, ACE_LOCK >::get ( ) const

inline

Get the pointer value.

null()

template<class X , class ACE_LOCK >

bool ACE_Refcounted_Auto_Ptr< X, ACE_LOCK >::null ( ) const

inline

Returns true if this object does not contain a valid pointer.

operator unspecified_bool_type()

template<class X , class ACE_LOCK >

ACE_Refcounted_Auto_Ptr< X, ACE_LOCK >::operator unspecified_bool_type ( ) const

inline

Check rep easily.

operator!()

template<class X , class ACE_LOCK >

bool ACE_Refcounted_Auto_Ptr< X, ACE_LOCK >::operator! ( ) const

inline

Check rep easily.

operator!=()

template<class X , class ACE_LOCK >

bool ACE_Refcounted_Auto_Ptr< X, ACE_LOCK >::operator!= ( const ACE_Refcounted_Auto_Ptr< X, ACE_LOCK > & r ) const

inline

Inequality operator, which is the opposite of equality.

operator*()

template<class X , class ACE_LOCK >

X & ACE_Refcounted_Auto_Ptr< X, ACE_LOCK >::operator* ( ) const

inline

Accessor method.

operator->()

template<class X , class ACE_LOCK >

X * ACE_Refcounted_Auto_Ptr< X, ACE_LOCK >::operator-> ( ) const

inline

Redirection operator.

operator=()

template<class X , class ACE_LOCK >

void ACE_Refcounted_Auto_Ptr< X, ACE_LOCK >::operator= ( const ACE_Refcounted_Auto_Ptr< X, ACE_LOCK > & r )

inline

Assignment operator that binds the current object and r to the same ACE_Refcounted_Auto_Ptr_Rep. An ACE_Refcounted_Auto_Ptr_Rep is created if necessary.

operator==()

template<class X , class ACE_LOCK >

bool ACE_Refcounted_Auto_Ptr< X, ACE_LOCK >::operator== ( const ACE_Refcounted_Auto_Ptr< X, ACE_LOCK > & r ) const

inline

Equality operator that returns true if both ACE_Refcounted_Auto_Ptr objects point to the same underlying representation. It does not compare the actual pointers.

Note

It also returns true if both objects have just been instantiated and not used yet.

release()

template<class X , class ACE_LOCK >

X * ACE_Refcounted_Auto_Ptr< X, ACE_LOCK >::release ( )

inline

Releases the reference to the underlying representation object.

Return values

The	pointer value prior to releasing it.

reset()

template<class X , class ACE_LOCK >

void ACE_Refcounted_Auto_Ptr< X, ACE_LOCK >::reset ( X * p = nullptr )

inline

Releases the current pointer value and then sets a new pointer value specified by p.

unspecified_bool()

template<class X , class ACE_LOCK >

static void ACE_Refcounted_Auto_Ptr< X, ACE_LOCK >::unspecified_bool ( ACE_Refcounted_Auto_Ptr< X, ACE_LOCK > *** )

inlinestaticprivate

Used to define a proper boolean conversion for "if (sp) ...".

Member Data Documentation

ACE_ALLOC_HOOK_DECLARE

template<class X , class ACE_LOCK >

ACE_Refcounted_Auto_Ptr< X, ACE_LOCK >::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

rep_

template<class X , class ACE_LOCK >

AUTO_REFCOUNTED_PTR_REP* ACE_Refcounted_Auto_Ptr< X, ACE_LOCK >::rep_

protected

Protect operations on the ACE_Refcounted_Auto_Ptr.

---

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

• Refcounted_Auto_Ptr.h
• Refcounted_Auto_Ptr.cpp
• Refcounted_Auto_Ptr.inl