Table of Contents

Class ObjectPool<T>

Namespace
LinqToDB.Internal.Common
Assembly
linq2db.dll

Generic implementation of object pooling pattern with predefined pool size limit. The main purpose is that limited number of frequently used objects can be kept in the pool for further recycling.

Notes:

  1. it is not the goal to keep all returned objects. Pool is not meant for storage. If there is no space in the pool, extra returned objects will be dropped.

  2. it is implied that if object was obtained from a pool, the caller will return it back in a relatively short time. Keeping checked out objects for long durations is ok, but reduces usefulness of pooling. Just new up your own.

Not returning objects to the pool in not detrimental to the pool's work, but is a bad practice. Rationale: If there is no intent for reusing the object, do not use pool - just use "new".

public sealed class ObjectPool<T> where T : class

Type Parameters

T
Inheritance
object
ObjectPool<T>
Extension Methods

Constructors

ObjectPool(Func<T>, Action<T>, int)

public ObjectPool(Func<T> factory, Action<T> cleanup, int size)

Parameters

factory Func<T>
cleanup Action<T>
size int

Methods

Allocate()

Produces an instance.

public ObjectPool<T>.RentedElement Allocate()

Returns

ObjectPool<T>.RentedElement

Remarks

Search strategy is a simple linear probing which is chosen for it cache-friendliness. Note that Free will try to store recycled objects close to the start thus statistically reducing how far we will typically search.