[#BloombergLP-bdlcc-ObjectPoolFunctors]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlcc.adoc[bdlcc]::ObjectPoolFunctors
:relfileprefix: ../../
:mrdocs:

This struct provides several functors that are suitable `RESETTER` parameter types for `ObjectPool`. It also provides a `typedef` that specifies the default `CREATOR` parameter type for `ObjectPool`.

== Synopsis

Declared in `<bdlcc_objectpool.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
struct ObjectPoolFunctors;
----

== Types

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlcc/ObjectPoolFunctors/Clear.adoc[`Clear`] 
| This fully‐inlined class, suitable as the `RESETTER` parameter type for `ObjectPool`, is a functor taking a pointer to the parameterized `TYPE` argument, and can be invoked as: `void(_)(TYPE_)`. It calls `clear` upon the provided object.
| xref:BloombergLP/bdlcc/ObjectPoolFunctors/Nil.adoc[`Nil`] 
| This fully‐inlined class, suitable as the `RESETTER` parameter type for `ObjectPool`, is a functor taking a pointer to the parameterized `TYPE` argument, and can be invoked as: `void(_)(TYPE_)`. It does nothing.
| xref:BloombergLP/bdlcc/ObjectPoolFunctors/RemoveAll.adoc[`RemoveAll`] 
| This fully‐inlined class, suitable as the `RESETTER` parameter type for `ObjectPool`, is a functor taking a pointer to the parameterized `TYPE` argument, and can be invoked as: `void(_)(TYPE_)`. It calls `removeAll` upon the provided object.
| xref:BloombergLP/bdlcc/ObjectPoolFunctors/Reset.adoc[`Reset`] 
| This fully‐inlined class, suitable as the `RESETTER` parameter type for `ObjectPool`, is a functor taking a pointer to the parameterized `TYPE` argument, and can be invoked as: `void(_)(TYPE_)`. It calls `reset` upon the provided object.
|===


== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlcc/ObjectPoolFunctors/DefaultCreator.adoc[`DefaultCreator`] 
| The default `CREATOR` parameter type for the `ObjectPool` class template.
|===



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