Struct SuspendBlockerSynchronousProxy 

pub struct SuspendBlockerSynchronousProxy { /* private fields */ }

Implementations

impl SuspendBlockerSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<SuspendBlockerEvent, 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 before_suspend(&self, ___deadline: MonotonicInstant) -> Result<(), Error>

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.

ExecutionState will be at its SUSPENDING level for the duration of this call. Consequently, a SuspendBlocker MUST NOT call ActivityGovernor.TakeApplicationActivityLease nor perform any other action that blocks on Execution State reaching a level other than INACTIVE. Doing so will result in a deadlock. (However, AcquireWakeLease does not block in this way and is safe to call.)

pub fn after_resume(&self, ___deadline: MonotonicInstant) -> Result<(), Error>

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

For the duration of this call, ExecutionState is at level INACTIVE, but all dependencies of ExecutionStateLevel::SUSPENDING are guaranteed be satisified.

Consequently, a SuspendBlocker MUST NOT call ActivityGovernor.TakeApplicationActivityLease nor perform any other action that blocks on Execution State reaching a level other than INACTIVE. Doing so will result in a deadlock. (However, AcquireWakeLease does not block in this way and is safe to call.)

Trait Implementations

impl Debug for SuspendBlockerSynchronousProxy

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

Formats the value using the given formatter.

impl From<Channel> for SuspendBlockerSynchronousProxy

Available on Fuchsia only.

fn from(value: Channel) -> Self

Converts to this type from the input type.

impl From<SuspendBlockerSynchronousProxy> for NullableHandle

Available on Fuchsia only.

fn from(value: SuspendBlockerSynchronousProxy) -> Self

Converts to this type from the input type.

impl FromClient for SuspendBlockerSynchronousProxy

Available on Fuchsia only.

type Protocol = SuspendBlockerMarker

The protocol.

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

Converts from a client.

impl SynchronousProxy for SuspendBlockerSynchronousProxy

Available on Fuchsia only.

type Proxy = SuspendBlockerProxy

The async proxy for the same protocol.

type Protocol = SuspendBlockerMarker

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.