Skip to main content

MoqEventSubscriber

Struct MoqEventSubscriber 

Source
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

Source

pub fn new() -> Self

Create a new subscriber. No background task is started yet.

Source

pub fn subscribe(&mut self, pattern: &str) -> Result<()>

Add a topic-prefix filter (prefix match, ZMQ semantics).

  • "worker." — all events from source worker
  • "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).

Source

pub fn subscribe_all(&mut self) -> Result<()>

Subscribe to all events (pattern = "").

Source

pub fn unsubscribe(&mut self, pattern: &str) -> Result<()>

Unsubscribe from a pattern. Must be called before recv().

Source

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().

Source

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().

Source

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().

Source

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().

Source

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.

Source

pub fn dropped_count(&self) -> u64

Count of items evicted under OverflowPolicy::DropOldest (#606).

Source

pub fn idle_resumes(&self) -> u64

Count of idle-timeout-and-resume cycles on the live read loop (#606).

Source

pub async fn recv(&mut self) -> Result<(String, Vec<u8>)>

Receive the next event. Blocks until an event arrives or the bus is closed.

Source

pub async fn recv_timeout( &mut self, timeout: Duration, ) -> Result<Option<(String, Vec<u8>)>>

Receive with timeout.

Source

pub fn try_recv(&mut self) -> Result<Option<(String, Vec<u8>)>>

Try to receive without blocking.

Trait Implementations§

Source§

impl Default for MoqEventSubscriber

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> ServiceExt for T

§

fn map_response_body<F>(self, f: F) -> MapResponseBody<Self, F>
where Self: Sized,

Apply a transformation to the response body. Read more
§

fn trace_for_http(self) -> Trace<Self, SharedClassifier<ServerErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using HTTP status codes. Read more
§

fn trace_for_grpc(self) -> Trace<Self, SharedClassifier<GrpcErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using gRPC headers. Read more
§

fn follow_redirects(self) -> FollowRedirect<Self>
where Self: Sized,

Follow redirect resposes using the Standard policy. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSend for T
where T: Send,

§

impl<T> MaybeSend for T
where T: Send,

§

impl<T> MaybeSync for T
where T: Sync,

§

impl<T> MaybeSync for T
where T: Sync,