Enum ClientFrame 

pub enum ClientFrame {
    Hello(Hello),
    Ping,
    Sessions,
    Shutdown {
        force: bool,
    },
    Attach(Attach),
    Cmd {
        session_id: SessionId,
        cmd: SessionCommand,
    },
    Reload {
        now: bool,
        drain_secs: Option<u64>,
        exe: Option<PathBuf>,
    },
    Purge,
    Close {
        session_id: SessionId,
        force: bool,
        attached: bool,
    },
    Pin {
        session_id: SessionId,
        on: bool,
    },
    AuthState(AuthStateQuery),
    ReloadExtension {
        extension: String,
    },
    Bye,
}

Client → daemon. First frame on a connection MUST be Hello.

Variants

Hello(Hello)

Ping

Sessions

Shutdown

Fields

force: bool

Attach(Attach)

Cmd

Fields

session_id: SessionId

cmd: SessionCommand

Reload

Control fast path (no session): checkpoint every session, write reload-state, execv self. Reply: Reloading to every attached client, Bye to this one. (C3)

Fields

now: bool

drain_secs: Option<u64>

exe: Option<PathBuf>

Purge

Control fast path: memstat::purge_arenas() in the daemon (bench hygiene). Reply: Pong. (C2)

Close

Control fast path: end one session as /close [force] would, with host authority (no attach, never unparks). A session with clients attached is refused unless attached (--attached); force only overrides work in flight. Reply: Closed, or Refused{Busy|UnknownSession}. Not accepted on an attached connection (that client has /close).

Fields

session_id: SessionId

force: bool

attached: bool

Pin

Control fast path: pin (on) or unpin one session, as /pin on|off would, with host authority. on is required so a frame always says which way it goes. Pinning a parked session unparks it; unpinning one leaves it parked. Reply: Pinned, or Refused{Busy|UnknownSession}. Not accepted on an attached connection (that client has /pin).

Fields

session_id: SessionId

on: bool

AuthState(AuthStateQuery)

Control fast path (no session): the in-memory account state of the broker every session of this daemon shares (synaps auth state), cleared first when clear is set. Reply: AuthState. A daemon that predates this frame answers Error “malformed frame: unknown variant auth_state, …” and keeps the connection usable.

ReloadExtension

Control fast path (no session): stop one extension and start it again from what is installed now (synaps daemon reload-extension). Extensions are daemon-wide, so every session gets the new version; no session is checkpointed and no turn is cancelled (only a call into the old process that is in flight fails). Also loads a plugin installed after the daemon started. Reply: ExtensionReloaded, ExtensionReloadFailed, or Refused{Busy} while the daemon reloads. Not accepted on an attached connection.

Fields

extension: String

Bye

Trait Implementations

impl Debug for ClientFrame

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Frame types only for anything that can carry user text or a secret (SessionCommand’s own Debug redacts bodies without lengths).

impl<'de> Deserialize<'de> for ClientFrame

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ClientFrame

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.