Struct SuspendBlockerProxy

pub struct SuspendBlockerProxy { /* private fields */ }

Implementations

impl SuspendBlockerProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.power.system/SuspendBlocker.

pub fn take_event_stream(&self) -> SuspendBlockerEventStream

Get a Stream of events from the remote end of the protocol.

Panics

Panics if the event stream was already taken.

pub fn before_suspend( &self, ) -> QueryResponseFut<(), DefaultFuchsiaResourceDialect>

Called after system activity governor begins operations to suspend the hardware platform.

The server is expected to respond once it has performed the operations it needs to prepare itself for suspend, if any. All dependencies of ExecutionStateLevel::SUSPENDING are guaranteed to be satisified for the duration of this call and may be revoked once the server replies.

Operations to suspend the hardware platform may vary between different hardware platforms and product configurations. At a minimum, the client and server MUST assume that general code execution continues until a reply to this call is received by the client. If the SuspendBlocker wants to preempt suspend operations, it MUST call ActivityGovernor.AcquireWakeLease before replying to this call.

SuspendBlocker MUST NOT call ActivityGovernor.TakeApplicationActivityLease nor perform any action that blocks on raising Execution State above its Inactive level. (However, AcquireWakeLease does not block in this way and is safe to call.) Doing so will currently result in a deadlock. This constraint will eventually be removed; see https://fxbug.dev/391429689.

pub fn after_resume( &self, ) -> QueryResponseFut<(), DefaultFuchsiaResourceDialect>

Called after system activity governor is aware that the hardware platform has resumed.

All dependencies of ExecutionStateLevel::SUSPENDING are guaranteed to be satisified when this call is issued, and the BeforeSuspend method will be invoked before that guarantee is removed.

SAG does not block on the response to this method, so the SuspendBlocker may safely take actions that block on raising Execution State’s power level. In particular, it is not affected by https://fxbug.dev/391429689.

Trait Implementations

impl Clone for SuspendBlockerProxy

fn clone(&self) -> SuspendBlockerProxy

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SuspendBlockerProxy

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

Formats the value using the given formatter.

impl Proxy for SuspendBlockerProxy

type Protocol = SuspendBlockerMarker

The protocol which this Proxy controls.

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel.

fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed(&self) -> OnSignals<'_, Unowned<'_, Handle>>

Returns a future that completes when the proxy receives the PEER_CLOSED signal.

impl SuspendBlockerProxyInterface for SuspendBlockerProxy

type BeforeSuspendResponseFut = QueryResponseFut<()>

type AfterResumeResponseFut = QueryResponseFut<()>

fn before_suspend(&self) -> Self::BeforeSuspendResponseFut

fn after_resume(&self) -> Self::AfterResumeResponseFut