Singleton Service

Singleton services are a type of service that is instantiated once and shared across the entire application. This means that there is only one instance of the service, and it is used by all components that depend on it. Singleton services are useful for managing shared resources or state that should be consistent across the application.

Example Definition

public class MySingletonService
{
    public string SomeValue { get; set; } = "Value";
}

Example Registration

public class MyPlugin(IDependencyService services) : IPlugin
{
    [Subscribe]
    public void OnPluginLoading(PluginLoadingEvent @event)
    {
        // This event is fired when any plugin is being loaded

        // Skip all other plugins load events except ours
        if (@event.Plugin != this)
            return;

        dependencies.Register(services =>
        {
            // Singleton services are instantiated once and shared across the entire application
            services.AddSingleton<MySingletonService>();
        });
    }
}

Example Injection

public class MyAnotherSingletonService(MySingletonService singletonService)
{
    public void DoSomething()
    {
        // Access your singleton service instance
        Console.WriteLine(singletonService.SomeValue);
    }
}