Struct RequesterSynchronousProxy

pub struct RequesterSynchronousProxy { /* private fields */ }

Implementations

impl RequesterSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<RequesterEvent, 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 request( &self, mode: SystemMode, set: bool, ___deadline: MonotonicInstant, ) -> Result<RequesterRequestResult, Error>

Requests to set or clear a system power mode.

The call returns immediately after the request has been received, validated, and accepted. Actual system changes to be applied as a result of this request will occur after the call has returned. Therefore, any errors that occur while updating clients according to the new system power mode are not propagated back to the caller. Instead, client updates are applied on a “best effort” basis.

An error returned by this method means the request itself is not valid and was rejected. Details of the specific rejection reason are reflected by the error value. In the event of an error, the channel will remain open.

A client can use this method to set or clear system power mode variants independently. For example:

// battery is below the “low” threshold Request(LOW_BATTERY, true);

// device is now plugged into the wall Request(ON_AC_POWER, true);

// battery is now above the “low” threshold Request(LOW_BATTERY, false);

• mode is the SystemMode to request to be set or cleared
• set should be true to request to set mode, or false to clear it

• error a ModeRequestError value indicating why the request was rejected.

Trait Implementations

impl Debug for RequesterSynchronousProxy

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

Formats the value using the given formatter.

impl SynchronousProxy for RequesterSynchronousProxy

type Proxy = RequesterProxy

The async proxy for the same protocol.

type Protocol = RequesterMarker

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.