class ObjectPool in Tinman.Core.System

A thread-safe object pool that is capable of properly pooling IDisposable object.

class	ObjectPool	with	<T>
		extends	ObjectPoolBase
		base of	ByteBufferPool

See also:

SimpleObjectPool

Public / Attributes

DebugInterval

Sets the time interval to use for logging usage statistics of this object pool.

public property	DebugInterval { get set }
type	int32
value	[>=0]	The debug interval, in seconds. Set to 0 to disable.
inherited	ObjectPoolBase.DebugInterval

Remarks:

Log messages are emitted in the category Tinman.Core.System.ObjectPool using the Info message level. Each log message carries the following information:

N:00000 D:00000 G:52992 P:52814 C:00414/01024 S:00000/00000 (RenderStateSequencer_Batch)

where the individual numbers have this meaning (referring to the time interval since the last log message):

• N: Number of newly created pool objects (the pool has underflowed).
• D: Number of deleted pool objects (the pool has overflowed).
• G: Number of objects taken from the pool.
• P: Number of objects returned to the pool.
• C: Maximum number of objects taken from the pool without returning (left), object count limit of the pool (right).
• S: Maximum size of objects taken from the pool without returning (left), memory size limit in KB of the pool (right).

The default value is 0 (i.e. disabled).

LifecycleState

Returns the lifecycle state of this object.

public virtual property	LifecycleState { get }
type	LifecycleState
value		The lifecycle state.
inherited	Disposable.LifecycleState

LimitCount

The maximum number of pooled objects.

public property	LimitCount { get set }
type	int32
value	[>=0]	The maximum number limit. Set to 0 to disable it.
inherited	ObjectPoolBase.LimitCount

LimitMemory

The maximum amount of memory to use for pooled objects (estimated).

public property	LimitMemory { get set }
type	int32
value	[>=0]	The maximum memory limit. Set to 0 to disable it.
inherited	ObjectPoolBase.LimitMemory

See also:

IMemoryConsumption

Public / Constructors

ObjectPool

Creates a new instance of ObjectPool.

public constructor	ObjectPool (string name, IObjectPoolFactory<T> factory, int32 maximumCount = 0, int32 maximumMemory = 0, [Owner] Monitor monitor = null)
params	name	[not-empty]	The name of this object pool.
	factory	[not-null]	The pool object factory to use.
	maximumCount	[>=0]	Maximum number of pooled objects to hold. Set to 0 to disable. Defaults to 0.
	maximumMemory	[>=0]	Maximum memory to hold with pooled objects (estimated). Set to 0 to disable. Defaults to 0.
	monitor		The monitor object to use for synchronization or null to use a private instance.

Public / Methods

AcquireTry

Acquires a strong reference to this disposable object.

[OwnerReturn, ThreadSafe]
public method	AcquireTry ()
type	IDisposable
returns			this if a new strong reference has been acquired, null if this object is already being disposed.
inherited	Disposable.AcquireTry

Remarks:

The object will not be actually disposed by calls to Dispose when there is at least one strong reference left. Code that calls the AcquireTry method is responsible for calling the Dispose method accordingly.

This method is not intended to be used in performance-critical code. It should only be used to high-level resource management.

Clear

Clears the object pool.

public method

Clear ()

ClearThreadSafe

Clears the object pool.

[ThreadSafe]
public method	ClearThreadSafe ()

DebugIntervalTick

public method	DebugIntervalTick ()
inherited	ObjectPoolBase.DebugIntervalTick

Dispose

Releases all resources held by this object if there are no more strong references to it, decrements the reference counter by one otherwise.

[Dispose, OwnerThis, ThreadSafe]
public method	Dispose ()
inherited	Disposable.Dispose

Remarks:

The Dispose method silently returns if the object has already been disposed.

Get

Fetches a pooled object.

public method	Get ()
type	T
returns		[not-null]	The pooled object.

GetThreadSafe

Fetches a pooled object.

[ThreadSafe]
public method	GetThreadSafe ()
type	T
returns		[not-null]	The pooled object.

Put

Puts the given pooled object back.

public method	Put (T obj)
params	obj	[not-null]	The pooled object to put back.

PutThreadSafe

Puts the given pooled object back.

[ThreadSafe]
public method	PutThreadSafe (T obj)
params	obj	[not-null]	The pooled object to put back.

Protected / Methods

DisposeManaged

Disposes the managed resources held by a concrete subclass. This method will be called at most once per subclass.

protected override method	DisposeManaged ()
overrides	ObjectPoolBase.DisposeManaged

Remarks:

This method will only be called when a disposable object is explicitly destroyed by user code calling the Dispose method. It will not be called when the object is collected as garbage by the system.

Overriding methods must call the DisposeManaged method of their base class. The base call should be the last statement.

The DisposeManaged method is called before the DisposeUnmanaged method.

DisposeUnmanaged

Disposes the unmanaged resources held by a concrete subclass. This method will be called exactly once per subclass.

protected virtual method	DisposeUnmanaged ()
inherited	Disposable.DisposeUnmanaged

Remarks:

Overriding methods must call the DisposeUnmanaged method of their base class. The base call should be the last statement.

The DisposeUnmanaged method is called after the DisposeManaged method.