IObjectPoolBase

Description

interface Tinman.Core.System.IObjectPoolBase

Non-generic base interface for classes that perform memory pooling of objects.

The value returned by IMemoryConsumption.MemoryConsumption is an estimate of the amount of memory used by the objects that reside in the cache. Pooled objects that are in flight are not included, i.e. objects that have been taken from the pool and have not yet been returned.

See also

ObjectPoolUtil

Public / Methods

Clear


public method Clear → ()

Clears the object pool.

Statistics


public method Statistics → ()

returns → ObjectPoolStats

The pool statistics.

Fetches the pool statistics that have been accumulated since the last call.

Public / Attributes

Limit​Count


public attribute LimitCount → (get)

value : int32

[>=0]
The limit or 0 if unlimited.

The limit for the maximum number of objects that may be present in the pool.

Limit​Memory


public attribute LimitMemory → (get)

value : int64

[>=0]
The limit in bytes or 0 if unlimited.

The limit for the maximum amount of memory consumed by the objects in the pool.

Name


[Constant]
public attribute Name → (get)

value : string

[not-empty]
The object pool name.

The human-readable name of the object pool, for debugging purposes.