AsyncResourcePool 1.2.0

Thread-safe, non-blocking, managed pool of re-usable resources, with a specified minimum and optional maximum number of resources, and optional expiry time for resources to be cleaned up if not used for a time.

Install-Package AsyncResourcePool -Version 1.2.0
dotnet add package AsyncResourcePool --version 1.2.0
<PackageReference Include="AsyncResourcePool" Version="1.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add AsyncResourcePool --version 1.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: AsyncResourcePool, 1.2.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install AsyncResourcePool as a Cake Addin
#addin nuget:?package=AsyncResourcePool&version=1.2.0

// Install AsyncResourcePool as a Cake Tool
#tool nuget:?package=AsyncResourcePool&version=1.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

AsyncResourcePool

Thread-safe, non-blocking, managed pool of re-usable resources, with a specified minimum and optional maximum number of resources, and optional expiry time for resources to be cleaned up if not used for a time.

Installation

dotnet add package AsyncResourcePool

Options

Behaviour of AsyncResourcePool can be specified using AsyncResourcePoolOptions.

Property Default Description
MinNumResources N/A The minimum number of resources that will be maintained by the pool. This number of resources will be created regardless of whether or not they are requested. If a resource is requested an allocated, an additional resource will be created to maintain the pool size.
MaxNumResources int.MaxValue The maximum number of resources that the pool is allowed to create.
ResourcesExpireAfter null If a resource is unused for this time, it will be dispsosed. If this causes the number of available resources to drop below the minimum, additional resources will be created to replace the disposed ones.
MaxNumResourceCreationAttempts 3 Maximum number of attempts for creating a resource before an exception is thrown and passed back to the requestor
ResourceCreationRetryInterval 1 second Amount of time to wait after a failed resource creation attempt before trying again

Example usage: Connection Pool for Snowflake Connector for .NET

https://github.com/snowflakedb/snowflake-connector-net

  1. Define a ConnectionPool class which consumes AsyncResourcePool internally
public sealed class ConnectionPool
{
    private readonly IAsyncResourcePool<SnowflakeDbConnection> _resourcePool;

    public ConnectionPool(string connectionString)
    {
        var connectionFactory = GetConnectionFactoryFunc(connectionString);

        var asyncResourcePoolOptions = new AsyncResourcePoolOptions(
            minNumResources: 20,
            resourcesExpireAfter: TimeSpan.FromMinutes(15));

        _resourcePool = new AsyncResourcePool<SnowflakeDbConnection>(connectionFactory, asyncResourcePoolOptions);
    }

    public Task<ReusableResource<SnowflakeDbConnection>> Get(CancellationToken cancellationToken) => _resourcePool.Get(cancellationToken);

    public void Dispose() => _resourcePool.Dispose();

    private static Func<Task<SnowflakeDbConnection>> GetConnectionFactoryFunc(string connectionString)
    {
        return async () =>
        {
            var conn = new SnowflakeDbConnection
            {
                ConnectionString = connectionString
            };

            await conn.OpenAsync();

            return conn;
        };
    }
}
  1. Optionally register ConnectionPool as Singleton in dependency injection configuration
services.AddSingleton<ConnectionPool>(sp => new ConnectionPool(...));
  1. Consume ConnectionPool
public class ConnectionConsumer
{
    private readonly ConnectionPool _connectionPool;

    public ConnectionConsumer(ConnectionPool connectionPool) {
        _connectionPool = connectionPool;
    }

    public async Task DoSomething(CancellationToken cancellationToken) {
        using (var reusableConnection = await _connectionPool.Get(cancellationToken)) {
            var connection = reusableConnection.Resource;
            // Do something with the connection
        }
    }
} 

AsyncResourcePool

Thread-safe, non-blocking, managed pool of re-usable resources, with a specified minimum and optional maximum number of resources, and optional expiry time for resources to be cleaned up if not used for a time.

Installation

dotnet add package AsyncResourcePool

Options

Behaviour of AsyncResourcePool can be specified using AsyncResourcePoolOptions.

Property Default Description
MinNumResources N/A The minimum number of resources that will be maintained by the pool. This number of resources will be created regardless of whether or not they are requested. If a resource is requested an allocated, an additional resource will be created to maintain the pool size.
MaxNumResources int.MaxValue The maximum number of resources that the pool is allowed to create.
ResourcesExpireAfter null If a resource is unused for this time, it will be dispsosed. If this causes the number of available resources to drop below the minimum, additional resources will be created to replace the disposed ones.
MaxNumResourceCreationAttempts 3 Maximum number of attempts for creating a resource before an exception is thrown and passed back to the requestor
ResourceCreationRetryInterval 1 second Amount of time to wait after a failed resource creation attempt before trying again

Example usage: Connection Pool for Snowflake Connector for .NET

https://github.com/snowflakedb/snowflake-connector-net

  1. Define a ConnectionPool class which consumes AsyncResourcePool internally
public sealed class ConnectionPool
{
    private readonly IAsyncResourcePool<SnowflakeDbConnection> _resourcePool;

    public ConnectionPool(string connectionString)
    {
        var connectionFactory = GetConnectionFactoryFunc(connectionString);

        var asyncResourcePoolOptions = new AsyncResourcePoolOptions(
            minNumResources: 20,
            resourcesExpireAfter: TimeSpan.FromMinutes(15));

        _resourcePool = new AsyncResourcePool<SnowflakeDbConnection>(connectionFactory, asyncResourcePoolOptions);
    }

    public Task<ReusableResource<SnowflakeDbConnection>> Get(CancellationToken cancellationToken) => _resourcePool.Get(cancellationToken);

    public void Dispose() => _resourcePool.Dispose();

    private static Func<Task<SnowflakeDbConnection>> GetConnectionFactoryFunc(string connectionString)
    {
        return async () =>
        {
            var conn = new SnowflakeDbConnection
            {
                ConnectionString = connectionString
            };

            await conn.OpenAsync();

            return conn;
        };
    }
}
  1. Optionally register ConnectionPool as Singleton in dependency injection configuration
services.AddSingleton<ConnectionPool>(sp => new ConnectionPool(...));
  1. Consume ConnectionPool
public class ConnectionConsumer
{
    private readonly ConnectionPool _connectionPool;

    public ConnectionConsumer(ConnectionPool connectionPool) {
        _connectionPool = connectionPool;
    }

    public async Task DoSomething(CancellationToken cancellationToken) {
        using (var reusableConnection = await _connectionPool.Get(cancellationToken)) {
            var connection = reusableConnection.Resource;
            // Do something with the connection
        }
    }
} 

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
1.2.0 254 4/20/2021
1.1.1 3,482 9/8/2020
1.1.0 165 9/8/2020
1.0.0 308 6/29/2019