ResilientFileLock 1.0.1

dotnet add package ResilientFileLock --version 1.0.1
NuGet\Install-Package ResilientFileLock -Version 1.0.1
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="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
#r "nuget: ResilientFileLock, 1.0.1"
#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.
// 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

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.

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 Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp1.0 was computed.  netcoreapp1.1 was computed.  netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard1.3 is compatible.  netstandard1.4 was computed.  netstandard1.5 was computed.  netstandard1.6 was computed.  netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net45 is compatible.  net451 was computed.  net452 was computed.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen30 was computed.  tizen40 was computed.  tizen60 was computed. 
Universal Windows Platform uap was computed.  uap10.0 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
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 729 3/22/2019
1.0.0 476 3/22/2019