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 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
//! A channel that keeps track of latency and queue length.
use std::sync::{atomic::AtomicU64, Arc};
use web_time::Instant;
pub use crossbeam::channel::{RecvError, RecvTimeoutError, SendError, TryRecvError};
mod receive_set;
mod receiver;
mod sender;
pub use receive_set::ReceiveSet;
pub use receiver::Receiver;
pub use sender::Sender;
// --- Source ---
/// Identifies in what context this smart channel was created, and who/what is holding its
/// receiving end.
#[derive(Clone, Debug, PartialEq, Eq, Hash, serde::Deserialize, serde::Serialize)]
pub enum SmartChannelSource {
/// The channel was created in the context of loading a file from disk (could be
/// `.rrd` files, or `.glb`, `.png`, …).
File(std::path::PathBuf),
/// The channel was created in the context of loading an `.rrd` file over http.
///
/// The `follow` flag indicates whether the viewer should open the stream in `Following` mode rather than `Playing` mode.
RrdHttpStream { url: String, follow: bool },
/// The channel was created in the context of loading an `.rrd` file from a `postMessage`
/// js event.
///
/// Only applicable to web browser iframes.
/// Used for the inline web viewer in a notebook.
RrdWebEventListener,
/// The channel was created in the context of a javascript client submitting an RRD directly as bytes.
JsChannel {
/// The name of the channel reported by the javascript client.
channel_name: String,
},
/// The channel was created in the context of loading data using a Rerun SDK sharing the same
/// process.
Sdk,
/// The channel was created in the context of fetching data from a Rerun WebSocket server.
///
/// We are likely running in a web browser.
WsClient {
/// The server we are connected to (or are trying to connect to)
ws_server_url: String,
},
/// The channel was created in the context of receiving data from one or more Rerun SDKs
/// over TCP.
///
/// We are a TCP server listening on this port.
TcpServer { port: u16 },
/// The channel was created in the context of streaming in RRD data from standard input.
Stdin,
}
impl std::fmt::Display for SmartChannelSource {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
Self::File(path) => path.display().fmt(f),
Self::RrdHttpStream { url, follow: _ } => url.fmt(f),
Self::RrdWebEventListener => "Web event listener".fmt(f),
Self::JsChannel { channel_name } => write!(f, "Javascript channel: {channel_name}"),
Self::Sdk => "SDK".fmt(f),
Self::WsClient { ws_server_url } => ws_server_url.fmt(f),
Self::TcpServer { port } => write!(f, "TCP server, port {port}"),
Self::Stdin => "Standard input".fmt(f),
}
}
}
impl SmartChannelSource {
pub fn is_network(&self) -> bool {
match self {
Self::File(_) | Self::Sdk | Self::RrdWebEventListener | Self::Stdin => false,
Self::RrdHttpStream { .. }
| Self::WsClient { .. }
| Self::JsChannel { .. }
| Self::TcpServer { .. } => true,
}
}
}
/// Identifies who/what sent a particular message in a smart channel.
///
/// Due to the multiplexed nature of the smart channel, every message coming in can originate
/// from a different source.
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
pub enum SmartMessageSource {
/// The source is unknown.
///
/// This is only used when we need to allocate a sender but cannot yet know what that the
/// source is.
/// This should never be used to send a message; use [`Sender::clone_as`] to specify the source
/// of a [`Sender`] after its creation.
Unknown,
/// The sender is a background thread reading data from a file on disk.
File(std::path::PathBuf),
/// The sender is a background thread fetching data from an HTTP file server.
RrdHttpStream {
/// Should include `http(s)://` prefix.
url: String,
},
/// The sender is a javascript callback triggered by a `postMessage` event.
///
/// Only applicable to web browser iframes.
RrdWebEventCallback,
/// The sender is a javascript client submitting an RRD directly as bytes.
JsChannelPush,
/// The sender is a Rerun SDK running from another thread in the same process.
Sdk,
/// The sender is a WebSocket client fetching data from a Rerun WebSocket server.
///
/// We are likely running in a web browser.
WsClient {
/// The server we are connected to (or are trying to connect to)
ws_server_url: String,
},
/// The sender is a TCP client.
TcpClient {
// NOTE: Optional as we might not be able to retrieve the peer's address for some obscure
// reason.
addr: Option<std::net::SocketAddr>,
},
/// The data is streaming in from standard input.
Stdin,
}
impl std::fmt::Display for SmartMessageSource {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.write_str(&match self {
SmartMessageSource::Unknown => "unknown".into(),
SmartMessageSource::File(path) => format!("file://{}", path.to_string_lossy()),
SmartMessageSource::RrdHttpStream { url } => url.clone(),
SmartMessageSource::RrdWebEventCallback => "web_callback".into(),
SmartMessageSource::JsChannelPush => "javascript".into(),
SmartMessageSource::Sdk => "sdk".into(),
SmartMessageSource::WsClient { ws_server_url } => ws_server_url.clone(),
SmartMessageSource::TcpClient { addr } => format!(
"tcp://{}",
addr.map_or_else(|| "(unknown ip)".to_owned(), |addr| addr.to_string())
),
SmartMessageSource::Stdin => "stdin".into(),
})
}
}
// ---
/// Stats for a channel, possibly shared between chained channels.
#[derive(Default)]
pub(crate) struct SharedStats {
/// Latest known latency from sending a message to receiving it, it nanoseconds.
latency_ns: AtomicU64,
}
pub fn smart_channel<T: Send>(
sender_source: SmartMessageSource,
source: SmartChannelSource,
) -> (Sender<T>, Receiver<T>) {
let stats = Arc::new(SharedStats::default());
smart_channel_with_stats(sender_source, Arc::new(source), stats)
}
/// Create a new channel using the same stats as some other.
///
/// This is a very leaky abstraction, and it would be nice to refactor some day
pub(crate) fn smart_channel_with_stats<T: Send>(
sender_source: SmartMessageSource,
source: Arc<SmartChannelSource>,
stats: Arc<SharedStats>,
) -> (Sender<T>, Receiver<T>) {
let (tx, rx) = crossbeam::channel::unbounded();
let sender_source = Arc::new(sender_source);
let sender = Sender::new(tx, sender_source, stats.clone());
let receiver = Receiver::new(rx, stats, source);
(sender, receiver)
}
// ---
/// The payload of a [`SmartMessage`].
///
/// Either data or an end-of-stream marker.
pub enum SmartMessagePayload<T: Send> {
/// A message sent down the channel.
Msg(T),
/// When received, flush anything already received and then call the given callback.
Flush {
on_flush_done: Box<dyn FnOnce() + Send>,
},
/// The [`Sender`] has quit.
///
/// `None` indicates the sender left gracefully, an error indicates otherwise.
Quit(Option<Box<dyn std::error::Error + Send>>),
}
impl<T: Send> std::fmt::Debug for SmartMessagePayload<T> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
SmartMessagePayload::Msg(_) => f.write_str("Msg(_)"),
SmartMessagePayload::Flush { .. } => f.write_str("Flush"),
SmartMessagePayload::Quit(_) => f.write_str("Quit"),
}
}
}
impl<T: Send + PartialEq> PartialEq for SmartMessagePayload<T> {
fn eq(&self, rhs: &Self) -> bool {
match (self, rhs) {
(SmartMessagePayload::Msg(msg1), SmartMessagePayload::Msg(msg2)) => msg1.eq(msg2),
_ => false,
}
}
}
#[derive(Debug, PartialEq)]
pub struct SmartMessage<T: Send> {
pub time: Instant,
pub source: Arc<SmartMessageSource>,
pub payload: SmartMessagePayload<T>,
}
impl<T: Send> SmartMessage<T> {
pub fn data(&self) -> Option<&T> {
match &self.payload {
SmartMessagePayload::Msg(msg) => Some(msg),
SmartMessagePayload::Flush { .. } | SmartMessagePayload::Quit(_) => None,
}
}
pub fn into_data(self) -> Option<T> {
match self.payload {
SmartMessagePayload::Msg(msg) => Some(msg),
SmartMessagePayload::Flush { .. } | SmartMessagePayload::Quit(_) => None,
}
}
}
// ---
#[test]
fn test_smart_channel() {
let (tx, rx) = smart_channel(SmartMessageSource::Sdk, SmartChannelSource::Sdk); // whatever source
assert_eq!(tx.len(), 0);
assert_eq!(rx.len(), 0);
assert_eq!(tx.latency_ns(), 0);
tx.send(42).unwrap();
assert_eq!(tx.len(), 1);
assert_eq!(rx.len(), 1);
assert_eq!(tx.latency_ns(), 0);
std::thread::sleep(std::time::Duration::from_millis(10));
assert_eq!(rx.recv().map(|msg| msg.into_data()), Ok(Some(42)));
assert_eq!(tx.len(), 0);
assert_eq!(rx.len(), 0);
assert!(tx.latency_ns() > 1_000_000);
}
#[test]
fn test_smart_channel_connected() {
let (tx1, rx) = smart_channel(SmartMessageSource::Sdk, SmartChannelSource::Sdk); // whatever source
assert_eq!(rx.try_recv(), Err(TryRecvError::Empty));
assert!(rx.is_connected());
let tx2 = tx1.clone();
assert_eq!(rx.try_recv(), Err(TryRecvError::Empty));
assert!(rx.is_connected());
tx2.send(42).unwrap();
assert_eq!(rx.try_recv().map(|msg| msg.into_data()), Ok(Some(42)));
assert!(rx.is_connected());
drop(tx1);
assert_eq!(rx.try_recv(), Err(TryRecvError::Empty));
assert!(rx.is_connected());
drop(tx2);
assert_eq!(rx.try_recv(), Err(TryRecvError::Disconnected));
assert!(!rx.is_connected());
}