pub struct MoqEventSubscriber { /* private fields */ }Expand description
In-process moq event subscriber.
Subscribes to one or more topic-prefix patterns. Patterns use the same
dot-separated prefix semantics as ZMQ ("worker." matches all worker events,
"" matches everything). Backed by a background Tokio task that watches the
origin consumer for new source broadcasts and reads their events tracks.
§#393 — per-OID subscription
Self::subscribe_oid scopes the subscriber to a single model OID’s
publication track (local/events/publications/{oid_hash}), so only that
OID’s events cross the wire — not the whole firehose. This is mutually
exclusive with the flat-pattern Self::subscribe API: a subscriber is
either pattern-based (legacy firehose + in-memory filter) or OID-scoped.
Implementations§
Source§impl MoqEventSubscriber
impl MoqEventSubscriber
Sourcepub fn subscribe(&mut self, pattern: &str) -> Result<()>
pub fn subscribe(&mut self, pattern: &str) -> Result<()>
Add a topic-prefix filter (prefix match, ZMQ semantics).
"worker."— all events from sourceworker"worker.sandbox123.started"— exact topic""— all events (subscribe-all)
Must be called before the first recv(). Mutually exclusive with
Self::subscribe_oid (legacy flat-track subscription).
Sourcepub fn subscribe_all(&mut self) -> Result<()>
pub fn subscribe_all(&mut self) -> Result<()>
Subscribe to all events (pattern = "").
Sourcepub fn unsubscribe(&mut self, pattern: &str) -> Result<()>
pub fn unsubscribe(&mut self, pattern: &str) -> Result<()>
Unsubscribe from a pattern. Must be called before recv().
Sourcepub fn subscribe_oid(&mut self, oid: &str) -> Result<()>
pub fn subscribe_oid(&mut self, oid: &str) -> Result<()>
Subscribe to a single model OID’s per-OID publication track (#393).
The subscriber scopes its origin consumer to
local/events/publications/{oid_hash} and reads only that track, so only
events published for oid cross the wire (one QUIC uni-stream per group
on the wire). This replaces the flat firehose + in-memory filter.
Mutually exclusive with Self::subscribe / Self::subscribe_all.
Must be called before the first recv().
Sourcepub fn with_backfill(&mut self, mode: BackfillMode) -> Result<()>
pub fn with_backfill(&mut self, mode: BackfillMode) -> Result<()>
Set the late-join retention mode (decision A: firehose-backfill).
Only meaningful for OID-scoped subscribers (see Self::subscribe_oid):
on first recv(), a BackfillMode::FirehoseBackfill subscriber asks
its BackfillSource for oid history and replays it before going live.
If the source is unavailable the subscriber silently degrades to
live-only (never fails). Must be called before the first recv().
Sourcepub fn with_qos(&mut self, qos: StreamOpt) -> Result<()>
pub fn with_qos(&mut self, qos: StreamOpt) -> Result<()>
Select the delivery QoS (#606). Reuses StreamOpt — pass
crate::stream_info::EventReliable::stream_opt() for at-least-once
delivery (events that must not be silently dropped, e.g.
model.loaded), or any other StreamOpt combination. Defaults to
crate::stream_info::EventLive if never called. Must be called
before the first recv().
Sourcepub fn with_resume_from(&mut self, sequence: u64) -> Result<()>
pub fn with_resume_from(&mut self, sequence: u64) -> Result<()>
Skip live groups with sequence <= resume_from (offset-resume, #606).
Combine with Self::last_sequence to persist a cursor across
reconnects for EventReliable-style at-least-once delivery.
Caveat: a MoqEventSubscriber using the legacy flat-pattern
Self::subscribe API may read from MULTIPLE independent source
broadcasts (each with its own group-sequence counter); resume_from
is applied per-broadcast, so a single threshold is only unambiguous
for Self::subscribe_oid (one broadcast). Multi-source resume
requires a per-source cursor map, which is out of scope here.
Must be called before the first recv().
Sourcepub fn last_sequence(&self) -> u64
pub fn last_sequence(&self) -> u64
Highest live-group sequence delivered so far (best-effort hint for
resume; see Self::with_resume_from). 0 before the first delivery.
Sourcepub fn dropped_count(&self) -> u64
pub fn dropped_count(&self) -> u64
Count of items evicted under OverflowPolicy::DropOldest (#606).
Sourcepub fn idle_resumes(&self) -> u64
pub fn idle_resumes(&self) -> u64
Count of idle-timeout-and-resume cycles on the live read loop (#606).
Sourcepub async fn recv(&mut self) -> Result<(String, Vec<u8>)>
pub async fn recv(&mut self) -> Result<(String, Vec<u8>)>
Receive the next event. Blocks until an event arrives or the bus is closed.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for MoqEventSubscriber
impl !RefUnwindSafe for MoqEventSubscriber
impl Send for MoqEventSubscriber
impl Sync for MoqEventSubscriber
impl Unpin for MoqEventSubscriber
impl UnsafeUnpin for MoqEventSubscriber
impl !UnwindSafe for MoqEventSubscriber
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more