GenericObjectPoolT Class |
[This is preliminary documentation and is subject to change.]
A generic implementation of an object pool, that allows for recycling and reuse of objects of type T.
Inheritance HierarchyNamespace: Umbrace.Unity.PurePool
Assembly: Umbrace.Unity.PurePool (in Umbrace.Unity.PurePool.dll) Version: 0.0.0.0 (1.0.0.0)
SyntaxC#
public class GenericObjectPool<T> : IObjectPool<T>, IObjectPool
Type Parameters
- T
- The type of object being pooled.
The GenericObjectPoolT type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | GenericObjectPoolT |
Initialises a new instance of the GenericObjectPoolT class.
|
| GenericObjectPoolT(FuncT) |
Initialises a new instance of the GenericObjectPoolT class.
|
| GenericObjectPoolT(Int32, Int32) |
Initialises a new instance of the GenericObjectPoolT class.
|
| GenericObjectPoolT(FuncT, Int32, Int32) |
Initialises a new instance of the GenericObjectPoolT class.
|
Properties| Name | Description | |
|---|---|---|
 | CanAcquire | Gets a value indicating whether an instance can be acquired from the pool. An instance can be acquired when the pool contains at least one instance, or when InstantiateWhenEmpty is . |
| Count |
Gets the number of objects currently contained by the pool.
|
| InstantiateWhenEmpty |
Gets or sets a value indicating whether to instantiate a new object when the pool is empty, and an attempt is made to acquire from the pool.
|
| IsEmpty |
Gets a value indicating whether the pool is empty and contains no objects.
|
| IsFull |
Gets a value indicating whether the pool is full, and cannot contain any more objects.
|
| Items |
Gets a list of items currently contained by the pool.
|
| LogMessages |
Gets or sets the level of log messaging that the pool will output.
|
| MaximumSize |
Gets or sets the maximum size of the pool, which is the maximum number of objects it can contain.
|
| RecordStatistics |
Gets or sets a value indicating whether to record pool statistics.
|
| Statistics |
Gets an object containing general operational statistics about the pool.
|
Methods| Name | Description | |
|---|---|---|
| Acquire |
Acquires an object from the pool.
|
| Clear |
Clears the pool, emptying it of all pooled objects.
|
| Contains |
Determines whether an instance is in the pool.
|
| Equals | (Inherited from Object.) |
| Fill |
Fills the pool, populating it with pooled objects until it reaches the maximum pool size.
|
 | Finalize | (Inherited from Object.) |
| GetHashCode | (Inherited from Object.) |
| GetItems |
Gets a list of items currently contained by the pool, and stores them in the specified ListT.
|
| GetType | (Inherited from Object.) |
| MemberwiseClone | (Inherited from Object.) |
| OnCanAcquireChanged |
Raises the CanAcquireChanged event.
|
| OnCountChanged |
Raises the CountChanged event.
|
| OnObjectAcquired |
Raises the ObjectAcquired event.
|
| OnObjectDestroyed |
Raises the ObjectDestroyed event.
|
| OnObjectInstantiated |
Raises the ObjectInstantiated event.
|
| OnObjectReleased |
Raises the ObjectReleased event.
|
| Release |
Releases an object back to the pool.
|
| Remove |
Removes the specified instance from the pool.
|
| SetSize |
Sets the number of objects contained by the pool, either destroying excess pooled objects, or instantiating new ones.
|
| ToString | (Inherited from Object.) |
| TryAcquire |
Acquires an object from the pool.
|
Events| Name | Description | |
|---|---|---|
 | CanAcquireChanged |
Occurs when the value of CanAcquire changes.
|
| CountChanged |
Occurs when Count changes.
|
| ObjectAcquired |
Occurs when an object is acquired from the pool.
|
| ObjectDestroyed |
Occurs when an object is destroyed.
|
| ObjectInstantiated |
Occurs when a new object is instantiated.
|
| ObjectReleased |
Occurs when an object is released back to the pool.
|
Fields| Name | Description | |
|---|---|---|
  | DefaultInitialSize |
The default initial size of newly-created pools.
|
| DefaultMaximumSize |
The default maximum size of newly-created pools.
|
See Also