pub struct WakeAlarmsProxy { /* private fields */ }
Implementations§
Source§impl WakeAlarmsProxy
impl WakeAlarmsProxy
Sourcepub fn new(channel: AsyncChannel) -> Self
pub fn new(channel: AsyncChannel) -> Self
Create a new Proxy for fuchsia.time.alarms/WakeAlarms.
Sourcepub fn take_event_stream(&self) -> WakeAlarmsEventStream
pub fn take_event_stream(&self) -> WakeAlarmsEventStream
Get a Stream of events from the remote end of the protocol.
§Panics
Panics if the event stream was already taken.
Sourcepub fn set_and_wait(
&self,
deadline: BootInstant,
mode: SetMode,
alarm_id: &str,
) -> QueryResponseFut<WakeAlarmsSetAndWaitResult, DefaultFuchsiaResourceDialect>
pub fn set_and_wait( &self, deadline: BootInstant, mode: SetMode, alarm_id: &str, ) -> QueryResponseFut<WakeAlarmsSetAndWaitResult, DefaultFuchsiaResourceDialect>
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.
Sourcepub fn cancel(&self, alarm_id: &str) -> Result<(), Error>
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.
Sourcepub fn set(
&self,
notifier: ClientEnd<NotifierMarker>,
deadline: BootInstant,
mode: SetMode,
alarm_id: &str,
) -> QueryResponseFut<WakeAlarmsSetResult, DefaultFuchsiaResourceDialect>
pub fn set( &self, notifier: ClientEnd<NotifierMarker>, deadline: BootInstant, mode: SetMode, alarm_id: &str, ) -> QueryResponseFut<WakeAlarmsSetResult, DefaultFuchsiaResourceDialect>
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.
Trait Implementations§
Source§impl Clone for WakeAlarmsProxy
impl Clone for WakeAlarmsProxy
Source§fn clone(&self) -> WakeAlarmsProxy
fn clone(&self) -> WakeAlarmsProxy
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for WakeAlarmsProxy
impl Debug for WakeAlarmsProxy
Source§impl Proxy for WakeAlarmsProxy
impl Proxy for WakeAlarmsProxy
Source§type Protocol = WakeAlarmsMarker
type Protocol = WakeAlarmsMarker
Proxy
controls.