mirror of
https://old.git.ood.ovh/nehu/tokio-messaging.git
synced 2025-04-28 22:27:04 +02:00
62 lines
2.1 KiB
Markdown
62 lines
2.1 KiB
Markdown
<h1 align="center">tokio-messaging</h1>
|
|
|
|
<p align="center">
|
|
<a href="https://github.com/etienne-k/tokio-messaging">
|
|
<img alt="repository" src="https://img.shields.io/badge/repository-tokio--messaging-8da0cb?style=for-the-badge&logo=github" height="20"/>
|
|
</a>
|
|
|
|
<a href="https://github.com/etienne-k/tokio-messaging/actions">
|
|
<img alt="build" src="https://img.shields.io/github/actions/workflow/status/etienne-k/tokio-messaging/rust.yml?style=for-the-badge&logo=github" height="20"/>
|
|
</a>
|
|
|
|
<a href="https://crates.io/crates/tokio-messaging">
|
|
<img alt="crate" src="https://img.shields.io/crates/v/tokio-messaging.svg?style=for-the-badge&color=fc8d62&logo=rust" height="20"/>
|
|
</a>
|
|
|
|
<a href="https://github.com/etienne-k/tokio-messaging/blob/main/LICENSE">
|
|
<img alt="license" src="https://img.shields.io/github/license/etienne-k/tokio-messaging?style=for-the-badge&logo=github&color=blue" height="20"/>
|
|
</a>
|
|
</p>
|
|
|
|
A crate which offers non-blocking publish/subscribe functionality using Tokio channels.
|
|
|
|
Publishing messages and subscribing to them is done using an `Messaging` instance,
|
|
which acts as a message broker.
|
|
|
|
In order to create a message broker, start by defining the structure of messages and their data (payload).
|
|
The types should implement `Message` and `MessageData` respectively.
|
|
|
|
```rust
|
|
enum MyMessage
|
|
{
|
|
Greeting,
|
|
Request
|
|
}
|
|
|
|
impl Message for MyMessage {}
|
|
|
|
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
|
|
struct MyPayload(&'static str);
|
|
|
|
impl MessageData for MyPayload {}
|
|
```
|
|
|
|
Next, create the message broker instance. Usually, you'll have a single, long-living instance.
|
|
```rust
|
|
lazy_static! {
|
|
static ref INSTANCE: Messaging<MyMessage, MyPayload> = { Messaging::new() };
|
|
}
|
|
|
|
pub fn messaging() -> &'static Messaging<MyMessage, MyPayload> { &INSTANCE }
|
|
```
|
|
|
|
Publish messages using the `dispatch()` function and subscribe to them using the `on()` function.
|
|
```rust
|
|
// Subscribe to messages
|
|
tokio::spawn(messaging().on(MyMessage::Request, |data: MyPayload| {
|
|
assert_eq!(data.0, "Here's a request!");
|
|
}));
|
|
|
|
// Publish a message
|
|
messaging().dispatch(MyMessage::Request, MyPayload("Here's a request!"));
|
|
```
|