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>
impl<F> BackendEndpointMux<F>
Sourcepub fn new(
daemon: DaemonProcess,
served_payload_protocols: &[u32],
legacy_detector: F,
) -> Self
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.
Sourcepub fn poll(&self, buf: &[u8]) -> Result<MuxPoll, MuxError>
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.
Sourcepub fn daemon(&self) -> &DaemonProcess
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> 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
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
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)
fn as_any(&self) -> &(dyn Any + 'static)
&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)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&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
impl<T> DowncastSync for T
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