ResilientFileLock 1.0.1

Cross-platform library providing exclusive lock on file, with timeout functionality. Based on: https://xabe.net/product/xabe_filelock/

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.

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.

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.

  • .NETFramework 4.5

    • No dependencies.
  • .NETStandard 1.3

  • .NETStandard 2.0

    • No dependencies.

Version History

Version Downloads Last updated
1.0.1 74 3/22/2019
1.0.0 65 3/22/2019