Struct WakeSynchronousProxy

pub struct WakeSynchronousProxy { /* private fields */ }

Implementations

impl WakeSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<WakeEvent, 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 set_and_wait( &self, deadline: BootInstant, setup_done: Event, alarm_id: &str, ___deadline: MonotonicInstant, ) -> Result<ClientSideBatonManagementSetAndWaitResult, Error>

Sets a wake alarm with the provided parameters, and waits for the alarm to fire.

The caller MAY request multiple alarms open concurrently. However, the callee is not required to support any specific number of open alarms.

The call to SetAndWait will hang until the alarm fires, or an error occurs.

In the event that the caller requests more open alarms than the callee is willing to provide, the callee SHOULD reject the new request, but honor previous requests.

Return value

• keep_alive: a handle which prevents system suspend so long as it is held alive.

This method will return when the alarm set in the call fires.

Protocol Errors

• [DROPPED] if the alarm has been canceled by using [Cancel].
• [UNSPECIFIED] a new error mode has occurred, please report this for investigatin.
• [INTERNAL] is a bug: an internal fallible call (which is expected to be unlikely to fail) has failed somehow. Please report this for investigation.

pub fn cancel(&self, alarm_id: &str) -> Result<(), Error>

Cancels the alarm specified by alarm_id.

Providing an alarm_id of an alarm that is not scheduled quietly succeeds.

pub fn cancel_sync( &self, alarm_id: &str, ___deadline: MonotonicInstant, ) -> Result<ClientSideBatonManagementCancelSyncResult, Error>

Same as [Cancel], but waits until alarm_id is canceled.

pub fn get_properties( &self, ___deadline: MonotonicInstant, ) -> Result<WakeGetPropertiesResponse, Error>

Call to establish whether Wake is operational. This just returns immediately.

Trait Implementations

impl Debug for WakeSynchronousProxy

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

Formats the value using the given formatter.

impl SynchronousProxy for WakeSynchronousProxy

type Proxy = WakeProxy

The async proxy for the same protocol.

type Protocol = WakeMarker

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.