Struct GuestLifecycleProxy

pub struct GuestLifecycleProxy { /* private fields */ }

Implementations

impl GuestLifecycleProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.virtualization/GuestLifecycle.

pub fn take_event_stream(&self) -> GuestLifecycleEventStream

Get a Stream of events from the remote end of the protocol.

Panics

Panics if the event stream was already taken.

pub fn create( &self, guest_config: GuestConfig, ) -> QueryResponseFut<GuestLifecycleCreateResult, DefaultFuchsiaResourceDialect>

Create a VMM configured with the provided config. This instantiates all devices and loads the kernel without starting the VCPU or device dispatch loops.

Possible errors: - ALREADY_RUNNING: A VMM instance is already running, and must be stopped before being recreated.

All other errors are related to VMM initialization.

pub fn bind(&self, guest: ServerEnd<GuestMarker>) -> Result<(), Error>

Binds to the Guest protocol for an initialized guest.

This operation must be called between Create and Stop, otherwise the provided channel will be immediately closed.

pub fn run( &self, ) -> QueryResponseFut<GuestLifecycleRunResult, DefaultFuchsiaResourceDialect>

Start the primary VCPU and any dispatch loop. This will not return until the VMM stops running. On a clean shutdown (either guest or client initiated) this will return success.

Possible errors: - ALREADY_RUNING: The VMM has already been started. - NOT_CREATED: Run was called before the VMM was created. - CONTROLLER_FORCED_HALT: Stop was called on a running VMM. - VCPU_START_FAILURE: Failed to start the primary VCPU. - VCPU_RUNTIME_FAILURE: A VCPU encountered a fatal error while running the guest.

pub fn stop(&self) -> QueryResponseFut<(), DefaultFuchsiaResourceDialect>

Stop a running VMM. Returns once the dispatch loops have stopped. After Stop returns, Create and then Run can be called again.

Trait Implementations

impl Clone for GuestLifecycleProxy

fn clone(&self) -> GuestLifecycleProxy

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GuestLifecycleProxy

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

Formats the value using the given formatter.

impl GuestLifecycleProxyInterface for GuestLifecycleProxy

type CreateResponseFut = QueryResponseFut<Result<(), GuestError>>

type RunResponseFut = QueryResponseFut<Result<(), GuestError>>

type StopResponseFut = QueryResponseFut<()>

fn create(&self, guest_config: GuestConfig) -> Self::CreateResponseFut

fn bind(&self, guest: ServerEnd<GuestMarker>) -> Result<(), Error>

fn run(&self) -> Self::RunResponseFut

fn stop(&self) -> Self::StopResponseFut

impl Proxy for GuestLifecycleProxy

type Protocol = GuestLifecycleMarker

The protocol which this Proxy controls.

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel.

fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed(&self) -> OnSignals<'_, Unowned<'_, Handle>>

Returns a future that completes when the proxy receives the PEER_CLOSED signal.