Skip to main content

SocketTransport

Struct SocketTransport 

Source
pub struct SocketTransport {
    pub welcome: Welcome,
    /* private fields */
}

Fields§

§welcome: Welcome

Implementations§

Source§

impl SocketTransport

Source

pub async fn connect( path: &Path, hello: Hello, ) -> Result<Connected, TransportError>

Hello/Welcome only (50 ms connect + 2 s handshake budgets).

Source

pub async fn attach( conn: Connected, attach: Attach, ) -> Result<(Self, AttachSnapshot), TransportError>

Attach (existing or create) on a handshaken connection. AttachRefused and DaemonFrame::Error alike → TransportError::Refused. Waits ATTACH_TIMEOUT_PARKED when the daemon lists the session as Parked.

Source

pub fn last_error(&self) -> Option<&TransportError>

Why the last next_event returned None (if it was not a plain end).

Source

pub fn is_reload_pending(&self) -> bool

true if the daemon announced a reload before EOF (graceful); false means a crash/SIGKILL (unexpected).

Source

pub fn daemon_pid(&self) -> u32

The pid the daemon reported in Welcome.

Source

pub fn reconnect_budget() -> Duration

The reconnect budget from SYNAPS_TUI_ATTACH_RECONNECT_SECS (default 60).

Source

pub async fn reconnect_once( &mut self, mode: AttachMode, ) -> Result<AttachSnapshot, TransportError>

One attempt at reconnecting (Hello + Attach). On success replaces self and returns the snapshot. On Refused / Version the error is terminal (caller should stop retrying). Other errors are transient.

Source

pub async fn ping(path: &Path) -> Result<Pong, TransportError>

Source

pub async fn sessions(path: &Path) -> Result<Vec<SessionMeta>, TransportError>

Source

pub async fn shutdown(path: &Path, force: bool) -> Result<(), TransportError>

Source

pub async fn purge(path: &Path) -> Result<Pong, TransportError>

Source

pub async fn reload( path: &Path, now: bool, drain_secs: Option<u64>, exe: Option<PathBuf>, ) -> Result<u64, TransportError>

Reload{..} on a control connection. Ok(generation) once the daemon answered Bye{Reloading{generation}} (it is about to exec); Refused{ReloadRefused} / Error → Err.

Source

pub async fn detach(&self)

Detach cleanly: Detach + Bye. The turn keeps running in the daemon.

Source

pub fn messages(&self) -> &[SharedMessage] ⓘ

The client’s view of api_messages (kept current by the digest protocol in Full mode; always empty in Digest mode).

Source

pub fn last_frame_bytes(&self) -> usize

Length in bytes of the last frame decoded on this connection (the Attached frame right after attach).

Source

pub fn history_mode(&self) -> HistoryMode

Trait Implementations§

Source§

impl ClientTransport for SocketTransport

Source§

fn send_from_self<'life0, 'async_trait>( &'life0 self, cmd: SessionCommand, ) -> Pin<Box<dyn Future<Output = Result<(), TransportError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

The daemon’s conn stamps from with this connection’s client id, so on the wire send and send_from_self are the same frame.

Source§

fn reconnect<'life0, 'async_trait>( &'life0 mut self, mode: AttachMode, ) -> Pin<Box<dyn Future<Output = Result<AttachSnapshot, TransportError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

C3: after Reloading/EOF — backoff 100 ms ×2 → cap 5 s, total ≤ SYNAPS_TUI_ATTACH_RECONNECT_SECS (60); Hello{reconnect_of} → Attach::Existing{alias-resolved id, mode} where mode = Takeover iff this client was the input owner (§2.7: two reconnecting mirrors cannot both take over). On success self IS the new connection; the returned snapshot is a full re-mirror.

Source§

fn session_id(&self) -> &SessionId

Source§

fn meta(&self) -> &SessionMeta

Source§

fn send<'life0, 'async_trait>( &'life0 self, cmd: SessionCommand, ) -> Pin<Box<dyn Future<Output = Result<(), TransportError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Host-originated send (from: None; bypasses input ownership).
Source§

fn next_event<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Option<Envelope>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Next envelope, or None when the session ended / socket closed.
Source§

fn view(&self) -> Arc<RuntimeView> ⓘ

Sync, cheap, never stale by more than one SettingChanged: what the TUI’s getters read on day 2.
Source§

fn client_id(&self) -> ClientId

Client id assigned at Attach (needed for Detach/Resync).
Source§

fn mode(&self) -> AttachMode

The mode this transport attached with.
Source§

fn input_owner(&self) -> Option<ClientId>

Current input owner — updated from Attached / InputOwnerChanged.
Source§

fn reconnect_once<'life0, 'async_trait>( &'life0 mut self, mode: AttachMode, ) -> Pin<Box<dyn Future<Output = Result<AttachSnapshot, TransportError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

F9: single reconnect attempt (no retry loop). Socket only.
Source§

fn is_reload_pending(&self) -> bool

true if the daemon announced a reload before EOF (graceful). Always false on LocalTransport.
Source§

fn daemon_pid(&self) -> u32

The daemon pid from Welcome. Returns 0 on LocalTransport.

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> 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<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + 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
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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