DotNetBaseQueue.RabbitMQ.Handler 1.0.2

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

// Install DotNetBaseQueue.RabbitMQ.Handler as a Cake Tool
#tool nuget:?package=DotNetBaseQueue.RabbitMQ.Handler&version=1.0.2                

DotNetBaseQueue

This library aims to facilitate the use of asynchronous processes in .NET projects, with an initial focus entirely on RabbitMQ.

Installation

Message Publishing

dotnet add package DotNetBaseQueue.RabbitMQ.Publish

Message Consumption by Handler

dotnet add package DotNetBaseQueue.RabbitMQ.Handler

Sending Messages

To send messages, add the following to your services:

builder.Services.AddQueuePublishSingleton(CONFIG_APPSETTINGS);

To send a message, use dependency injection to get the IQueuePublish interface and utilize the available method.

Example:

public class TestController : BaseController
{
    private readonly IQueuePublish _queuePublish;

    public TestController(IQueuePublish queuePublish)
    {
        _queuePublish = queuePublish;
    }

    [HttpPost]
    public IActionResult PostEntity(object obj)
    {
        _queuePublish.Publish(obj, CONFIG_PublishSectionQueue);

        return Ok();
    }

    [HttpPost]
    public IActionResult PostEntities(List<object> objects)
    {
        _queuePublish.PublishList(objects, CONFIG_PublishSectionQueue);

        return Ok();
    }
}

Adding a Consumer

  • The message object must implement the IRabbitEvent interface or IRabbitEventRetry (for using retry).

  • The class for message processing must implement the IRabbitEventHandler interface.

  • Add the consumer to your .NET services using the AddWorkerConfiguration and AddHandler Methods.

Example:

Startup:

services
    .AddWorkerConfiguration(configuration, CONFIG_APPSETTINGS)
    .AddHandler<SendMessageHandler, Message>(CONFIG);
public class Message : IQueueEvent
{
    public string SenderId { get; set; }
}

public class SendMessageHandler : IQueueEventHandler<Message>
{
    public async Task HandleAsync(Message command)
    {
        // Handle the message
    }
}

Configuring appsettings.json

You can configure the appsettings.json file as follows:

Base:

  "QueueConfiguration": {
    "HostName": "",
    "Port": 5672,
    "UserName": "",
    "Password": "",
    "VirtualHost": "/"
  },

Only handler config:

  "QueueConfiguration": {
    "ExchangeName": "",
    "ExchangeType": "direct",
    "RoutingKey": "",
    "QueueName": "",
    "NumberOfWorkroles": 1,
    "CreateDeadLetterQueue": true,
    "CreateRetryQueue": true,
    "SecondsToRetry": 15
  },

All:

  "QueueConfiguration": {
    "HostName": "",
    "Port": 5672,
    "VirtualHost": "/",
    "UserName": "",
    "Password": "",

    "ExchangeName": "",
    "ExchangeType": "direct",
    "RoutingKey": "",
    "QueueName": "",
    "NumberOfWorkroles": 1,
    "CreateDeadLetterQueue": true,
    "CreateRetryQueue": true,
    "SecondsToRetry": 15
  },
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 netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework 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 tizen40 was computed.  tizen60 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.

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.0.3 63 7/13/2024
1.0.2 57 7/13/2024
1.0.1 66 7/10/2024
1.0.0 63 7/10/2024