LeasePool 0.1.0

LeasePool - V0.1.0

A simple, configurable, thread-safe Object Pool. Provides a mechanism for constructing, validating, and disposing of objects on the fly, as well limiting the maximum number of total instaiated object and auto-disposal of stale objects.

Usage

using LeasePool;

ILeasePool<Connection> pool = new LeasePool<Connection>(
    new LeasePoolConfig<Connection>()
    {
        // Allow a maximum of 10 connections to be open at once.
        MaxLeases = 10,
        // Automatically dispose of stale connections after 30 seconds.
        IdleTimeout = TimeSpan.FromSeconds(30),
        // Function to construct a new connection.
        Initializer = () => { 
            var connection = new Connection("hostname", "username", "password");
            connection.Open();
            return connection;
        },
        // Ensure that the connection is valid before leasing.
        Validator = (connection) => connection.IsConnected(),
        // Clear the history of the connection when returned to the pool.
        OnReturn = (connection) => connection.ClearHistory(),
        // Not actually needed, as the default Finalizer will
        // Call Dispose if T is IDisposable. Just for demo purposes.
        Finalizer = (connection) => connection.Dispose()
    }
);

// Get a connection from the pool, waiting up 
// to 2 seconds for one to become available.
using (var connection = await pool.Lease(TimeSpan.FromSeconds(2))) {
    // do something with connection
}