Class bdlcc::SharedObjectPool_Rep

Quick Links:

bal | bbl | bdl | bsl

#include <bdlcc_sharedobjectpool.h>

Inheritance diagram for bdlcc::SharedObjectPool_Rep< TYPE, RESETTER >:

List of all members.

Public Member Functions
template<class CREATOR >
	SharedObjectPool_Rep (CREATOR objectCreator, const bslalg::ConstructorProxy< RESETTER > &objectResetter, PoolType pool, bslma::Allocator *basicAllocator)
	~SharedObjectPool_Rep ()
virtual void	disposeRep ()
virtual void	disposeObject ()
void	reset ()
virtual void *	getDeleter (const std::type_info &type)
virtual void *	originalPtr () const
TYPE *	ptr ()
void	acquireRef ()
void	acquireWeakRef ()
void	incrementRefs (int incrementAmount=1)
void	releaseRef ()
void	releaseWeakRef ()
void	resetCountsRaw (int numSharedReferences, int numWeakReferences)
bool	tryAcquireRef ()
bool	hasUniqueOwner () const
int	numReferences () const
int	numWeakReferences () const
Static Public Member Functions
static void	managedPtrDeleter (void , void rep)
static void	managedPtrEmptyDeleter (void , void rep)

template<class TYPE, class RESETTER>
class bdlcc::SharedObjectPool_Rep< TYPE, RESETTER >

Constructor & Destructor Documentation

template<class TYPE , class RESETTER >

template<class CREATOR >

bdlcc::SharedObjectPool_Rep< TYPE, RESETTER >::SharedObjectPool_Rep	(	CREATOR *	objectCreator,
		const bslalg::ConstructorProxy< RESETTER > &	objectResetter,
		PoolType *	pool,
		bslma::Allocator *	basicAllocator
	)

Construct a new rep object that, upon release, will invoke the specified objectResetter and return itself to the specified pool; then invoke objectCreator to construct an object of TYPE embedded within the new rep object. Use the specified basicAllocator to supply memory. If basicAllocator is 0, the currently installed default allocator is used.

template<class TYPE , class RESETTER >

bdlcc::SharedObjectPool_Rep< TYPE, RESETTER >::~SharedObjectPool_Rep ( )

Destroy this representation object and the embedded instance of TYPE.

Member Function Documentation

template<class TYPE , class RESETTER >

virtual void bdlcc::SharedObjectPool_Rep< TYPE, RESETTER >::disposeRep ( ) [virtual]

Release this representation object. This method is invoked when the number of weak references and the number of strong references reach zero. This virtual override will return the object, and this representation, to the associated pool.

Implements bslma::SharedPtrRep.

template<class TYPE , class RESETTER >

virtual void bdlcc::SharedObjectPool_Rep< TYPE, RESETTER >::disposeObject ( ) [virtual]

Release the object being managed by this representation. This method is invoked when the number of strong references reaches zero. Note that if there are any weak references to the shared object then this function does nothing, including not destroying the object or returning it to the pool.

Implements bslma::SharedPtrRep.

template<class TYPE , class RESETTER >

void bdlcc::SharedObjectPool_Rep< TYPE, RESETTER >::reset ( )

Invoke the object resetter specified at construction on the associated object.

template<class TYPE , class RESETTER >

virtual void* bdlcc::SharedObjectPool_Rep< TYPE, RESETTER >::getDeleter ( const std::type_info & type ) [virtual]

Return NULL. Shared object pools strictly control the delete policy for their objects, and do not expose it to end users.

Implements bslma::SharedPtrRep.

template<class TYPE , class RESETTER >

virtual void* bdlcc::SharedObjectPool_Rep< TYPE, RESETTER >::originalPtr ( ) const [virtual]

Return (untyped) address of the object managed by this representation. This virtual override effectively returns "(void*)ptr()".

Implements bslma::SharedPtrRep.

template<class TYPE , class RESETTER >

TYPE* bdlcc::SharedObjectPool_Rep< TYPE, RESETTER >::ptr ( )

Return a pointer to the in-place object.

static void bslma::SharedPtrRep::managedPtrDeleter	(	void *	,
		void *	rep
	)			`[static, inherited]`

Release the shared reference to an object held by the SharedPtrRep object that is pointed to be by specified rep. The behavior is undefined unless rep points to an object whose complete type publicly and unambiguously derives from SharedPtrRep. Note that the first argument is ignored. Also note that this function serves as the ManagedPtr deleter when converting a bsl::shared_ptr to a bslma::ManagedPtr.

static void bslma::SharedPtrRep::managedPtrEmptyDeleter	(	void *	,
		void *	rep
	)			`[static, inherited]`

This function has no effect. The behavior is undefined unless rep is null. Note that this function serves as the managed ptr deleter when converting an empty or null bsl::shared_ptr to a bslma::ManagedPtr.

void bslma::SharedPtrRep::acquireRef ( ) [inherited]

Atomically acquire a shared reference to the shared object referred to by this representation. The behavior is undefined unless 0 < numReferences().

void bslma::SharedPtrRep::acquireWeakRef ( ) [inherited]

Atomically acquire a weak reference to the shared object referred to by this representation. The behavior is undefined unless 0 < numWeakReferences() || 0 < numReferences().

void bslma::SharedPtrRep::incrementRefs ( int incrementAmount = 1 ) [inherited]

Atomically increment the number of shared references to the shared object referred to by this representation by the optionally specified incrementAmount. The behavior is undefined unless 0 < incrementAmount and 0 < numReferences().

DEPRECATED: Use acquireRef instead.

void bslma::SharedPtrRep::releaseRef ( ) [inherited]

Atomically release a shared reference to the shared object referred to by this representation, disposing of the shared object if all the shared references to that object are released, and disposing of this representation if all (shared and weak) references to that object are released. The behavior is undefined unless 0 < numReferences().

void bslma::SharedPtrRep::releaseWeakRef ( ) [inherited]

Atomically release a weak reference to the shared object referred to by this representation, disposing of this representation if all (shared and weak) references to the shared object are released. The behavior is undefined unless 0 < numWeakReferences().

void bslma::SharedPtrRep::resetCountsRaw	(	int	numSharedReferences,
		int	numWeakReferences
	)			`[inherited]`

Reset the number of shared references and the number of weak references stored by this representation to the specified numSharedReferences and numWeakReferences respectively. This function is not thread-safe and users must ensure that they serialize access to the SharedPtrRep object when calling this function. Note that this function updates the counts, but does not dispose of the representation or the object irrespective of the values of numSharedReferences and numWeakReferences.

bool bslma::SharedPtrRep::tryAcquireRef ( ) [inherited]

Atomically acquire a shared reference to the shared object referred to by this representation, if the number of shared references is greater than 0, and do nothing otherwise. Return true if the acquire succeeds, and false otherwise. The behavior is undefined unless 0 < numWeakReferences() || 0 < numReferences().

bool bslma::SharedPtrRep::hasUniqueOwner ( ) const [inherited]

Return true if there is only one shared reference and no weak references to the object referred to by this representation, and false otherwise.

int bslma::SharedPtrRep::numReferences ( ) const [inherited]

Return a "snapshot" of the current number of shared references to the shared object referred to by this representation object.

int bslma::SharedPtrRep::numWeakReferences ( ) const [inherited]

Return a "snapshot" of the current number of weak references to the shared object referred to by this representation object.

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

bdlcc_sharedobjectpool.h