netring 0.28.0

//! 0.21 F: streaming consumer over a
//! [`Protocol`](crate::protocol::Protocol)'s broadcast slot.
//!
//! Returned by [`super::Monitor::subscribe`]. Each `EventStream`
//! is its own subscriber on the underlying flowscope
//! [`flowscope::driver::BroadcastSlotHandle`]: every emitted
//! message is cloned once per live subscriber. Dropping the
//! stream prunes the subscriber list automatically (via the
//! `Weak` registration in flowscope).
//!
//! Use over the synchronous `.on::<P>(...)` handler path when:
//! - The consumer lives in a different task and needs to be
//!   decoupled from the run loop's borrow tree.
//! - Multiple downstream consumers want independent views of
//!   the same parser stream.
//! - Backpressure / batching is the consumer's concern.
//!
//! Trade-off: per-subscriber queue is unbounded. Slow consumers
//! see queue growth — pair with `recv_many(out, cap)` to bound.

use flowscope::driver::BroadcastSlotHandle;
use flowscope::extract::FiveTupleKey;

/// Subscriber over a [`flowscope::driver::BroadcastSlotHandle`].
///
/// Returned by [`super::Monitor::subscribe`] for any protocol
/// `P` registered via [`super::MonitorBuilder::with_broadcast`].
/// The handle is a clone — pushes from the run loop land in this
/// subscriber's private queue. Drop the stream and the
/// subscriber slot is pruned next push.
///
/// `M` is the protocol's `Message` type. Each emitted message is
/// cloned once per subscriber; `Clone` on the message is required
/// at the underlying flowscope layer.
pub struct EventStream<M>
where
    M: Send + Sync + Clone + 'static,
{
    handle: BroadcastSlotHandle<M, FiveTupleKey>,
    drain_buf: Vec<flowscope::driver::SlotMessage<M, FiveTupleKey>>,
}

impl<M> EventStream<M>
where
    M: Send + Sync + Clone + 'static,
{
    /// Wrap an already-cloned broadcast handle.
    pub(crate) fn new(handle: BroadcastSlotHandle<M, FiveTupleKey>) -> Self {
        Self {
            handle,
            drain_buf: Vec::with_capacity(32),
        }
    }

    /// Pop one pending message off the subscriber queue.
    /// Returns `None` when the queue is empty.
    pub fn try_recv(&mut self) -> Option<M> {
        self.drain_buf.clear();
        if self.handle.drain_n(&mut self.drain_buf, 1) == 0 {
            return None;
        }
        self.drain_buf.pop().map(|msg| msg.message)
    }

    /// Drain at most `max` messages into `out`. Returns the
    /// number of messages pushed.
    ///
    /// Reuses an internal scratch buffer so the drain itself
    /// doesn't allocate per-call. The messages are then moved
    /// into `out`.
    pub fn recv_many(&mut self, out: &mut Vec<M>, max: usize) -> usize {
        self.drain_buf.clear();
        let n = self.handle.drain_n(&mut self.drain_buf, max);
        out.reserve(n);
        out.extend(self.drain_buf.drain(..).map(|m| m.message));
        n
    }

    /// Number of pending messages on this subscriber's queue.
    pub fn pending(&self) -> usize {
        self.handle.pending()
    }

    /// Total live subscriber count across the broadcast set
    /// (this stream + any siblings produced by other
    /// `monitor.subscribe::<P>()` calls).
    pub fn subscribers(&self) -> usize {
        self.handle.subscribers()
    }

    /// flowscope's typed [`ParserKind`] for the broadcast slot
    /// (its `.as_str()` slug matches the corresponding
    /// [`crate::protocol::Protocol::NAME`]). Lifted from `&'static str`
    /// in the flowscope 0.20 adoption (#109).
    ///
    /// [`ParserKind`]: flowscope::ParserKind
    pub fn parser_kind(&self) -> flowscope::ParserKind {
        self.handle.parser_kind()
    }
}

impl<M> std::fmt::Debug for EventStream<M>
where
    M: Send + Sync + Clone + 'static,
{
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("EventStream")
            .field("parser_kind", &self.parser_kind())
            .field("pending", &self.pending())
            .field("subscribers", &self.subscribers())
            .finish()
    }
}

/// 0.21 F.4: `futures_core::Stream` for `EventStream<M>`.
///
/// Polls the underlying `BroadcastSlotHandle`'s queue:
/// - Returns `Poll::Ready(Some(msg))` immediately if one is
///   queued.
/// - Returns `Poll::Pending` when the queue is empty. Note: this
///   is the deliberately-simple shape — there's no `Waker`
///   registered with the broadcast slot, so the stream relies on
///   the next `poll_next` call to re-check. In practice consumers
///   pair this with `tokio::time::interval` or run inside a tight
///   `tokio::select!` that re-polls on other events. For
///   strictly-bounded polling latency, prefer
///   [`EventStream::recv_many`] from a periodic task.
/// - The stream is open as long as the parent monitor is alive;
///   once every other reference to the broadcast inner is dropped
///   the queue stays drainable but stops receiving new pushes.
///   The stream itself never returns `Poll::Ready(None)` — the
///   subscriber lifetime is owned by the consumer holding the
///   `EventStream`.
// `EventStream<M>` has no self-referential fields; the `Pin` shape
// from `Stream::poll_next` doesn't pin anything meaningful. Mark
// the type `Unpin` so consumers can use it through ordinary
// `&mut EventStream<M>` (via `StreamExt::next()` etc.) without
// extra ceremony.
impl<M> Unpin for EventStream<M> where M: Send + Sync + Clone + 'static {}

impl<M> futures_core::Stream for EventStream<M>
where
    M: Send + Sync + Clone + 'static,
{
    type Item = M;

    fn poll_next(
        mut self: std::pin::Pin<&mut Self>,
        _cx: &mut std::task::Context<'_>,
    ) -> std::task::Poll<Option<Self::Item>> {
        match self.try_recv() {
            Some(msg) => std::task::Poll::Ready(Some(msg)),
            None => std::task::Poll::Pending,
        }
    }
}