#tokio #mpsc #request #async

bmrng

async MPSC request-response channel for Tokio

12 releases (5 breaking)

0.5.2 Aug 24, 2021
0.5.1 Apr 2, 2021
0.5.0 Mar 31, 2021
0.3.0 Dec 31, 2020

#69 in Concurrency

Download history 342/week @ 2021-06-30 388/week @ 2021-07-07 141/week @ 2021-07-14 116/week @ 2021-07-21 47/week @ 2021-07-28 36/week @ 2021-08-04 231/week @ 2021-08-11 236/week @ 2021-08-18 271/week @ 2021-08-25 659/week @ 2021-09-01 349/week @ 2021-09-08 451/week @ 2021-09-15 162/week @ 2021-09-22 268/week @ 2021-09-29 490/week @ 2021-10-06 318/week @ 2021-10-13

946 downloads per month
Used in 2 crates (via noxious)

MIT/Apache

28KB
482 lines

bmrng 🪃

Crates.io Documentation Unit Tests Coverage Status Dependency status

An async MPSC request-response channel for Tokio, where you can send a response to the sender. Inspired by crossbeam_requests.

Example

#[tokio::main]
async fn main() {
    let buffer_size = 100;
    let (tx, mut rx) = bmrng::channel::<i32, i32>(buffer_size);
    tokio::spawn(async move {
        while let Ok((input, mut responder)) = rx.recv().await {
            if let Err(err) = responder.respond(input * input) {
                println!("sender dropped the response channel");
            }
        }
    });
    for i in 1..=10 {
        if let Ok(response) = tx.send_receive(i).await {
            println!("Requested {}, got {}", i, response);
            assert_eq!(response, i * i);
        }
    }
}

Request Timeout

It is also possible to create a channel with a request timeout:

use tokio::time::{Duration, sleep};
#[tokio::main]
async fn main() {
    let (tx, mut rx) = bmrng::channel_with_timeout::<i32, i32>(100, Duration::from_millis(100));
    tokio::spawn(async move {
        match rx.recv().await {
            Ok((input, mut responder)) => {
                sleep(Duration::from_millis(200)).await;
                let res = responder.respond(input * input);
                assert_eq!(res.is_ok(), true);
            }
            Err(err) => {
                println!("all request senders dropped");
            }
        }
    });
    let response = tx.send_receive(8).await;
    assert_eq!(response, Err(bmrng::error::RequestError::<i32>::RecvTimeoutError));
}

Unbounded Channel

There is also an unbounded alternative, bmrng::unbounded_channel() with sync .send() calls.

Dependencies

~2MB
~29K SLoC