DiskQueue 1.1.0
See the version list below for details.
dotnet add package DiskQueue --version 1.1.0
NuGet\Install-Package DiskQueue -Version 1.1.0
<PackageReference Include="DiskQueue" Version="1.1.0" />
paket add DiskQueue --version 1.1.0
#r "nuget: DiskQueue, 1.1.0"
// Install DiskQueue as a Cake Addin #addin nuget:?package=DiskQueue&version=1.1.0 // Install DiskQueue as a Cake Tool #tool nuget:?package=DiskQueue&version=1.1.0
DiskQueue
A thread-safe, multi-process(ish) persistent queue, based very heavily on http://ayende.com/blog/3479/rhino-queues-storage-disk .
Requirements and Environment
Works on .Net 4+ and Mono 2.10.8+ (3.0.6+ recommended)
Requires access to filesystem storage
Basic Usage
PersistentQueue.WaitFor(...)
is the main entry point. This will attempt to gain an exclusive lock on the given storage location. On first use, a directory will be created with the required files inside it.- This queue object can be shared among threads. Each thread should call
OpenSession()
to get its own session object. - Both
IPersistentQueue
s andIPersistentQueueSession
s should be wrapped inusing()
clauses, or otherwise disposed of properly.
Example
Queue on one thread, consume on another; retry some exceptions.
Note this is one queue being shared between two sessions. You should not open two queue instances for one storage location at once.
IPersistentQueue queue = new PersistentQueue("queue_a");
var t1 = new Thread(() =>
{
while (HaveWork())
{
using (var session = queue.OpenSession())
{
session.Enqueue(NextWorkItem());
session.Flush();
}
}
});
var t2 = new Thread(()=> {
while (true) {
using (var session = queue.OpenSession()) {
var data = session.Dequeue();
if (data == null) {Thread.Sleep(100); continue;}
try {
MaybeDoWork(data)
session.Flush();
} catch (RetryException) {
continue;
} catch {
session.Flush();
}
}
}
});
t1.Start();
t2.Start();
Example
Batch up a load of work and have another thread work through it.
IPersistentQueue queue = new PersistentQueue("batchQueue");
var worker = new Thread(()=> {
using (var session = queue.OpenSession()) {
byte[] data;
while ((data = session.Dequeue()) != null) {
MaybeDoWork(data)
session.Flush();
}
}
});
using (var session = queue.OpenSession()) {
foreach (var item in LoadsOfStuff()) {
session.Enqueue(item);
}
session.Flush();
}
worker.IsBackground = true; // anything not complete when we close will be left on the queue for next time.
worker.Start();
Transactions
Each session is a transaction. Any Enqueues or Dequeues will be rolled back when the session is disposed unless
you call session.Flush()
. Data will only be visible between threads once it has been flushed.
Each flush incurs a performance penalty. By default, each flush is persisted to disk before continuing. You
can get more speed at a safety cost by setting queue.ParanoidFlushing = false;
Data loss and transaction truncation
By default, DiskQueue will silently discard transaction blocks that have been truncated; it will throw an InvalidOperationException
when transaction block markers are overwritten (this happens if more than one process is using the queue by mistake. It can also happen with some kinds of disk corruption).
If you construct your queue with throwOnConflict: false
, all recoverable transaction errors will be silently truncated. This should only be used when
uptime is more important than data consistency.
using (var queue = new PersistentQueue(path, Constants._32Megabytes, throwOnConflict: false)) {
. . .
}
Multi-Process Usage
Each IPersistentQueue
gives exclusive access to the storage until it is disposed.
There is a static helper method PersistentQueue.WaitFor("path", TimeSpan...)
which will wait to gain access until
other processes release the lock or the timeout expires.
If each process uses the lock for a short time and wait long enough, they can share a storage location.
E.g.
...
void AddToQueue(byte[] data) {
Thread.Sleep(150);
using (var queue = PersistentQueue.WaitFor(SharedStorage, TimeSpan.FromSeconds(30)))
using (var session = queue.OpenSession()) {
session.Enqueue(data);
session.Flush();
}
}
byte[] ReadQueue() {
Thread.Sleep(150);
using (var queue = PersistentQueue.WaitFor(SharedStorage, TimeSpan.FromSeconds(30)))
using (var session = queue.OpenSession()) {
var data = session.Dequeue();
session.Flush();
return data;
}
}
...
If you need the transaction semantics of sessions across multiple processes, try a more robust solution like https://github.com/i-e-b/SevenDigital.Messaging
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET Framework | net40 is compatible. net403 was computed. net45 was computed. 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. |
This package has 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.7.1 | 38,402 | 12/13/2023 |
1.7.0 | 12,066 | 8/24/2023 |
1.6.8 | 8,849 | 4/18/2023 |
1.6.7 | 1,934 | 3/15/2023 |
1.6.6 | 248 | 3/14/2023 |
1.6.5 | 8,857 | 1/13/2023 |
1.6.4 | 432 | 12/19/2022 |
1.6.3 | 388 | 12/7/2022 |
1.6.2 | 373 | 12/5/2022 |
1.6.1 | 332 | 12/5/2022 |
1.6.0 | 2,904 | 7/22/2022 |
1.5.0 | 7,307 | 4/6/2022 |
1.4.0 | 2,643 | 3/16/2022 |
1.3.2 | 10,696 | 7/16/2021 |
1.3.1 | 7,089 | 2/10/2021 |
1.3.0 | 2,882 | 9/14/2020 |
1.2.0 | 39,662 | 8/6/2018 |
1.1.0 | 3,555 | 2/22/2018 |
1.0.0 | 21,580 | 9/3/2015 |