CodeProject.ObjectPool 6.5.0

This package has a SemVer 2.0.0 package version: 6.5.0+e24dde14.
dotnet add package CodeProject.ObjectPool --version 6.5.0
NuGet\Install-Package CodeProject.ObjectPool -Version 6.5.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="CodeProject.ObjectPool" Version="6.5.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add CodeProject.ObjectPool --version 6.5.0
#r "nuget: CodeProject.ObjectPool, 6.5.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install CodeProject.ObjectPool as a Cake Addin
#addin nuget:?package=CodeProject.ObjectPool&version=6.5.0

// Install CodeProject.ObjectPool as a Cake Tool
#tool nuget:?package=CodeProject.ObjectPool&version=6.5.0

Object Pool

License: MIT Donate Docs NuGet version NuGet downloads

standard-readme compliant GitLab pipeline status Quality gate Code coverage Renovate enabled

A generic, concurrent, portable and flexible Object Pool for .NET, completely based on the Code Project article of Ofir Makmal.

Library is feature complete and no further development is planned on this project, except for routine maintenance and bug fixes.

Original source code has been modified, in order to introduce:

  • A Parameterized Object Pool, already drafted by Ofir Makmal in the comments of the article.
  • A Timed Object Pool, where objects are automatically removed after a period of inactivity.
  • Memory Stream and String Builder pools.
    • For use cases which might involve very large memory streams, I suggest to use the Microsoft.IO.RecyclableMemoryStream library from Microsoft. It eliminates Large Object Heap allocations, which this library does not do.

Moreover, a few unit tests have been added, in order to improve code reliability, and a lot of other small changes have also been applied.

Of course, all modified source code is freely available in this repository.

Many thanks to Ofir Makmal for his great work.

Table of Contents

Install

NuGet package CodeProject.ObjectPool is available for download:

dotnet add package CodeProject.ObjectPool

An adapter for Microsoft.Extensions.ObjectPool is also available on NuGet:

dotnet add package CodeProject.ObjectPool.MicrosoftExtensionsAdapter

Usage

Quick and dirty example:

/// <summary>
///   Example usages of ObjectPool.
/// </summary>
internal static class Program
{
    /// <summary>
    ///   Example usages of ObjectPool.
    /// </summary>
    private static void Main()
    {
        // Creating a pool with a maximum size of 25, using custom Factory method to create and
        // instance of ExpensiveResource.
        var pool = new ObjectPool<ExpensiveResource>(25, () => new ExpensiveResource(/* resource specific initialization */));

        using (var resource = pool.GetObject())
        {
            // Using the resource...
            resource.DoStuff();
        } // Exiting the using scope will return the object back to the pool.

        // Creating a pool with wrapper object for managing external resources, that is, classes
        // which cannot inherit from PooledObject.
        var newPool = new ObjectPool<PooledObjectWrapper<ExternalExpensiveResource>>(() =>
            new PooledObjectWrapper<ExternalExpensiveResource>(CreateNewResource())
            {
                OnReleaseResources = ExternalResourceReleaseResource,
                OnResetState = ExternalResourceResetState
            });

        using (var wrapper = newPool.GetObject())
        {
            // wrapper.InternalResource contains the object that you pooled.
            wrapper.InternalResource.DoOtherStuff();
        } // Exiting the using scope will return the object back to the pool.

        // Creates a pool where objects which have not been used for over 2 seconds will be
        // cleaned up by a dedicated thread.
        var timedPool = new TimedObjectPool<ExpensiveResource>(TimeSpan.FromSeconds(2));

        using (var resource = timedPool.GetObject())
        {
            // Using the resource...
            resource.DoStuff();
        } // Exiting the using scope will return the object back to the pool and record last usage.

        Console.WriteLine($"Timed pool size after 0 seconds: {timedPool.ObjectsInPoolCount}"); // Should be 1
        Thread.Sleep(TimeSpan.FromSeconds(4));
        Console.WriteLine($"Timed pool size after 4 seconds: {timedPool.ObjectsInPoolCount}"); // Should be 0

        // Adapts a timed pool to Microsoft Extensions abstraction.
        var mPool = ObjectPoolAdapter.CreateForPooledObject(timedPool);

        // Example usage of Microsoft pool.
        var mResource = mPool.Get();
        Debug.Assert(mResource != null);
        mPool.Return(mResource);

        // Adapts a new pool to Microsoft Extensions abstraction. This example shows how to adapt
        // when object type does not extend PooledObject.
        var mPool2 = ObjectPoolAdapter.Create(new ObjectPool<PooledObjectWrapper<MemoryStream>>(
            () => PooledObjectWrapper.Create(new MemoryStream())));

        // Example usage of second Microsoft pool.
        var mResource2 = mPool2.Get();
        Debug.Assert(mResource2 != null);
        mPool2.Return(mResource2);

        Console.Read();
    }

