Skip to main content

BackendEndpointMux

Struct BackendEndpointMux 

Source
pub struct BackendEndpointMux<F> { /* private fields */ }
Expand description

Sans-io classifier for a backend daemon endpoint.

Construct one per daemon (it is cheap and immutable; sharing behind an Arc is fine) with the daemon’s own DaemonProcess identity, the consumer payload protocols it serves, and a legacy detector closure. In the accept loop, buffer reads as usual and call Self::poll:

use running_process::broker::backend_sdk::{
    BackendEndpointMux, LegacyClassification, MuxPoll,
};
use running_process::broker::backend_handle::DaemonProcess;
use running_process::broker::protocol::Endpoint;

let endpoint = Endpoint::unix_socket("my-daemon", "/tmp/my-daemon.sock")?;
let daemon = DaemonProcess::current_process(endpoint, None)?;
let mux = BackendEndpointMux::new(daemon, &[0x7A63], |buf| {
    // First byte of my legacy wire is always the ASCII 'L' magic.
    match buf.first() {
        None => LegacyClassification::NeedMoreBytes,
        Some(b'L') => LegacyClassification::Legacy,
        Some(_) => LegacyClassification::NotLegacy,
    }
});

let mut read_buf: Vec<u8> = Vec::new();
// ... read bytes into read_buf, then:
match mux.poll(&read_buf)? {
    MuxPoll::NeedMoreBytes => { /* read more */ }
    MuxPoll::Legacy => { /* my own decoder takes over */ }
    MuxPoll::ProbeAnswered { reply, consumed } => {
        // write `reply`, then read_buf.drain(..consumed);
    }
    MuxPoll::Payload { frame, consumed } => {
        // dispatch frame.payload, then read_buf.drain(..consumed);
    }
}

Daemons with no legacy wire pass a detector that always returns LegacyClassification::NotLegacy.

Implementations§

Source§

impl<F> BackendEndpointMux<F>
where F: Fn(&[u8]) -> LegacyClassification,

Source

pub fn new( daemon: DaemonProcess, served_payload_protocols: &[u32], legacy_detector: F, ) -> Self

Build a mux for daemon, serving the given consumer payload protocols, with a consumer-provided legacy-wire detector.

Source

pub fn poll(&self, buf: &[u8]) -> Result<MuxPoll, MuxError>

Classify the front of buf and, for probes, build the reply.

Pure with respect to I/O: never reads or writes a socket and never consumes from buf — the returned consumed counts tell the caller how far to advance. See MuxPoll for the contract of each verdict and MuxError for connection-fatal outcomes.

Source

pub fn daemon(&self) -> &DaemonProcess

The daemon identity this mux answers probes with.

Auto Trait Implementations§

§

impl<F> Freeze for BackendEndpointMux<F>
where F: Freeze,

§

impl<F> RefUnwindSafe for BackendEndpointMux<F>
where F: RefUnwindSafe,

§

impl<F> Send for BackendEndpointMux<F>
where F: Send,

§

impl<F> Sync for BackendEndpointMux<F>
where F: Sync,

§

impl<F> Unpin for BackendEndpointMux<F>
where F: Unpin,

§

impl<F> UnsafeUnpin for BackendEndpointMux<F>
where F: UnsafeUnpin,

§

impl<F> UnwindSafe for BackendEndpointMux<F>
where F: UnwindSafe,

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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.