Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/grumpybusted/grumpy.messagequeue
Extended and opinionated API for Microsoft Message Queue (MSMQ)
https://github.com/grumpybusted/grumpy.messagequeue
ack api-wrapper listener message-queue messagequeue msmq nack nuget queue transaction-message
Last synced: about 2 months ago
JSON representation
Extended and opinionated API for Microsoft Message Queue (MSMQ)
- Host: GitHub
- URL: https://github.com/grumpybusted/grumpy.messagequeue
- Owner: GrumpyBusted
- License: mit
- Created: 2018-01-12T22:14:33.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-01-11T20:58:04.000Z (about 6 years ago)
- Last Synced: 2024-11-12T23:32:49.853Z (3 months ago)
- Topics: ack, api-wrapper, listener, message-queue, messagequeue, msmq, nack, nuget, queue, transaction-message
- Language: C#
- Homepage:
- Size: 107 KB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://ci.appveyor.com/project/GrumpyBusted/grumpy-messagequeue)
[](https://codecov.io/gh/GrumpyBusted/Grumpy.MessageQueue)
[](https://www.nuget.org/packages/Grumpy.MessageQueue/)
[](https://www.nuget.org/packages/Grumpy.MessageQueue/)
# Grumpy.MessageQueue
API for Microsoft Message Queue (MSMQ).
This API extents the API with:
- Larger messages (Move the limit from 4MB to the size of a string 1-2GB)
- Transactional messages with Ack and NAck feature
- Queue Handler (Listener) to trigger handler method when messages are received
- Automatic management of queues (Create and Delete)
- Cancelable Receiver
- Async Receiver
This API includes the features that are most used (and needed for my other solution). The API makes the use
of MSMQ easy and strait forward. I know this library is opinionated and only provide a sub set of the features
in MSMQ API for Microsoft Message Queue (MSMQ).
## Send and Receive
The following code sample will:
- Create a new Private Queue on the current maschine, if not exists
- Open a connections to the queue
- Send a Message
- Receive the same message
- Close the connection
```csharp
var queueFactory = new QueueFactory();
using (var queue = queueFactory.CreateLocale("MyQueue", true, LocaleQueueMode.DurableCreate, true))
{
// Message will be serialized to json and chumped into pieces, all pieces send in the same transaction
queue.Send("MyMessage");
// The receive has a timeout of 1 sec, and the message will be deserialized to the type (here string). This receive will automatically Ack the message
var response = queue.Receive(1000, new CancellationToken());
}
```
## Receive and Ack
The following code sample will:
- Receive a transactional message
- Try to Handle the message in some other method
- If any exception, NAck the message for next receive to handle the samme message
```csharp
var queueFactory = new QueueFactory();
using (var queue = queueFactory.CreateLocale("MyQueue", true, LocaleQueueMode.Durable, true))
{
var message = queue.Receive(1000, new CancellationToken());
try {
Handle(messege.Message)
message.Ack();
}
catch
{
message.NAck();
}
}
```
## Queue Handler (Listerner)
The following code sample will:
- Create a Queue handler
- Start Listening to a Queue
- For each message call the method MessageHandler
- Ack and NAck are handled in the QueueHandler
```csharp
var queueFactory = new QueueFactory();
var queueHandlerFactory = new QueueHandlerFactory(queueFactory);
using (var queueHandler = queueHandlerFactory.Create())
{
queueHandler.Start("MyQueue", true, LocaleQueueMode.Durable, true, MessageHandler, null, null, 0, true, false, new CancellationToken());
// Wait for ever, or until cancelled
}
public void MessageHandler(object message, CancellationToken cancellationToken)
{
// Do stuff with message
}
```
Just ask for more samples!!!