IPoolBase Interface

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

An interface that defines the behaviour and properties of a serialisable object pool.

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 IPoolBase : IObjectPool

The IPoolBase type exposes the following members.

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. (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.)
	IsInitialised	Gets a value indicating whether the pool has been initialised.
	MaximumSize	Gets or sets the maximum size of the pool, which is the maximum number of objects it can contain. (Inherited from IObjectPool.)
	Statistics	Gets an object containing general operational statistics about the pool.

Methods

	Name	Description
	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.)
	Initialise	Initialises the pool, populating it with the initial number of objects.
	SetSize	Sets the number of objects contained by the pool, either destroying excess pooled objects, or instantiating new ones. (Inherited from IObjectPool.)

Events

	Name	Description
	CanAcquireChanged	Occurs when the value of CanAcquire changes.
	CountChanged	Occurs when Count changes.
	Destroyed	Occurs when the pool is destroyed.
	Initialised	Occurs when the pool is initialised.