Struct WakeAlarmsSynchronousProxy

pub struct WakeAlarmsSynchronousProxy { /* private fields */ }

Implementations

impl WakeAlarmsSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<WakeAlarmsEvent, 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, mode: SetMode, alarm_id: &str, ___deadline: MonotonicInstant, ) -> Result<WakeAlarmsSetAndWaitResult, Error>

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

The caller may request multiple alarms concurrently. Re-requesting an alarm that has the same alarm_id as an already scheduled alarm causes that scheduled alarm to be canceled before the new alarm is scheduled.

Return value

• keep_alive: A handle that prevents the system from suspending as long as it is held.

The call to SetAndWait returns when the alarm fires, an error occurs, or the alarm is canceled. This return style is required for some clients, such as Starnix, which rely on FIDL response tallying to guide their power management strategy.

As an example, under Starnix, a response to this request will cause a Starnix container to be unsuspended (“woken up”). This is a critical behavior for suspend correctness under Starnix. Using the [Notifier] approach would side-step this mechanism and result in incorrect wake behavior under Starnix.

Protocol Errors

• DROPPED: The alarm was canceled by a call to Cancel.
• UNSPECIFIED: A new failure mode has been observed that has not yet been assigned an error code. This indicates that the API version may need to be updated.
• INTERNAL is a server-side bug: an internal fallible call (which is expected to be unlikely to fail) has failed somehow. Please report this for investigation.
• [INVALID_ARGS]: a parameter provided by the user is not valid, such as an empty alarm_id.

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

Cancels the alarm specified by alarm_id.

Providing an alarm_id for an alarm that is not scheduled is a no-op.

pub fn set( &self, notifier: ClientEnd<NotifierMarker>, deadline: BootInstant, mode: SetMode, alarm_id: &str, ___deadline: MonotonicInstant, ) -> Result<WakeAlarmsSetResult, Error>

Sets a wake alarm with the provided parameters.

The caller may request multiple alarms concurrently. Re-requesting an alarm that has the same alarm_id as an already scheduled alarm causes that scheduled alarm to be canceled before the same alarm is scheduled again.

Return value

This method will return when the alarm is scheduled.

Protocol Errors

• [UNSPECIFIED] you are observing a new failure mode which has not been assigned an error code yet. Expect this failure mode to be assigned a more specific error code in future versions of this API. This is not a bug, but an indication that you may need to update the API version.
• [INTERNAL] is a bug: an internal fallible call (which is expected to be unlikely to fail) has failed somehow. Please report this for investigation.
• [INVALID_ARGS]: a parameter provided by the user is not valid, such as an empty alarm_id.

pub fn set_and_wait_utc( &self, deadline: &InstantUtc, mode: SetMode, alarm_id: &str, ___deadline: MonotonicInstant, ) -> Result<WakeAlarmsSetAndWaitUtcResult, Error>

Similar to [SetAndWait], except the alarm is scheduled on the UTC timeline.

Refer to [SetAndWait] documentation for the functionality details, and especially see the section “Return value” for the return value subtleties.

Trait Implementations

impl Debug for WakeAlarmsSynchronousProxy

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

Formats the value using the given formatter.

impl From<Channel> for WakeAlarmsSynchronousProxy

fn from(value: Channel) -> Self

Converts to this type from the input type.

impl From<WakeAlarmsSynchronousProxy> for Handle

fn from(value: WakeAlarmsSynchronousProxy) -> Self

Converts to this type from the input type.

impl FromClient for WakeAlarmsSynchronousProxy

type Protocol = WakeAlarmsMarker

The protocol.

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

Converts from a client.

impl SynchronousProxy for WakeAlarmsSynchronousProxy

type Proxy = WakeAlarmsProxy

The async proxy for the same protocol.

type Protocol = WakeAlarmsMarker

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.