bslstl::SharedPtrAllocateInplaceRep< TYPE, ALLOCATOR > Class Template Reference

#include <bslstl_sharedptrallocateinplacerep.h>

Inheritance diagram for bslstl::SharedPtrAllocateInplaceRep< TYPE, ALLOCATOR >:

Detailed Description

template<class TYPE, class ALLOCATOR>
class bslstl::SharedPtrAllocateInplaceRep< TYPE, ALLOCATOR >

This class provides a concrete implementation of the SharedPtrRep protocol for in-place instances of the (template parameter) TYPE. Upon destruction of this object, the destructor of TYPE is invoked on the shared object.

See bslstl_sharedptrallocateinplacerep

Public Types
typedef ReboundTraits::allocator_type	ReboundAllocator

Public Member Functions
void	disposeObject () BSLS_KEYWORD_OVERRIDE
void	disposeRep () BSLS_KEYWORD_OVERRIDE
void *	getDeleter (const std::type_info &type) BSLS_KEYWORD_OVERRIDE
TYPE *	ptr ()
void *	originalPtr () const BSLS_KEYWORD_OVERRIDE

Static Public Member Functions
static SharedPtrAllocateInplaceRep *	makeRep (ReboundAllocator basicAllocator)

Member Typedef Documentation

ReboundAllocator

template<class TYPE , class ALLOCATOR >

typedef ReboundTraits::allocator_type bslstl::SharedPtrAllocateInplaceRep< TYPE, ALLOCATOR >::ReboundAllocator

Member Function Documentation

disposeObject()

template<class TYPE , class ALLOCATOR >

void bslstl::SharedPtrAllocateInplaceRep< TYPE, ALLOCATOR >::disposeObject ( )

inline

Destroy the object being referred to by this representation. This method is automatically invoked by releaseRef when the number of shared references reaches zero and should not be explicitly invoked otherwise.

disposeRep()

template<class TYPE , class ALLOCATOR >

void bslstl::SharedPtrAllocateInplaceRep< TYPE, ALLOCATOR >::disposeRep ( )

inline

Destroy this representation object and deallocate the associated memory. This method is automatically invoked by releaseRef and releaseWeakRef when the number of weak references and the number of shared references both reach zero and should not be explicitly invoked otherwise.

Precondition

The behavior is undefined unless disposeObject has already been called for this representation.

Note

Note that this method effectively serves as the representation object's destructor.

getDeleter()

template<class TYPE , class ALLOCATOR >

void * bslstl::SharedPtrAllocateInplaceRep< TYPE, ALLOCATOR >::getDeleter ( const std::type_info &  type )

inline

Ignore the specified type and return a null pointer.

Note

Note that there is no facility for the user to supply a deleter for an in-place representation for a shared pointer.

makeRep()

template<class TYPE , class ALLOCATOR >

SharedPtrAllocateInplaceRep< TYPE, ALLOCATOR > * bslstl::SharedPtrAllocateInplaceRep< TYPE, ALLOCATOR >::makeRep ( ReboundAllocator  basicAllocator )

inlinestatic

Create a SharedPtrAllocateInplaceRep object having storage for an in-place uninitialized object of (template parameter) TYPE, and return its address. Use the specified basicAllocator to supply memory and, upon a call to disposeRep, to destroy this representation (and the in-place shared object).

Note

Note that the function members ptr and originalPtr will return the address of an uninitialized object. This object should be explicitly initialized by the caller, and it is undefined behavior to call disposeRep until this object has been successfully constructed.

originalPtr()

template<class TYPE , class ALLOCATOR >

void * bslstl::SharedPtrAllocateInplaceRep< TYPE, ALLOCATOR >::originalPtr ( ) const

inline

Return the (untyped) address of the modifiable shared object to which this object refers.

ptr()

template<class TYPE , class ALLOCATOR >

TYPE * bslstl::SharedPtrAllocateInplaceRep< TYPE, ALLOCATOR >::ptr ( )

inline

Return the address of the modifiable shared object to which this object refers.

Note

Note that in order to return a pointer to a modifiable object, this function cannot be const qualified as the referenced object is stored internally as a data member.

---

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

• bslstl_sharedptrallocateinplacerep.h