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 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
//! Data flow between [signal processing blocks]
//!
//! [signal processing blocks]: crate::blocks
//!
//! # Overview
//!
//! This module provides an extension to the [`broadcast_bp`] channel.
//! Like `broadcast_bp`, a type argument `T` is used to select the type of the
//! passed values. However, only types which implement the [`Message`] trait
//! can be used by this module.
//!
//! Opposed to `broadcast_bp`, this module allows [`Receiver`]s to be
//! (re-)connected to different [`Sender`]s after creation and use.
//! For that, each `Sender` has an associated [`SenderConnector`] and each
//! `Receiver` has an associated [`ReceiverConnector`]. The connectors provide
//! methods to (re-)connect their associated `Sender`s and `Receiver`s.
//!
//! Moreover, two traits [`Producer`] and [`Consumer`] are provided, which
//! describe data types that produce or consume data using a background task
//! and which contain a `SenderConnector` or `ReceiverConnector`, respectively,
//! such that it's possible to connect `Producer`s and `Consumer`s with each
//! other.
//!
//! Upon disconnection, a special value is optionally inserted into the stream
//! of received values. This value is determined by the
//! [`Message::disconnection`] method.
//!
//! # Implementing a `Producer` or `Consumer`
//!
//! Upon creation, `Producer`s use the [`new_sender`] function to create a pair
//! consisting of a `Sender` and a `SenderConnector`. The `Sender` is passed to
//! a background task while the `SenderConnector` is stored and accessible
//! through the [`Producer::sender_connector`] method.
//!
//! `Consumers` use the [`new_receiver`] function upon creation to create a
//! pair of a `Receiver` and a `ReceiverConnector`. The `Receiver` is passed to
//! a background task while the `ReceiverConnector` is stored and accessible
//! through the [`Consumer::receiver_connector`] method.
//!
//! Refer to the source code of the [`Nop`] block for an example.
//!
//! [`Nop`]: crate::blocks::Nop
//!
//! # Buffering and Congestion
//!
//! Connecting a `Producer` to more than one `Consumer` at the same time will
//! stall all involved blocks if one of the `Consumer`s is stalled; i.e. all
//! `Consumer`s must process the data in order for the `Producer` to be able to
//! send further data.
//!
//! There is a buffer capacity of `1` for each `Sender`/`Producer`. Because of
//! this, longer chains may lead to a significant buffer volume.
//!
//! The [`blocks`] module uses the [`Buffer`] block for tweaking buffering
//! behavior, including dropping data in case of congestion and countermeasures
//! against latency.
//!
//! [`blocks`]: crate::blocks
//! [`Buffer`]: crate::blocks::buffering::Buffer
use crate::sync::broadcast_bp;
use tokio::select;
use tokio::sync::watch;
use std::future::pending;
pub use crate::sync::broadcast_bp::{
channel as new_sender, Enlister as SenderConnector, RecvError, Reservation, RsrvError,
SendError, Sender,
};
/// Types that can be used as message from [`Sender`] to [`Receiver`]
pub trait Message: Sized + Clone {
/// Return message that indicates disconnection or `None` if not
/// supported
fn disconnection() -> Option<Self>;
}
/// Wrapper implementing [`Message`], which doesn't provide a value that
/// indicates disconnection
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
pub struct SimpleMessage<T>(T);
impl<T> Message for SimpleMessage<T>
where
T: Clone,
{
fn disconnection() -> Option<Self> {
None
}
}
/// Handle to connect a [`Receiver`] to a [`Sender`]
///
/// A `ReceiverConnector` is either obtained when calling [`new_receiver`] or
/// by calling [`ReceiverConnector::new`].
///
/// Connecting a `Receiver` to a `Sender` is done by passing a
/// [`SenderConnector`] reference to [`ReceiverConnector::connect`].
/// The `SenderConnector` is obtained when calling [`new_sender`].
#[derive(Debug)]
pub struct ReceiverConnector<T> {
enlister_tx: watch::Sender<Option<broadcast_bp::Enlister<T>>>,
}
/// Receiver that can be dynamically connected to a [`Sender`]
///
/// A `Receiver` is either obtained through [`new_receiver`] or by calling
/// [`ReceiverConnector::stream`].
///
/// Receiving data is done by calling [`Receiver::recv`].
///
/// Connecting a `Receiver` to a `Sender` is done by passing a
/// [`SenderConnector`] reference to [`ReceiverConnector::connect`].
/// The `SenderConnector` is obtained when calling [`new_sender`].
#[derive(Debug)]
pub struct Receiver<T> {
enlister_rx: watch::Receiver<Option<broadcast_bp::Enlister<T>>>,
inner_receiver: Option<broadcast_bp::Receiver<T>>,
}
impl<T> Clone for Receiver<T> {
fn clone(&self) -> Self {
Self {
enlister_rx: self.enlister_rx.clone(),
inner_receiver: self.inner_receiver.clone(),
}
}
}
/// Create a [`Receiver`] with an associated [`ReceiverConnector`]
///
/// Alternatively, you can use [`ReceiverConnector::new`] and
/// [`ReceiverConnector::stream`].
pub fn new_receiver<T>() -> (Receiver<T>, ReceiverConnector<T>) {
let receiver_connector = ReceiverConnector::new();
let receiver = receiver_connector.stream();
(receiver, receiver_connector)
}
impl<T> ReceiverConnector<T> {
/// Create a new `ReceiverConnector` without associated [`Receiver`]s
pub fn new() -> Self {
Self {
enlister_tx: watch::channel(None).0,
}
}
/// Connect associated [`Receiver`]s with a [`Sender`]
pub fn connect(&self, connector: &SenderConnector<T>) {
self.enlister_tx.send_replace(Some(connector.clone()));
}
/// Disconnect associated [`Receiver`]s from [`Sender`] if connected
pub fn disconnect(&self) {
self.enlister_tx.send_replace(None);
}
/// Obtain an associated [`Receiver`]
pub fn stream(&self) -> Receiver<T> {
let mut enlister_rx = self.enlister_tx.subscribe();
let inner_receiver = enlister_rx
.borrow_and_update()
.as_ref()
.map(|x| x.subscribe());
Receiver {
enlister_rx,
inner_receiver,
}
}
}
impl<T> Receiver<T>
where
T: Message,
{
/// Receive data from connected [`Sender`]
pub async fn recv(&mut self) -> Result<T, RecvError> {
let change = |this: &mut Self| {
let was_connected = this.inner_receiver.is_some();
this.inner_receiver = this
.enlister_rx
.borrow_and_update()
.as_ref()
.map(|x| x.subscribe());
if was_connected {
Message::disconnection()
} else {
None
}
};
let mut unchangeable = false;
loop {
if let Some(inner_receiver) = self.inner_receiver.as_mut() {
select! {
result = async {
if unchangeable {
pending::<()>().await;
}
self.enlister_rx.changed().await
} => {
match result {
Ok(()) => if let Some(message) = change(self) {
return Ok(message);
},
Err(_) => unchangeable = true,
}
}
result = inner_receiver.recv() => {
match result {
Ok(message) => return Ok(message),
Err(_) => self.inner_receiver = None,
}
}
}
} else {
match self.enlister_rx.changed().await {
Ok(()) => {
if let Some(message) = change(self) {
return Ok(message);
}
}
Err(_) => return Err(RecvError),
}
}
}
}
}
/// Type which contains a [`SenderConnector`] and can be connected to a
/// [`Consumer`]
///
/// This trait is implemented for `SenderConnector` but may also be implemented
/// for structs which contain a `SenderConnector`.
pub trait Producer<T> {
/// Obtain reference to [`SenderConnector`]
fn sender_connector(&self) -> &SenderConnector<T>;
/// Connect `Producer` to [`Consumer`]
fn feed_into<C: Consumer<T>>(&self, consumer: &C) {
consumer
.receiver_connector()
.connect(self.sender_connector());
}
}
impl<T> Producer<T> for SenderConnector<T> {
fn sender_connector(&self) -> &SenderConnector<T> {
self
}
}
/// Type which contains a [`ReceiverConnector`] and can be connected to a
/// [`Producer`]
///
/// This trait is implemented for `ReceiverConnector` but may also be
/// implemented for structs which contain a `ReceiverConnector`.
pub trait Consumer<T> {
/// Obtain reference to [`ReceiverConnector`]
fn receiver_connector(&self) -> &ReceiverConnector<T>;
/// Connect `Consumer` to [`Producer`]
fn feed_from<P: Producer<T>>(&self, producer: &P) {
self.receiver_connector()
.connect(producer.sender_connector());
}
/// Disconnect `Consumer` from any connected [`Producer`] if connected
fn feed_from_none(&self) {
self.receiver_connector().disconnect();
}
}
impl<T> Consumer<T> for ReceiverConnector<T> {
fn receiver_connector(&self) -> &ReceiverConnector<T> {
self
}
}
#[cfg(test)]
mod tests {}