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
//! Structured communication between timely dataflow operators.
use serde::{Deserialize, Serialize};
use crate::communication::Push;
use crate::Container;
/// A collection of types that may be pushed at.
pub mod pushers;
/// A collection of types that may be pulled from.
pub mod pullers;
/// Parallelization contracts, describing how data must be exchanged between operators.
pub mod pact;
/// The input to and output from timely dataflow communication channels.
pub type Bundle<T, C> = crate::Message<Message<T, C>>;
/// A serializable representation of timestamped data.
#[derive(Clone, Serialize, Deserialize)]
pub struct Message<T, C> {
/// The timestamp associated with the message.
pub time: T,
/// The data in the message.
pub data: C,
/// The source worker.
pub from: usize,
/// A sequence number for this worker-to-worker stream.
pub seq: usize,
}
impl<T, C> Message<T, C> {
/// Default buffer size.
#[deprecated = "Use timely::buffer::default_capacity instead"]
pub fn default_length() -> usize {
crate::container::buffer::default_capacity::<C>()
}
}
impl<T, C: Container> Message<T, C> {
/// Creates a new message instance from arguments.
pub fn new(time: T, data: C, from: usize, seq: usize) -> Self {
Message { time, data, from, seq }
}
/// Forms a message, and pushes contents at `pusher`. Replaces `buffer` with what the pusher
/// leaves in place, or the container's default element. The buffer is cleared.
#[inline]
pub fn push_at<P: Push<Bundle<T, C>>>(buffer: &mut C, time: T, pusher: &mut P) {
let data = ::std::mem::take(buffer);
let message = Message::new(time, data, 0, 0);
let mut bundle = Some(Bundle::from_typed(message));
pusher.push(&mut bundle);
if let Some(message) = bundle {
*buffer = message.payload.data;
buffer.clear();
}
}
}