1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
//! Channels-based transports.
//!
//! Channels-based transports can be used to efficiently connect client and broker within the same
//! process.
//!
//! The transports come in two flavors, [`Bounded`] and [`Unbounded`]. [`Bounded`] will cause
//! back-pressure to the sender when an internal fifo runs full, whereas [`Unbounded`] never blocks
//! (asynchronously).
//!
//! # Examples
//!
//! ```
//! use aldrin_broker::Broker;
//! use aldrin::Client;
//! use aldrin_core::channel;
//! use futures::future;
//!
//! #[tokio::main]
//! async fn main() -> Result<(), Box<dyn std::error::Error>> {
//! // Create a broker:
//! let broker = Broker::new();
//! let mut broker_handle = broker.handle().clone();
//! let broker_join = tokio::spawn(broker.run());
//!
//! // Connect a client with the Bounded transport:
//! let (t1, t2) = channel::bounded(16);
//! let (connection1, client1) =
//! future::join(broker_handle.connect(t1), Client::connect(t2)).await;
//! let connection1 = connection1?;
//! let client1 = client1?;
//! tokio::spawn(connection1.run());
//! let client1_handle = client1.handle().clone();
//! let client1_join = tokio::spawn(client1.run());
//!
//! // Connect a client with the Unbounded transport:
//! let (t1, t2) = channel::unbounded();
//! let (connection2, client2) =
//! future::join(broker_handle.connect(t1), Client::connect(t2)).await;
//! let connection2 = connection2?;
//! let client2 = client2?;
//! tokio::spawn(connection2.run());
//! let client2_handle = client2.handle().clone();
//! let client2_join = tokio::spawn(client2.run());
//!
//! // Shut everything down again:
//! broker_handle.shutdown_idle().await;
//! client1_handle.shutdown();
//! client1_join.await??;
//! client2_handle.shutdown();
//! client2_join.await??;
//! broker_join.await?;
//!
//! Ok(())
//! }
//! ```
use crate::message::Message;
use crate::transport::AsyncTransport;
use futures_channel::mpsc;
use futures_core::stream::Stream;
use std::pin::Pin;
use std::task::{Context, Poll};
use thiserror::Error;
/// Creates a pair of bounded channel transports.
///
/// Both transports have a separate fifo for receiving [`Message`s](Message). If either fifo is
/// full, this will cause backpressure to the sender.
pub fn bounded(fifo_size: usize) -> (Bounded, Bounded) {
let (sender1, receiver1) = mpsc::channel(fifo_size);
let (sender2, receiver2) = mpsc::channel(fifo_size);
(
Bounded::new(receiver1, sender2),
Bounded::new(receiver2, sender1),
)
}
/// A bounded channels-based transport for connecting a broker and a client in the same process.
///
/// Bounded transports have an internal fifo for receiving [`Message`s](Message). If this runs full,
/// backpressure will be applied to the sender.
#[derive(Debug)]
pub struct Bounded {
receiver: mpsc::Receiver<Message>,
sender: mpsc::Sender<Message>,
}
impl Bounded {
fn new(receiver: mpsc::Receiver<Message>, sender: mpsc::Sender<Message>) -> Self {
Bounded { receiver, sender }
}
}
/// Error type when using channels as a transport.
#[derive(Error, Debug, Copy, Clone, PartialEq, Eq)]
#[error("disconnected")]
pub struct Disconnected;
impl AsyncTransport for Bounded {
type Error = Disconnected;
fn receive_poll(
mut self: Pin<&mut Self>,
cx: &mut Context,
) -> Poll<Result<Message, Disconnected>> {
match Pin::new(&mut self.receiver).poll_next(cx) {
Poll::Ready(Some(msg)) => Poll::Ready(Ok(msg)),
Poll::Ready(None) => Poll::Ready(Err(Disconnected)),
Poll::Pending => Poll::Pending,
}
}
fn send_poll_ready(
mut self: Pin<&mut Self>,
cx: &mut Context,
) -> Poll<Result<(), Disconnected>> {
match self.sender.poll_ready(cx) {
Poll::Ready(Ok(())) => Poll::Ready(Ok(())),
Poll::Ready(Err(_)) => Poll::Ready(Err(Disconnected)),
Poll::Pending => Poll::Pending,
}
}
fn send_start(mut self: Pin<&mut Self>, msg: Message) -> Result<(), Disconnected> {
self.sender.start_send(msg).map_err(|_| Disconnected)
}
fn send_poll_flush(self: Pin<&mut Self>, _cx: &mut Context) -> Poll<Result<(), Disconnected>> {
Poll::Ready(Ok(()))
}
}
/// Creates a pair of unbounded channel transports.
pub fn unbounded() -> (Unbounded, Unbounded) {
let (sender1, receiver1) = mpsc::unbounded();
let (sender2, receiver2) = mpsc::unbounded();
(
Unbounded::new(receiver1, sender2),
Unbounded::new(receiver2, sender1),
)
}
/// An unbounded channels-based transport for connecting a broker and a client in the same process.
#[derive(Debug)]
pub struct Unbounded {
receiver: mpsc::UnboundedReceiver<Message>,
sender: mpsc::UnboundedSender<Message>,
}
impl Unbounded {
fn new(
receiver: mpsc::UnboundedReceiver<Message>,
sender: mpsc::UnboundedSender<Message>,
) -> Self {
Unbounded { receiver, sender }
}
}
impl AsyncTransport for Unbounded {
type Error = Disconnected;
fn receive_poll(
mut self: Pin<&mut Self>,
cx: &mut Context,
) -> Poll<Result<Message, Disconnected>> {
match Pin::new(&mut self.receiver).poll_next(cx) {
Poll::Ready(Some(msg)) => Poll::Ready(Ok(msg)),
Poll::Ready(None) => Poll::Ready(Err(Disconnected)),
Poll::Pending => Poll::Pending,
}
}
fn send_poll_ready(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Result<(), Disconnected>> {
match self.sender.poll_ready(cx) {
Poll::Ready(Ok(())) => Poll::Ready(Ok(())),
Poll::Ready(Err(_)) => Poll::Ready(Err(Disconnected)),
Poll::Pending => Poll::Pending,
}
}
fn send_start(mut self: Pin<&mut Self>, msg: Message) -> Result<(), Disconnected> {
self.sender.start_send(msg).map_err(|_| Disconnected)
}
fn send_poll_flush(self: Pin<&mut Self>, _cx: &mut Context) -> Poll<Result<(), Disconnected>> {
Poll::Ready(Ok(()))
}
}