IObjectPoolT Interface |
[This is preliminary documentation and is subject to change.]
Defines an interface for the pooling and recycling of objects of type T.
Namespace: Umbrace.Unity.PurePool
Assembly: Umbrace.Unity.PurePool (in Umbrace.Unity.PurePool.dll) Version: 0.0.0.0 (1.0.0.0)
SyntaxC#
public interface IObjectPool<T> : IObjectPool
Type Parameters
- T
- The type of object being pooled.
The IObjectPoolT type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Count |
Gets the number of objects currently contained by the pool.
(Inherited from IObjectPool.) |
| InstantiateWhenEmpty |
Gets or sets a value indicating whether the pool should instantiate a new object when the pool is empty, and an attempt is made to acquire from the pool.
(Inherited from IObjectPool.) |
| Items |
Gets a list of items currently contained by the pool.
|
| MaximumSize |
Gets or sets the maximum size of the pool, which is the maximum number of objects it can contain.
(Inherited from IObjectPool.) |
Methods| Name | Description | |
|---|---|---|
 | Acquire |
Acquires an object from the pool.
|
| Clear |
Clears the pool, emptying it of all pooled objects.
(Inherited from IObjectPool.) |
| Fill |
Fills the pool, populating it with pooled objects until it reaches the maximum pool size.
(Inherited from IObjectPool.) |
| GetItems |
Gets a list of items currently contained by the pool, and stores them in the specified ListT.
|
| Release |
Releases an object back to the pool.
|
| SetSize |
Sets the number of objects contained by the pool, either destroying excess pooled objects, or instantiating new ones.
(Inherited from IObjectPool.) |
| TryAcquire |
Acquires an object from the pool.
|
See Also