Struct InspectSinkSynchronousProxy

pub struct InspectSinkSynchronousProxy { /* private fields */ }

Implementations

impl InspectSinkSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<InspectSinkEvent, 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 publish(&self, payload: InspectSinkPublishRequest) -> Result<(), Error>

Publishes a handle to the fuchsia.inspect.Tree protocol that the server can use to read Inspect data, including lazy nodes.

pub fn escrow(&self, payload: InspectSinkEscrowRequest) -> Result<(), Error>

Instructs the server to store the VMO provided to make its data available to Inspect readers, even when the component that published this VMO isn’t running.

This is meant to be used when integrating with Component Framework’s Escrow APIs to enable stopping when IDLE but still ensure that some useful diagnostics information is available.

The client must provide a token that will be used as a unique identifier to this VMO by the the server. This token is an event pair, a client must provide one end of this event pair and hold to the other end (or escrow the handle it using Component APIs). If the server sees a PEER_CLOSED on the handle it received, it will drop the VMO associated with this token.

If any of the required arguments isn’t passed the connection will be closed.

To learn more about stopping IDLE components, please refer to: https://fuchsia.dev/fuchsia-src/development/components/stop_idle

pub fn fetch_escrow( &self, payload: InspectSinkFetchEscrowRequest, ___deadline: MonotonicInstant, ) -> Result<InspectSinkFetchEscrowResponse, Error>

Instructs the server to return (and stop tracking) the VMO associated with the given token.

This is meant to be used when a component restarts and wants to fetch Inspect data that it escrowed.

To learn more about stopping IDLE components, please refer to: https://fuchsia.dev/fuchsia-src/development/components/stop_idle

Trait Implementations

impl Debug for InspectSinkSynchronousProxy

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

Formats the value using the given formatter.

impl SynchronousProxy for InspectSinkSynchronousProxy

type Proxy = InspectSinkProxy

The async proxy for the same protocol.

type Protocol = InspectSinkMarker

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.