Enum WakeAlarmsRequest

pub enum WakeAlarmsRequest {
    SetAndWait {
        deadline: BootInstant,
        mode: SetMode,
        alarm_id: String,
        responder: WakeAlarmsSetAndWaitResponder,
    },
    Cancel {
        alarm_id: String,
        control_handle: WakeAlarmsControlHandle,
    },
    _UnknownMethod {
        ordinal: u64,
        control_handle: WakeAlarmsControlHandle,
        method_type: MethodType,
    },
}

[WakeAlarms] 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 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.

The call to SetAndWait returns when the alarm fires, or an error occurs, or the alarm is canceled.

Return value

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

Protocol Errors

• [DROPPED] if the alarm has been canceled by using [Cancel].
• [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.

Fields

deadline: BootInstant

mode: SetMode

alarm_id: String

responder: WakeAlarmsSetAndWaitResponder

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: WakeAlarmsControlHandle

_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: WakeAlarmsControlHandle

method_type: MethodType

Implementations

impl WakeAlarmsRequest

pub fn into_set_and_wait( self, ) -> Option<(BootInstant, SetMode, String, WakeAlarmsSetAndWaitResponder)>

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

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

Name of the method defined in FIDL

Trait Implementations

impl Debug for WakeAlarmsRequest

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

Formats the value using the given formatter.