[#BloombergLP-bdlcc-SharedObjectPool_Rep]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlcc.adoc[bdlcc]::SharedObjectPool&lowbar;Rep
:relfileprefix: ../../
:mrdocs:

Shared pointer representation object used by `SharedObjectPool`&period;

== Synopsis

Declared in `&lt;bdlcc&lowbar;sharedobjectpool&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;
    class TYPE,
    class RESETTER&gt;
class SharedObjectPool&lowbar;Rep
    : public xref:BloombergLP/bslma/SharedPtrRep.adoc[bslma::SharedPtrRep]
----

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bslma/SharedPtrRep.adoc[bslma::SharedPtrRep]`
| This class provides a partially implemented shared pointer representation (&quot;letter&quot;) protocol&period; The class provides two counters for storing the number of shared and weak references, and functions to increment and decrement these counters&period; In addition, this class provides protocol methods that allow concrete implementations to specify what action should be taken when these counts reach zero&period; The function `disposeRep` is responsible for destroying this object, it is called when the reference count to this object reaches zero&period; Thus, the destructor of this object is declared as protected and should never be invoked&period;
|===

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlcc/SharedObjectPool_Rep/2constructor.adoc[`SharedObjectPool&lowbar;Rep`]         [.small]#[constructor]#
| Construct a new rep object that, upon release, will invoke the specified `objectResetter` and return itself to the specified `pool`&semi; then invoke `objectCreator` to construct an object of `TYPE` embedded within the new rep object&period; Use the specified `basicAllocator` to supply memory&period; If `basicAllocator` is 0, the currently installed default allocator is used&period;
| xref:BloombergLP/bdlcc/SharedObjectPool_Rep/2destructor.adoc[`&#126;SharedObjectPool&lowbar;Rep`] [.small]#[destructor]# [.small]#[virtual]#
| Destroy this representation object and the embedded instance of `TYPE`&period;
| xref:BloombergLP/bslma/SharedPtrRep/acquireRef.adoc[`acquireRef`] 
| Atomically acquire a shared reference to the shared object referred to by this representation&period; The behavior is undefined unless `0 &lt; numReferences()`&period;
| xref:BloombergLP/bslma/SharedPtrRep/acquireWeakRef.adoc[`acquireWeakRef`] 
| Atomically acquire a weak reference to the shared object referred to by this representation&period; The behavior is undefined unless `0 &lt; numWeakReferences() &verbar;&verbar; 0 &lt; numReferences()`&period;
| xref:BloombergLP/bdlcc/SharedObjectPool_Rep/disposeObject.adoc[`disposeObject`]  [.small]#[virtual]#
| Release the object being managed by this representation&period; This method is invoked when the number of strong references reaches zero&period; 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&period;
| xref:BloombergLP/bdlcc/SharedObjectPool_Rep/disposeRep.adoc[`disposeRep`]  [.small]#[virtual]#
| Release this representation object&period; This method is invoked when the number of weak references and the number of strong references reach zero&period; This virtual override will return the object, and this representation, to the associated pool&period;
| xref:BloombergLP/bdlcc/SharedObjectPool_Rep/getDeleter.adoc[`getDeleter`]  [.small]#[virtual]#
| Return NULL&period; Shared object pools strictly control the delete policy for their objects, and do not expose it to end users&period;
| xref:BloombergLP/bslma/SharedPtrRep/hasUniqueOwner.adoc[`hasUniqueOwner`] 
| Return `true` if there is only one shared reference and no weak references to the object referred to by this representation, and `false` otherwise&period;
| xref:BloombergLP/bslma/SharedPtrRep/incrementRefs.adoc[`incrementRefs`] 
| Atomically increment the number of shared references to the shared object referred to by this representation by the optionally specified `incrementAmount`&period; The behavior is undefined unless `0 &lt; incrementAmount` and `0 &lt; numReferences()`&period;
| xref:BloombergLP/bslma/SharedPtrRep/numReferences.adoc[`numReferences`] 
| Return a &quot;snapshot&quot; of the current number of shared references to the shared object referred to by this representation object&period;
| xref:BloombergLP/bslma/SharedPtrRep/numWeakReferences.adoc[`numWeakReferences`] 
| Return a &quot;snapshot&quot; of the current number of weak references to the shared object referred to by this representation object&period;
| xref:BloombergLP/bdlcc/SharedObjectPool_Rep/originalPtr.adoc[`originalPtr`]  [.small]#[virtual]#
| Return (untyped) address of the object managed by this representation&period; This virtual override effectively returns &quot;(void&ast;)ptr()&quot;&period;
| xref:BloombergLP/bdlcc/SharedObjectPool_Rep/ptr.adoc[`ptr`] 
| Return a pointer to the in&hyphen;place object&period;
| xref:BloombergLP/bslma/SharedPtrRep/releaseRef.adoc[`releaseRef`] 
| 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&period; The behavior is undefined unless `0 &lt; numReferences()`&period;
| xref:BloombergLP/bslma/SharedPtrRep/releaseWeakRef.adoc[`releaseWeakRef`] 
| 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&period; The behavior is undefined unless `0 &lt; numWeakReferences()`&period;
| xref:BloombergLP/bdlcc/SharedObjectPool_Rep/reset.adoc[`reset`] 
| Invoke the object resetter specified at construction on the associated object&period;
| xref:BloombergLP/bslma/SharedPtrRep/resetCountsRaw.adoc[`resetCountsRaw`] 
| Reset the number of shared references and the number of weak references stored by this representation to the specified `numSharedReferences` and `numWeakReferences` respectively&period; This function is _not_ thread&hyphen;safe and users must ensure that they serialize access to the `SharedPtrRep` object when calling this function&period; 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`&period;
| xref:BloombergLP/bslma/SharedPtrRep/tryAcquireRef.adoc[`tryAcquireRef`] 
| 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&period; Return `true` if the acquire succeeds, and `false` otherwise&period; The behavior is undefined unless `0 &lt; numWeakReferences() &verbar;&verbar; 0 &lt; numReferences()`&period;
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslma/SharedPtrRep/managedPtrDeleter.adoc[`managedPtrDeleter`] 
| Release the shared reference to an object held by the `SharedPtrRep` object that is pointed to be by specified `rep`&period; The behavior is undefined unless `rep` points to an object whose complete type publicly and unambiguously derives from `SharedPtrRep`&period; Note that the first argument is ignored&period; Also note that this function serves as the `ManagedPtr` deleter when converting a `bsl&colon;&colon;shared&lowbar;ptr` to a `bslma&colon;&colon;ManagedPtr`&period;
| xref:BloombergLP/bslma/SharedPtrRep/managedPtrEmptyDeleter.adoc[`managedPtrEmptyDeleter`] 
| This function has no effect&period; The behavior is undefined unless `rep` is null&period; Note that this function serves as the managed ptr deleter when converting an empty or null `bsl&colon;&colon;shared&lowbar;ptr` to a `bslma&colon;&colon;ManagedPtr`&period;
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#
