Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pardahlman/rawrabbit
A modern .NET framework for communication over RabbitMq
https://github.com/pardahlman/rawrabbit
async dotnetcore message-bus rabbitmq
Last synced: 21 days ago
JSON representation
A modern .NET framework for communication over RabbitMq
- Host: GitHub
- URL: https://github.com/pardahlman/rawrabbit
- Owner: pardahlman
- License: mit
- Created: 2015-10-18T05:26:11.000Z (about 9 years ago)
- Default Branch: 2.0
- Last Pushed: 2022-12-07T16:47:48.000Z (almost 2 years ago)
- Last Synced: 2024-05-06T09:34:37.777Z (7 months ago)
- Topics: async, dotnetcore, message-bus, rabbitmq
- Language: C#
- Homepage:
- Size: 1.65 MB
- Stars: 744
- Watchers: 56
- Forks: 143
- Open Issues: 57
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
_Looking for documentation of 1.x? [Click here](https://github.com/pardahlman/RawRabbit/tree/stable)_
# RawRabbit
[](https://ci.appveyor.com/project/pardahlman/rawrabbit) [](http://rawrabbit.readthedocs.org/) [](https://www.nuget.org/packages/RawRabbit) [](https://github.com/pardahlman/rawrabbit/releases/latest)
[](https://rawrabbit.herokuapp.com)
## Quick introduction
`RawRabbit` is a modern .NET framework for communication over [RabbitMQ](http://rabbitmq.com/). The modular design and middleware oriented architecture makes the client highly customizable while providing sensible default for topology, routing and more. Documentation for version 2.x of the is currently found under [`/docs`](https://github.com/pardahlman/RawRabbit/tree/2.0/docs).
### Configure, enrich and extend
`RawRabbit` is configured with `RawRabbitOptions`, an options object that makes it possible to register client configuration, plugins as well as override internal services
```csharp
var client = RawRabbitFactory.CreateSingleton(new RawRabbitOptions
{
ClientConfiguration = new ConfigurationBuilder()
.SetBasePath(Directory.GetCurrentDirectory())
.AddJsonFile("rawrabbit.json")
.Build()
.Get(),
Plugins = p => p
.UseProtobuf()
.UsePolly(c => c
.UsePolicy(queueBindPolicy, PolicyKeys.QueueBind)
.UsePolicy(queueDeclarePolicy, PolicyKeys.QueueDeclare)
.UsePolicy(exchangeDeclarePolicy, PolicyKeys.ExchangeDeclare)
),
DependencyInjection = ioc => ioc
.AddSingleton()
});
```
### Publish/Subscribe
Set up strongly typed publish/subscribe in just a few lines of code.
```csharp
var client = RawRabbitFactory.CreateSingleton();
await client.SubscribeAsync(async msg =>
{
Console.WriteLine($"Received: {msg.Prop}.");
});
await client.PublishAsync(new BasicMessage { Prop = "Hello, world!"});
```
### Request/Response
`RawRabbits` request/response (`RPC`) implementation uses the [direct reply-to feature](https://www.rabbitmq.com/direct-reply-to.html) for better performance and lower resource allocation.
```csharp
var client = RawRabbitFactory.CreateSingleton();
client.RespondAsync(async request =>
{
return new BasicResponse();
});
var response = await client.RequestAsync();
```
### Ack, Nack, Reject and Retry
Unlike many other clients, `basic.ack`, `basic.nack` and `basic.reject` are first class citizen in the message handler
```csharp
var client = RawRabbitFactory.CreateSingleton();
await client.SubscribeAsync(async msg =>
{
if(UnableToProcessMessage(msg))
{
return new Nack(requeue: true);
}
ProcessMessage(msg)
return new Ack();
});
```
In addition to the basic acknowledgements, RawRabbit also support delayed retries
```csharp
var client = RawRabbitFactory.CreateSingleton();
await client.SubscribeAsync(async msg =>
{
try
{
ProcessMessage(msg)
return new Ack();
}
catch (Exception e)
{
return Retry.In(TimeSpan.FromSeconds(30));
}
});
```
### Granular control for each call
Add or change properties in the `IPipeContext` to tailor calls for specific type of messages. This makes it possible to modifly the topology features for calls, publish confirm timeout, consumer concurrency and much more
```csharp
await subscriber.SubscribeAsync(received =>
{
receivedTcs.TrySetResult(received);
return Task.FromResult(true);
}, ctx => ctx
.UseSubscribeConfiguration(cfg => cfg
.Consume(c => c
.WithRoutingKey("custom_key")
.WithConsumerTag("custom_tag")
.WithPrefetchCount(2)
.WithNoLocal(false))
.FromDeclaredQueue(q => q
.WithName("custom_queue")
.WithAutoDelete()
.WithArgument(QueueArgument.DeadLetterExchange, "dlx"))
.OnDeclaredExchange(e=> e
.WithName("custom_exchange")
.WithType(ExchangeType.Topic))
));
```