Skip to main content

Session

Struct Session 

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

A booted VM and everything that must outlive its dispatch queue.

Implementations§

Source§

impl Session

Source

pub fn start(config: &Config) -> Result<Session, Error>

Build the VZ config, create the VM on its own serial queue, install the delegate / vsock listener / timeout, and call start. Returns once the VM has been asked to start; the boot proceeds on the VM’s queue (a libdispatch worker thread) and the terminal event is observed via Session::wait.

Snapshot configs are rejected here — those still go through [crate::vz::snapshot] from crate::run.

Source

pub fn vsock_port(&self) -> Option<u32>

The resolved vsock host port (None if vsock is disabled). Stable for the session’s lifetime — read it for banners/logging instead of re-resolving, which would re-randomize an Auto port.

Source

pub fn cmdline(&self) -> &str

The assembled kernel command line.

Source

pub fn wait(&self) -> SessionEnd

Block until the session ends, then return how it ended. Safe to call after the end was already recorded (returns immediately). Does not pump any run loop — the VM runs on its own dispatch queue.

Source

pub fn stop(&self)

Request a graceful force-stop of the guest. The stop completes on the VM’s queue and records SessionEnd::Stopped, unblocking a concurrent Session::wait. No-op if the session has already ended.

Source

pub fn request( &self, action: &Action, ) -> Result<(ResponseHeader, Vec<u8>), Error>

Send a desktop Action to the in-guest agent and block for its response (a ResponseHeader plus an optional binary payload, e.g. a PNG for Action::Screenshot). See SessionClient::request.

Source

pub fn client(&self) -> SessionClient

Extract a Send client for issuing desktop requests from another thread (the daemon hands these to its async request handlers). Shares the agent connection with the Session; the fd is closed once the last holder drops.

Source

pub fn stop_handle(&self) -> StopHandle

Extract a Send handle for stopping the session from another thread. Stopping unblocks the thread that owns the Session in Session::wait, which then tears the VM down by dropping it.

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

impl<T> AutoreleaseSafe for T
where T: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,