ResilientFileLock 1.0.1

.NET Standard 1.3 .NET Framework 4.5
Install-Package ResilientFileLock -Version 1.0.1
dotnet add package ResilientFileLock --version 1.0.1
<PackageReference Include="ResilientFileLock" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ResilientFileLock --version 1.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: ResilientFileLock, 1.0.1"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install ResilientFileLock as a Cake Addin
#addin nuget:?package=ResilientFileLock&version=1.0.1

// Install ResilientFileLock as a Cake Tool
#tool nuget:?package=ResilientFileLock&version=1.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

ResilientFileLock

.NET Standard library providing exclusive lock on file. Additional functionality to acquire this lock with a timeout. Based on: Xabe.Filelock. Highly recommended to check out that library first, this library adds timeout possibilities as well as some additional mechanism to ensure it works for different processes in different computers.

Using

Install the ResilientFileLock NuGet package via nuget:

PM> Install-Package ResilientFileLock

Creating file lock:

ILock fileLock = new FileLock(file);
fileLock.TryAcquire(TimeSpan.FromSeconds(15));

This will create lock file with extension ".lock" in the same directory. Example: "/tmp/data.txt" → "/tmp/data.lock".

Last two parameters are optional, the second last defines if lock should be automatically refreshing before expired. The last one is to provide cancellation.

If file already has lock file, and it time has not expired, method returns false.

Recommended using

using (fileLock = new FileLock(file))
{
    if (await fileLock.TryAcquire(TimeSpan.FromSeconds(15)))
    {
        // file operations here
    }
    else 
    {
        // if lock not acquired
    }
}

Timeout functionality

Similarly to the code above we can await the FileLock until timeout. Note that refreshing the lock could complicate things:

using (fileLock = new FileLock(file))
{
    if (await fileLock
            .WithTimeout(timeoutSpan: TimeSpan.FromSeconds(30), retrySpan: TimeSpan.FromSeconds(1))
            .TryAcquire(TimeSpan.FromSeconds(15)))
    {
        // file operations here
    }
    else 
    {
        // things to do if timeout happens
    }
}

License

ResilientFileLock is licensed under MIT - see License for details.

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp1.0 netcoreapp1.1 netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard1.3 netstandard1.4 netstandard1.5 netstandard1.6 netstandard2.0 netstandard2.1
.NET Framework net45 net451 net452 net46 net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen30 tizen40 tizen60
Universal Windows Platform uap uap10.0
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.
  • .NETFramework 4.5

    • No dependencies.
  • .NETStandard 1.3

  • .NETStandard 2.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.1 464 3/22/2019
1.0.0 336 3/22/2019