Enum WakeRequest

pub enum WakeRequest {
    SetAndWait {
        deadline: BootInstant,
        setup_done: Event,
        alarm_id: String,
        responder: WakeSetAndWaitResponder,
    },
    Cancel {
        alarm_id: String,
        control_handle: WakeControlHandle,
    },
    _UnknownMethod {
        ordinal: u64,
        control_handle: WakeControlHandle,
        method_type: MethodType,
    },
}

[Wake] provides setting up platform-wide wake alarms.

An alarm is a promise made by the system to the caller of the API to notify the caller that AT LEAST a certain amount of time has expired. The alarm may fire later than the requested amount of time at the discretion of the server implementing this API.

When this notification happens, we say that the wake alarm has “fired”.

A “wake” alarm firing also ensures that the system comes back from a reduced power state if needed, so that it can notify the caller.

The general shape of a wake alarm API has three parts:

• A specification of when a wake alarm is supposed to fire,
• A way to notify the caller of an alarm that fired, and
• A way to keep the system awake until both the caller and the callee have completed work associated with the alarm.

Variants

SetAndWait

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.

Fields

deadline: BootInstant

setup_done: Event

alarm_id: String

responder: WakeSetAndWaitResponder

Cancel

Cancels the alarm specified by alarm_id.

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

Fields

alarm_id: String

control_handle: WakeControlHandle

_UnknownMethod

An interaction was received which does not match any known method.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

ordinal: u64

Ordinal of the method that was called.

control_handle: WakeControlHandle

method_type: MethodType

Implementations

impl WakeRequest

pub fn into_set_and_wait( self, ) -> Option<(BootInstant, Event, String, WakeSetAndWaitResponder)>

pub fn into_cancel(self) -> Option<(String, WakeControlHandle)>

pub fn method_name(&self) -> &'static str

Name of the method defined in FIDL

Trait Implementations

impl Debug for WakeRequest

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

Formats the value using the given formatter.