IObjectPool Interface

[This is preliminary documentation and is subject to change.]

Defines an interface for the pooling and recycling of objects.

Namespace: Umbrace.Unity.PurePool
Assembly: Umbrace.Unity.PurePool (in Umbrace.Unity.PurePool.dll) Version: 0.0.0.0 (1.0.0.0)

Syntax

public interface IObjectPool

The IObjectPool type exposes the following members.

Properties

	Name	Description
	Count	Gets the number of objects currently contained by the pool.
	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.
	MaximumSize	Gets or sets the maximum size of the pool, which is the maximum number of objects it can contain.

Methods

	Name	Description
	Clear	Clears the pool, emptying it of all pooled objects.
	Fill	Fills the pool, populating it with pooled objects until it reaches the maximum pool size.
	SetSize	Sets the number of objects contained by the pool, either destroying excess pooled objects, or instantiating new ones.