Struct ControllerSynchronousProxy

pub struct ControllerSynchronousProxy { /* private fields */ }

Implementations

impl ControllerSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<ControllerEvent, 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 start( &self, args: StartChildArgs, execution_controller: ServerEnd<ExecutionControllerMarker>, ___deadline: MonotonicInstant, ) -> Result<ControllerStartResult, Error>

Start the component, optionally providing additional handles to be given to the component. Returns INSTANCE_ALREADY_RUNNING if the instance is currently running.

pub fn is_started( &self, ___deadline: MonotonicInstant, ) -> Result<ControllerIsStartedResult, Error>

Returns true if this instance is currently running.

pub fn get_exposed_dictionary( &self, ___deadline: MonotonicInstant, ) -> Result<ControllerGetExposedDictionaryResult, Error>

Returns the dictionary containing the component’s exposed capabilities.

pub fn destroy( &self, ___deadline: MonotonicInstant, ) -> Result<ControllerDestroyResult, Error>

Destroys this component. When this method returns, either:

• Ok was returned, indicating destruction has begun.
• An error was returned, and destruction will not be attempted.

If Ok was returned, destruction will proceed in the background, but it hasn’t necessarily completed yet. When it completes, the framework will close this [Controller] channel.

Errors:

• ACCESS_DENIED: Destruction of this component is not allowed. Currently, this can happen if the component is a static child of its parent.

Trait Implementations

impl Debug for ControllerSynchronousProxy

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

Formats the value using the given formatter.

impl SynchronousProxy for ControllerSynchronousProxy

type Proxy = ControllerProxy

The async proxy for the same protocol.

type Protocol = ControllerMarker

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.