ACE  6.3.3
Public Member Functions | Public Attributes | Private Types | Private Attributes | Friends | List of all members
ACE_Strong_Bound_Ptr< X, ACE_LOCK > Class Template Reference

This class implements support for a reference counted pointer. More...

#include <Bound_Ptr.h>

Collaboration diagram for ACE_Strong_Bound_Ptr< X, ACE_LOCK >:
Collaboration graph
[legend]

Public Member Functions

 ACE_Strong_Bound_Ptr (X *p=0)
 
 ACE_Strong_Bound_Ptr (auto_ptr< X > p)
 
 ACE_Strong_Bound_Ptr (const ACE_Strong_Bound_Ptr< X, ACE_LOCK > &r)
 Copy constructor binds this and r to the same object. More...
 
 ACE_Strong_Bound_Ptr (const ACE_Weak_Bound_Ptr< X, ACE_LOCK > &r)
 Constructor binds this and r to the same object. More...
 
template<class Y >
 ACE_Strong_Bound_Ptr (const ACE_Strong_Bound_Ptr< Y, ACE_LOCK > &r)
 
 ~ACE_Strong_Bound_Ptr (void)
 Destructor. More...
 
void operator= (const ACE_Strong_Bound_Ptr< X, ACE_LOCK > &r)
 Assignment operator that binds this and r to the same object. More...
 
void operator= (const ACE_Weak_Bound_Ptr< X, ACE_LOCK > &r)
 Assignment operator that binds this and r to the same object. More...
 
template<class Y >
ACE_Weak_Bound_Ptr< X, ACE_LOCK > & operator= (const ACE_Strong_Bound_Ptr< Y, ACE_LOCK > &r)
 
bool operator== (const ACE_Strong_Bound_Ptr< X, ACE_LOCK > &r) const
 
bool operator== (const ACE_Weak_Bound_Ptr< X, ACE_LOCK > &r) const
 
bool operator== (X *p) const
 
bool operator!= (const ACE_Strong_Bound_Ptr< X, ACE_LOCK > &r) const
 Inequality operator, which is the opposite of equality. More...
 
bool operator!= (const ACE_Weak_Bound_Ptr< X, ACE_LOCK > &r) const
 Inequality operator, which is the opposite of equality. More...
 
bool operator!= (X *p) const
 Inequality operator, which is the opposite of equality. More...
 
X * operator-> (void) const
 Redirection operator. More...
 
X & operator* (void) const
 Dereference operator. More...
 
X * get (void) const
 Get the pointer value. More...
 
void reset (X *p=0)
 
void reset (auto_ptr< X > p)
 
bool null (void) const
 

Public Attributes

 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks. More...
 

Private Types

typedef X X_t
 
typedef ACE_Bound_Ptr_Counter< ACE_LOCK > COUNTER
 The ACE_Bound_Ptr_Counter type. More...
 

Private Attributes

COUNTERcounter_
 The reference counter. More...
 
X * ptr_
 The underlying object. More...
 

Friends

class ACE_Weak_Bound_Ptr< X, ACE_LOCK >
 
template<class Y , class L >
class ACE_Strong_Bound_Ptr
 

Detailed Description

template<class X, class ACE_LOCK>
class ACE_Strong_Bound_Ptr< X, ACE_LOCK >

This class implements support for a reference counted pointer.

Assigning or copying instances of an ACE_Strong_Bound_Ptr will automatically increment the reference count of the underlying object. When the last instance of an ACE_Strong_Bound_Ptr that references a particular object is destroyed or overwritten, it will invoke delete on its underlying pointer.

Member Typedef Documentation

template<class X , class ACE_LOCK >
typedef ACE_Bound_Ptr_Counter<ACE_LOCK> ACE_Strong_Bound_Ptr< X, ACE_LOCK >::COUNTER
private
template<class X , class ACE_LOCK >
typedef X ACE_Strong_Bound_Ptr< X, ACE_LOCK >::X_t
private

Constructor & Destructor Documentation

template<class X , class ACE_LOCK >
ACE_Strong_Bound_Ptr< X, ACE_LOCK >::ACE_Strong_Bound_Ptr ( X *  p = 0)
inlineexplicit

Constructor that initializes an ACE_Strong_Bound_Ptr to point to the object <p> immediately.

template<class X , class ACE_LOCK >
ACE_Strong_Bound_Ptr< X, ACE_LOCK >::ACE_Strong_Bound_Ptr ( auto_ptr< X >  p)
inlineexplicit

Constructor that initializes an ACE_Strong_Bound_Ptr by stealing ownership of an object from an auto_ptr.

template<class X , class ACE_LOCK >
ACE_Strong_Bound_Ptr< X, ACE_LOCK >::ACE_Strong_Bound_Ptr ( const ACE_Strong_Bound_Ptr< X, ACE_LOCK > &  r)
inline

Copy constructor binds this and r to the same object.

template<class X , class ACE_LOCK >
ACE_Strong_Bound_Ptr< X, ACE_LOCK >::ACE_Strong_Bound_Ptr ( const ACE_Weak_Bound_Ptr< X, ACE_LOCK > &  r)
inline

Constructor binds this and r to the same object.

