Headless.DistributedLocks.Abstractions 0.4.15

.NET 10.0

dotnet add package Headless.DistributedLocks.Abstractions --version 0.4.15

NuGet\Install-Package Headless.DistributedLocks.Abstractions -Version 0.4.15

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Headless.DistributedLocks.Abstractions" Version="0.4.15" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Headless.DistributedLocks.Abstractions" Version="0.4.15" />
                    

                            Directory.Packages.props

<PackageReference Include="Headless.DistributedLocks.Abstractions" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add Headless.DistributedLocks.Abstractions --version 0.4.15

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Headless.DistributedLocks.Abstractions, 0.4.15"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package Headless.DistributedLocks.Abstractions@0.4.15

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=Headless.DistributedLocks.Abstractions&version=0.4.15
                    

                            Install as a Cake Addin

#tool nuget:?package=Headless.DistributedLocks.Abstractions&version=0.4.15
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Headless.DistributedLocks.Abstractions

Defines the unified interface for distributed resource locking.

Problem Solved

Provides a provider-agnostic distributed locking API, enabling coordination across multiple instances with features like lock expiration, renewal, and throttling without changing application code.

Key Features

IDistributedLockProvider - Regular locking with expiration
IDistributedLock - Acquired lock handle with release
IThrottlingDistributedLockProvider - Rate-limited locking
IDistributedThrottlingLock - Throttling lock handle
Configurable timeouts and expiration

Installation

dotnet add package Headless.DistributedLocks.Abstractions

Usage

public sealed class OrderService(IDistributedLockProvider lockProvider)
{
    public async Task ProcessOrderAsync(Guid orderId, CancellationToken ct)
    {
        var lockResource = $"order:{orderId}";

        await using var @lock = await lockProvider.TryAcquireAsync(
            lockResource,
            timeUntilExpires: TimeSpan.FromMinutes(5),
            acquireTimeout: TimeSpan.FromSeconds(30),
            ct
        );

        if (@lock is null)
            throw new ConcurrencyException("Could not acquire lock");

        // Process order safely...
    }
}

Configuration

No configuration required. This is an abstractions-only package.

Dependencies

None.

Side Effects

None.

Product	Compatible and additional computed target framework versions.
.NET	net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.