CasCap.Common.Abstractions 4.17.0

CasCap.Common.Abstractions

Shared contracts for .NET configuration, background features, caching, notifications, event sinks and telemetry.

Installation

dotnet add package CasCap.Common.Abstractions

Target frameworks: netstandard2.0, net8.0, net9.0, net10.0

Usage

Implement IAppConfig to give a configuration type a section name. On .NET 8+, the interface requires that static property:

using CasCap.Common.Abstractions;

public sealed record ExampleConfig : IAppConfig
{
    public static string ConfigurationSectionName => "Example";
    public bool Enabled { get; init; }
}

This package supplies contracts and shared models; it does not load application configuration or start background features by itself. Use CasCap.Common.Configuration for binding and CasCap.Common.Services for feature execution.

Public Contracts

Shared Models

Probe tag conversion is supplied by CasCap.Common.Extensions.Diagnostics.HealthChecks, not this package.

Event Sink Registration

On .NET 8+, decorate sink implementations with [SinkType("Console")], enable the matching AvailableSinks entry, and call services.AddEventSinks<TEvent>(sinkConfig, assemblies). Registration discovers implementations; it does not dispatch events. The application resolves the registered IEventSink<TEvent> instances and invokes their write methods.

The write-path contract is:

string SinkType { get; }
Task InitializeAsync(CancellationToken cancellationToken);
Task WriteEvent(T @event, CancellationToken cancellationToken = default);
Task HousekeepingAsync(IReadOnlyCollection<string> validIds, CancellationToken cancellationToken = default);

SinkType should match the attribute's name. On .NET 8+, initialization and housekeeping have default no-op implementations. On .NET Standard 2.0, implement all interface methods explicitly.

An application can define additional query interfaces in a CasCap namespace. AddEventSinks registers those interfaces against the enabled QuerySinkType when supported by that sink, otherwise the last registered compatible sink. The "Primary" keyed alias identifies the selected query sink. Every sink enabled in the registration remains available through the write-path enumeration; query-capable fallback registrations from earlier calls may be replaced.

Configuration Examples

The application chooses the section name and binds SinkConfig; registration does not bind it automatically or supply concrete sink implementations.

One Enabled Sink

{
  "Sinks": {
    "AvailableSinks": {
      "Console": { "Enabled": true }
    }
  }
}

Write to Multiple Sinks with a Preferred Query Sink

{
  "Sinks": {
    "QuerySinkType": "Redis",
    "AvailableSinks": {
      "Console": { "Enabled": true },
      "Redis": { "Enabled": true }
    }
  }
}

ApiAuthConfig binds under CasCap:ApiAuthConfig; its Username and Password must be non-empty. Supply them through a secret provider. AnonymousPathPrefixes defaults to ["/healthz"].