template<class X , class ACE_LOCK >
template<class Y >
ACE_Strong_Bound_Ptr< X, ACE_LOCK >::ACE_Strong_Bound_Ptr ( const ACE_Strong_Bound_Ptr< Y, ACE_LOCK > &  r)
inline

Copy constructor binds this and r to the same object if Y* can be implicitly converted to X*.

template<class X , class ACE_LOCK >
ACE_Strong_Bound_Ptr< X, ACE_LOCK >::~ACE_Strong_Bound_Ptr ( void  )
inline

Destructor.

Member Function Documentation

template<class X , class ACE_LOCK >
X * ACE_Strong_Bound_Ptr< X, ACE_LOCK >::get ( void  ) const
inline

Get the pointer value.

template<class X , class ACE_LOCK >
bool ACE_Strong_Bound_Ptr< X, ACE_LOCK >::null ( void  ) const
inline

Allows us to check for NULL on all ACE_Strong_Bound_Ptr objects.

template<class X , class ACE_LOCK >
bool ACE_Strong_Bound_Ptr< X, ACE_LOCK >::operator!= ( const ACE_Strong_Bound_Ptr< X, ACE_LOCK > &  r) const
inline

Inequality operator, which is the opposite of equality.

template<class X , class ACE_LOCK >
bool ACE_Strong_Bound_Ptr< X, ACE_LOCK >::operator!= ( const ACE_Weak_Bound_Ptr< X, ACE_LOCK > &  r) const
inline

Inequality operator, which is the opposite of equality.

template<class X , class ACE_LOCK >
bool ACE_Strong_Bound_Ptr< X, ACE_LOCK >::operator!= ( X *  p) const
inline

Inequality operator, which is the opposite of equality.

template<class X , class ACE_LOCK >
X & ACE_Strong_Bound_Ptr< X, ACE_LOCK >::operator* ( void  ) const
inline

Dereference operator.

template<class X , class ACE_LOCK >
X * ACE_Strong_Bound_Ptr< X, ACE_LOCK >::operator-> ( void  ) const
inline

Redirection operator.

template<class X , class ACE_LOCK >
void ACE_Strong_Bound_Ptr< X, ACE_LOCK >::operator= ( const ACE_Strong_Bound_Ptr< X, ACE_LOCK > &  r)
inline

Assignment operator that binds this and r to the same object.

template<class X , class ACE_LOCK >
void ACE_Strong_Bound_Ptr< X, ACE_LOCK >::operator= ( const ACE_Weak_Bound_Ptr< X, ACE_LOCK > &  r)
inline

Assignment operator that binds this and r to the same object.

template<class X , class ACE_LOCK >
template<class Y >
ACE_Weak_Bound_Ptr<X, ACE_LOCK>& ACE_Strong_Bound_Ptr< X, ACE_LOCK >::operator= ( const ACE_Strong_Bound_Ptr< Y, ACE_LOCK > &  r)
inline

Assignment operator that binds this and r to the same object if Y* can be implicitly converted to X*.

template<class X , class ACE_LOCK >
bool ACE_Strong_Bound_Ptr< X, ACE_LOCK >::operator== ( const ACE_Strong_Bound_Ptr< X, ACE_LOCK > &  r) const
inline

Equality operator that returns true if both ACE_Strong_Bound_Ptr instances point to the same underlying object.

Note
It also returns true if both objects have just been instantiated and not used yet.
template<class X , class ACE_LOCK >
bool ACE_Strong_Bound_Ptr< X, ACE_LOCK >::operator== ( const ACE_Weak_Bound_Ptr< X, ACE_LOCK > &  r) const
inline

Equality operator that returns true if the ACE_Strong_Bound_Ptr and ACE_Weak_Bound_Ptr objects point to the same underlying object.

Note
It also returns true if both objects have just been instantiated and not used yet.
template<class X , class ACE_LOCK >
bool ACE_Strong_Bound_Ptr< X, ACE_LOCK >::operator== ( X *  p) const
inline

Equality operator that returns true if the ACE_Strong_Bound_Ptr and the raw pointer point to the same underlying object.

template<class X , class ACE_LOCK >
void ACE_Strong_Bound_Ptr< X, ACE_LOCK >::reset ( X *  p = 0)
inline

Resets the ACE_Strong_Bound_Ptr to refer to a different underlying object.

template<class X , class ACE_LOCK >
void ACE_Strong_Bound_Ptr< X, ACE_LOCK >::reset ( auto_ptr< X >  p)
inline

Resets the ACE_Strong_Bound_Ptr to refer to a different underlying object, ownership of which is stolen from the auto_ptr.

Friends And Related Function Documentation

template<class X , class ACE_LOCK >
template<class Y , class L >
friend class ACE_Strong_Bound_Ptr
friend
template<class X , class ACE_LOCK >
friend class ACE_Weak_Bound_Ptr< X, ACE_LOCK >
friend

Member Data Documentation

template<class X , class ACE_LOCK >
ACE_Strong_Bound_Ptr< X, ACE_LOCK >::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

template<class X , class ACE_LOCK >
COUNTER* ACE_Strong_Bound_Ptr< X, ACE_LOCK >::counter_
private

The reference counter.

template<class X , class ACE_LOCK >
X* ACE_Strong_Bound_Ptr< X, ACE_LOCK >::ptr_
private

The underlying object.


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