Struct ShutdownWatcherRegisterSynchronousProxy 

pub struct ShutdownWatcherRegisterSynchronousProxy { /* private fields */ }

Implementations

impl ShutdownWatcherRegisterSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<ShutdownWatcherRegisterEvent, 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 register_watcher( &self, watcher: ClientEnd<ShutdownWatcherMarker>, ___deadline: MonotonicInstant, ) -> Result<(), Error>

Registers a watcher to be notified when the Admin.Shutdown method is called.

Once the watcher has been successfully registered with the server, then the request will be completed and the ShutdownWatcherRegister channel will be left open (though a client is free to close it at this time).

If there is an error in registering the watcher, then the ShutdownWatcherRegister channel will be closed without completing the request.

The provided watcher channel will be used at most once to notify the watcher of an impending shutdown and allow it the chance to respond.

Watchers can unregister by closing their ShutdownWatcher channel.

pub fn register_terminal_state_watcher( &self, watcher: ClientEnd<TerminalStateWatcherMarker>, ___deadline: MonotonicInstant, ) -> Result<(), Error>

Registers a watcher to be notified when the system begins a transition to a terminal state regardless of the trigger.

The [TerminalStateWatcher] is notified for all reboots, power-offs, and kernel-initiated shutdowns. It does not provide reasons or options.

Once the watcher has been successfully registered with the server, then the request will be completed and the ShutdownWatcherRegister channel will be left open (though a client is free to close it at this time).

If there is an error in registering the watcher, then the ShutdownWatcherRegister channel will be closed without completing the request.

The provided watcher channel will be used at most once to notify the watcher of an impending shutdown and allow it the chance to respond.

Watchers can unregister by closing their TerminalStateWatcher channel.

Trait Implementations

impl Debug for ShutdownWatcherRegisterSynchronousProxy

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

Formats the value using the given formatter.

impl From<Channel> for ShutdownWatcherRegisterSynchronousProxy

Available on Fuchsia only.

fn from(value: Channel) -> Self

Converts to this type from the input type.

impl From<ShutdownWatcherRegisterSynchronousProxy> for NullableHandle

Available on Fuchsia only.

fn from(value: ShutdownWatcherRegisterSynchronousProxy) -> Self

Converts to this type from the input type.

impl FromClient for ShutdownWatcherRegisterSynchronousProxy

Available on Fuchsia only.

type Protocol = ShutdownWatcherRegisterMarker

The protocol.

fn from_client(value: ClientEnd<ShutdownWatcherRegisterMarker>) -> Self

Converts from a client.

impl SynchronousProxy for ShutdownWatcherRegisterSynchronousProxy

Available on Fuchsia only.

type Proxy = ShutdownWatcherRegisterProxy

The async proxy for the same protocol.

type Protocol = ShutdownWatcherRegisterMarker

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.