PvWay.AgentPoolManager.nc8 1.0.0

Agent Pool Manager Core

Manages a pool of background services (agents) that keep repeating at a given interval until they are requested to stop.

This lets your Web application runs a pool of tasks in the background.

Interfaces

This nuGet has only one public class implementing the following interface

IPvWayAgentPoolManager

namespace PvWay.AgentPoolManager.Abstraction.nc8;

public interface IPvWayAgentPoolManager
{
    IEnumerable<IPvWayAgentPoolManagerAgent> Agents { get; }

    IPvWayAgentPoolManagerAgent? GetAgent(Guid id);

    IPvWayAgentPoolManagerAgent StartAgent<T>(
        string title,
        Action<T> repeat,
        T workerParam,
        TimeSpan sleepSpan,
        ThreadPriority priority = ThreadPriority.Normal,
        Action<IPvWayAgentPoolManagerAgent>? stopCallback = null);

    IPvWayAgentPoolManagerAgent StartAgent(
        string title,
        Action repeat,
        TimeSpan sleepSpan,
        ThreadPriority priority = ThreadPriority.Normal,
        Action<IPvWayAgentPoolManagerAgent>? stopCallback = null);
}

IPvWayAgentPoolManagerAgent

namespace PvWay.AgentPoolManager.Abstraction.nc8;

public interface IPvWayAgentPoolManagerAgent
{
    Guid Id { get; }
    DateTime StartTimeUtc { get; }
    string Title { get; }
    void RequestToStop();
}

Injection & factory

using Microsoft.Extensions.DependencyInjection;
using pvWay.agentPoolManager.Abstractions.nc8;
using pvWay.agentPoolManager.nc8;

namespace pvWay.agentPoolManager.nc8;

public static class PvWayAgentPoolManager
{
    public static void AddPvWayAgentPoolManager(
        this IServiceCollection services,
        ServiceLifetime lifetime = ServiceLifetime.Singleton)
    {
        var sd = new ServiceDescriptor(
            typeof(IPvWayAgentPoolManager), 
            typeof(PoolManager),
            lifetime);
        services.Add(sd);
    }

    public static IPvWayAgentPoolManager Create() => new PoolManager();
}

Usage

See here after a short Console that use the pool

Principe

• Create a method (with or without parameter) that you want to repeatedly invoke in background
• Determine the interval of time between two invocations of your method
• Instantiate the PoolManager (you can wrap/inject this class into/as a Singleton)
• Add your method into the Agent Pool and in return get a IAgent reference
• Stop the method at any time by calling the IAgent RequestToStop method

The following example shows the code for a simple clock pulsar that write the time in the console every 5 seconds.

The code

using pvWay.agentPoolManager.nc8;

Console.WriteLine("Hello, AgentPool");

var apm = PvWayAgentPoolManager.Create();

var pulsar = apm.StartAgent(
    // the name of the asynchronous agent
    "pulsar",
    // the method to repeat asynchronously
    Pulsar,
    // the string param passed to the Pulsar method
    "clock",
    // time between each invocation
    TimeSpan.FromSeconds(5),
    // the priority
    ThreadPriority.Normal,
    // the lambda that is called when the pulsar is stopped
    agent => Console.WriteLine($"{agent.Title} is stopped"));

Console.WriteLine("hit a key to stop");
Console.ReadKey();

pulsar.RequestToStop();

return;

static void Pulsar(string prefix)
{
    Console.WriteLine($"{prefix}-{DateTime.Now:HH:mm:ss}");
}

Happy coding