Skip to main content

StreamMultiplexer

Struct StreamMultiplexer 

Source
pub struct StreamMultiplexer { /* private fields */ }
Expand description

Multiplexes multiple concurrent inference requests over a shared pipeline transport pair.

The PipelineStageRuntime send/recv methods process one message at a time. When multiple requests are in flight (e.g. batched API requests), their responses must be routed back to the correct caller by nonce.

StreamMultiplexer provides two complementary APIs:

§Typical usage

// Spawn one background task that continuously calls dispatch_incoming:
tokio::spawn(async move {
    loop {
        mux.dispatch_incoming(&mut stage).await.unwrap();
    }
});

// Each request task calls send_and_await:
let response = mux.send_and_await(msg, &mut stage).await?;

Implementations§

Source§

impl StreamMultiplexer

Source

pub fn new() -> Self

Create a new, empty multiplexer.

Source

pub fn register_handler(&mut self, nonce: u64) -> Receiver<ActivationMessage>

Register a one-shot handler that fires when a response with nonce arrives.

Returns the corresponding oneshot::Receiver which the caller can await to get the response. If a handler for the same nonce is already registered, it is replaced and the old receiver will never fire.

Source

pub async fn send_and_await( &mut self, msg: ActivationMessage, stage: &mut PipelineStageRuntime, ) -> DistributedResult<ActivationMessage>

Send msg via stage and await the matching response.

This is a higher-level convenience that calls register_handler, forwards the message to the next shard, and then awaits the registered one-shot receiver.

§Errors

Returns DistributedError::Cancelled if the dispatch task drops the sender before delivering a response (e.g. on transport error).

Source

pub async fn dispatch_incoming( &mut self, stage: &mut PipelineStageRuntime, ) -> DistributedResult<()>

Receive one incoming message from stage and route it to the waiting caller identified by its nonce.

This should be called repeatedly from a dedicated background task:

loop {
    mux.dispatch_incoming(&mut stage).await?;
}

Messages whose nonce is not in pending (e.g. unsolicited or already cancelled) are silently dropped.

Source

pub fn pending_count(&self) -> usize

Number of requests currently awaiting a response.

Trait Implementations§

Source§

impl Default for StreamMultiplexer

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.

Source§

impl<T> Instrument for T

Source§

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

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

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

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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