Struct GuestSynchronousProxy

pub struct GuestSynchronousProxy { /* private fields */ }

Implementations

impl GuestSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<GuestEvent, Error>

Waits until an event arrives and returns it. It is safe for other threads to make concurrent requests while waiting for an event.

pub fn get_console( &self, ___deadline: MonotonicInstant, ) -> Result<GuestGetConsoleResult, Error>

Get a guest console.

The details regarding what output is produced and what input is accepted are determined by each guest, but will typically be a read/write socket with a shell.

Returns error DEVICE_NOT_PRESENT if the guest was started without a console device.

pub fn get_serial(&self, ___deadline: MonotonicInstant) -> Result<Socket, Error>

Get the socket for low-level guest debug logs.

The details regarding what output is produced and what input is accepted are determined by each guest, but will typically be a read-only socket with the guest kernel’s serial logs.

pub fn get_host_vsock_endpoint( &self, endpoint: ServerEnd<HostVsockEndpointMarker>, ___deadline: MonotonicInstant, ) -> Result<GuestGetHostVsockEndpointResult, Error>

Get the vsock endpoint for the guest.

This endpoint can be used to register listeners for guest initiated connections, and to initiate connections from a client. If listeners need to be registered before the guest starts so that they are immediately available, set them via the guest config instead of using this endpoint.

Returns error DEVICE_NOT_PRESENT if the guest was started without a vsock device.

pub fn get_balloon_controller( &self, controller: ServerEnd<BalloonControllerMarker>, ___deadline: MonotonicInstant, ) -> Result<GuestGetBalloonControllerResult, Error>

Get the balloon controller endpoint for the guest.

Returns error DEVICE_NOT_PRESENT if the guest was started without a balloon device.

pub fn get_mem_controller( &self, controller: ServerEnd<MemControllerMarker>, ___deadline: MonotonicInstant, ) -> Result<GuestGetMemControllerResult, Error>

Get the mem controller endpoint for the guest.

Returns error DEVICE_NOT_PRESENT if the guest was started without a mem device.

Trait Implementations

impl Debug for GuestSynchronousProxy

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

Formats the value using the given formatter.

impl SynchronousProxy for GuestSynchronousProxy

type Proxy = GuestProxy

The async proxy for the same protocol.

type Protocol = GuestMarker

The protocol which this Proxy controls.

fn from_channel(inner: Channel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Channel

Convert the proxy back into a channel.

fn as_channel(&self) -> &Channel

Get a reference to the proxy’s underlying channel.

fn is_closed(&self) -> Result<bool, Status>

Returns true if the proxy has received the PEER_CLOSED signal.