    private static ExternalExpensiveResource CreateNewResource()
    {
        return new ExternalExpensiveResource();
    }

    public static void ExternalResourceResetState(ExternalExpensiveResource resource)
    {
        // External Resource reset state code.
    }

    public static void ExternalResourceReleaseResource(ExternalExpensiveResource resource)
    {
        // External Resource release code.
    }
}

internal sealed class ExpensiveResource : PooledObject
{
    public ExpensiveResource()
    {
        OnReleaseResources = () =>
        {
            // Called if the resource needs to be manually cleaned before the memory is reclaimed.
        };

        OnResetState = () =>
        {
            // Called if the resource needs resetting before it is getting back into the pool.
        };
    }

    public void DoStuff()
    {
        // Do some work here, for example.
    }
}

internal sealed class ExternalExpensiveResource
{
    public void DoOtherStuff()
    {
        // Do some work here, for example.
    }
}

Async support

Starting from v4, Object Pool supports async pooled object initialization. Therefore, objects can be retrieved in two ways:

obj = pool.GetObject();
obj = await pool.GetObjectAsync();

Those methods depend on the factory method specified during pool initialization. Because making async factories "sync" is usually a problem, which can lead to deadlocks, we have the following situation:

Factory type GetObject GeObjectAsync
Not specified OK OK, uses a result task
Sync OK OK, uses a result task
Async KO, throws an exception OK

So, to sum it up:

  • If a sync factory is specified, both retrieval methods can be used.
  • If an async factory is specified, only the async retrieval can be used.

Maintainers

@pomma89.

Contributing

MRs accepted.

Small note: If editing the README, please conform to the standard-readme specification.

Editing

Visual Studio Code, with Remote Containers extension, is the recommended way to work on this project.

A development container has been configured with all required tools.

Visual Studio Community is also supported and an updated solution file, object-pool.sln, has been provided.

Restoring dependencies

When opening the development container, dependencies should be automatically restored.

Anyway, dependencies can be restored with following command:

dotnet restore

Running tests

Tests can be run with following command:

dotnet test

Tests can also be run with following command, which collects coverage information:

./build.sh --target run-tests

License

MIT © 2013-2023 PommaLabs Team and Contributors

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 2.0

    • No dependencies.
  • net8.0

    • No dependencies.

NuGet packages (3)

Showing the top 3 NuGet packages that depend on CodeProject.ObjectPool:

Package Downloads
StackExchange.Redis.ConnectionPool

StackExchange.Redis‘s ConnectionPool.

CodeProject.ObjectPool.MicrosoftExtensionsAdapter

A generic, concurrent, portable and flexible Object Pool for .NET. This package contains an adapter for Microsoft.Extensions.ObjectPool abstraction.

Chain.Redis.Extensions

增加key是否存在判断

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on CodeProject.ObjectPool:

Repository Stars
Difegue/Stylophone
A pretty cool™️ MPD client in .NET. Based on MpcNET.
Version Downloads Last updated
6.5.0 17,147 2/15/2024
6.4.0 11,433 11/16/2023
6.3.0 17,784 4/13/2023
6.2.0 14,109 12/18/2022
6.1.1 18,799 10/25/2022
6.1.0 17,281 11/20/2021
6.0.0 2,834 11/3/2021
5.0.5 5,053 11/1/2021
5.0.4 261 9/26/2021
5.0.3 2,129 6/13/2021
5.0.2 7,499 12/26/2020
5.0.1 9,544 11/14/2020
5.0.0 5,701 11/1/2020
4.0.2 35,209 2/23/2020
4.0.1 16,231 6/22/2019
3.2.4 6,858 6/13/2019
3.2.3 2,053 5/12/2019
3.2.2 167,432 10/28/2017
3.2.1 43,168 9/30/2017
3.2.0 1,211 8/17/2017
3.1.1 1,087 7/3/2017
3.1.0 1,097 6/26/2017
3.0.3 3,757 4/8/2017
2.2.2 1,648 1/8/2017
2.2.1 1,414 12/18/2016
2.1.1 26,454 9/18/2016
2.1.0 1,190 9/18/2016
2.0.5 1,358 8/23/2016
2.0.4 1,089 8/20/2016
2.0.2 1,457 8/20/2016
2.0.1 1,469 8/7/2016
1.10.1 21,055 2/27/2016
1.9.0 2,545 10/11/2015
1.8.0 2,279 9/12/2015
1.7.0 4,172 9/6/2015
1.6.0 5,357 5/16/2015
1.5.0 1,159 5/2/2015
1.3.5 2,362 4/12/2015
1.3.3 1,221 4/4/2015
1.3.1 10,626 1/6/2015
1.3.0 1,709 1/5/2015
1.0.8 1,426 12/8/2014
1.0.6 7,892 9/6/2014
1.0.5 1,196 8/19/2014
1.0.4 3,633 8/18/2014