Xabe.FileLock

0.00

.NET Standard library providing exclusive lock on file.

Don’t worry about parallel access to the same file from multiple instances of your application. Synchronize access to file in multiple time-zones and programs. Easy to use, completely free and open source library to avoid getting System.IO.IOException: file used by another process

Category:

Description

Documentation

Install the Xabe.FileLock via NuGet:

Install-Package Xabe.FileLock
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.

Recommended using

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

License

Xabe.FileLock is licensed under MIT license.


MIT License

Copyright (c) 2017 Tomasz Zmuda

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.