SWEN3.Paperless.RabbitMq
1.0.3
dotnet add package SWEN3.Paperless.RabbitMq --version 1.0.3
NuGet\Install-Package SWEN3.Paperless.RabbitMq -Version 1.0.3
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="SWEN3.Paperless.RabbitMq" Version="1.0.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="SWEN3.Paperless.RabbitMq" Version="1.0.3" />
<PackageReference Include="SWEN3.Paperless.RabbitMq" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add SWEN3.Paperless.RabbitMq --version 1.0.3
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: SWEN3.Paperless.RabbitMq, 1.0.3"
#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.
#:package SWEN3.Paperless.RabbitMq@1.0.3
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=SWEN3.Paperless.RabbitMq&version=1.0.3
#tool nuget:?package=SWEN3.Paperless.RabbitMq&version=1.0.3
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
SWEN3.Paperless.RabbitMq
RabbitMQ messaging library for .NET with SSE support.
Configuration
<EnablePreviewFeatures>true</EnablePreviewFeatures>
{
"RabbitMQ": {
"Uri": "amqp://guest:guest@localhost:5672"
}
}
Usage
Basic Setup
// Add RabbitMQ
builder.Services.AddPaperlessRabbitMq(builder.Configuration);
// With SSE support
builder.Services.AddPaperlessRabbitMq(configuration, includeOcrResultStream: true);
Publishing
var command = new OcrCommand(docId, fileName, storagePath);
await publisher.PublishOcrCommandAsync(command);
var result = new OcrEvent(jobId, "Completed", text, DateTimeOffset.UtcNow);
await publisher.PublishOcrEventAsync(result);
Consuming
await using var consumer = await factory.CreateConsumerAsync<OcrCommand>();
await foreach (var command in consumer.ConsumeAsync(cancellationToken))
{
try
{
// Process message
await consumer.AckAsync();
}
catch
{
await consumer.NackAsync(requeue: true);
}
}
SSE Endpoint
// Map endpoint
app.MapOcrEventStream();
// Client-side
const eventSource = new EventSource('/api/v1/ocr-results');
eventSource.addEventListener('ocr-completed', (event) => {
const data = JSON.parse(event.data);
console.log(data);
});
Message Types
public record OcrCommand(Guid JobId, string FileName, string FilePath);
public record OcrEvent(Guid JobId, string Status, string? Text, DateTimeOffset ProcessedAt);
Installation
dotnet add package SWEN3.Paperless.RabbitMq
License
This project is licensed under the MIT License.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net10.0
- RabbitMQ.Client (>= 7.1.2)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.