Struct LifecycleSynchronousProxy

pub struct LifecycleSynchronousProxy { /* private fields */ }

Implementations

impl LifecycleSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<LifecycleEvent, 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, payload: &LifecycleStartRequest, ___deadline: MonotonicInstant, ) -> Result<LifecycleStartResult, Error>

Starts the session.

Returns after the session component has been created and started.

• error LifecycleError.NOT_FOUND if session_url has not been provided and there is no configured default session URL.
• error LifecycleError.ALREADY_STARTED if a session has already been started.
• error LifecycleError.RESOLVE_COMPONENT_FAILED if session_url could not be resolved to a component.
• error LifecycleError.DESTROY_COMPONENT_FAILED if an existing session component could not be destroyed. The existing session remains running at this point.
• error LifecycleError.CREATE_COMPONENT_FAILED if the session component could not be started. No session will be running at this point.

pub fn stop( &self, ___deadline: MonotonicInstant, ) -> Result<LifecycleStopResult, Error>

Stops the session.

Returns after the session component has been destroyed.

• error LifecycleError.NOT_FOUND if the session has not been started.
• error LifecycleError.DESTROY_COMPONENT_FAILED if the session component could not be destroyed. The previous session will continue to exist at this point and the component may be running.

pub fn restart( &self, ___deadline: MonotonicInstant, ) -> Result<LifecycleRestartResult, Error>

Restarts the session.

This stops the existing session and starts a new session with the same session URL as the previous one.

Returns once the new session component has been created and started.

• error LifecycleError.NOT_FOUND if there is no existing session.
• error LifecycleError.RESOLVE_COMPONENT_FAILED if the session URL could not be resolved to a component.
• error LifecycleError.DESTROY_COMPONENT_FAILED if the session component could not be destroyed. The previous session will continue to exist at this point and the component may be running.
• error LifecycleError.CREATE_COMPONENT_FAILED if the session component could not be started. No session will be running at this point.

Trait Implementations

impl Debug for LifecycleSynchronousProxy

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

Formats the value using the given formatter.

impl SynchronousProxy for LifecycleSynchronousProxy

type Proxy = LifecycleProxy

The async proxy for the same protocol.

type Protocol = LifecycleMarker

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.