Xabe.FileLock.WithTimeout 2.1.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package Xabe.FileLock.WithTimeout --version 2.1.0
NuGet\Install-Package Xabe.FileLock.WithTimeout -Version 2.1.0
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="Xabe.FileLock.WithTimeout" Version="2.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Xabe.FileLock.WithTimeout --version 2.1.0
#r "nuget: Xabe.FileLock.WithTimeout, 2.1.0"
#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 Xabe.FileLock.WithTimeout as a Cake Addin
#addin nuget:?package=Xabe.FileLock.WithTimeout&version=2.1.0

// Install Xabe.FileLock.WithTimeout as a Cake Tool
#tool nuget:?package=Xabe.FileLock.WithTimeout&version=2.1.0


.NET Standard library providing exclusive lock on file. Additional functionality to acquire this lock with a timeout. Forked from: Xabe.Filelock


Install the Xabe.FileLock.WithTimeout NuGet package via nuget:

PM> Install-Package Xabe.FileLock.WithTimeout

Creating file lock:

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

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

Last parameter is optional and defines if lock should be automatically refreshing before expired.

If file already has lock file, and it time haven't expired, method returns false.

ILock fileLock = new FileLock(file);
if(await fileLock.TryAcquire(TimeSpan.FromSeconds(15), true))
		// file operations here

Timeout functionality

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

ILockWithTimeout fileLock = new FileLockWithTimeout(file);
if (await fileLock.TryAcquireOrTimeout(TimeSpan.FromSeconds(15), TimeSpan.FromSeconds(30))
        // file operations here
    // things to do if timeout happens


Xabe.FileLock.WithTimeout 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 is compatible.  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 was computed.  netstandard2.1 was computed. 
.NET Framework net46 is compatible.  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.
  • .NETCoreApp 2.0

    • No dependencies.
  • .NETFramework 4.6

    • No dependencies.
  • .NETStandard 1.3

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
2.1.3 795 1/29/2019
2.1.2 603 1/24/2019
2.1.1 648 1/15/2019
2.1.0 612 1/15/2019
2.0.0 662 1/14/2019