Struct SourceSynchronousProxy 

pub struct SourceSynchronousProxy { /* private fields */ }

Implementations

impl SourceSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

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

Returns static hardware characteristics that do not change during operation.

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

Returns dynamic status of the source immediately.

pub fn set_role( &self, role: &Role, ___deadline: MonotonicInstant, ) -> Result<SourceSetRoleResult, Error>

Set the role of this specific node.

Errors:

• INVALID_ARGS: If the provided role is invalid.
• NOT_SUPPORTED: If the requested role is not supported by the hardware.
• INTERNAL: If an unexpected error occurred.

pub fn watch( &self, interest: &Status, wake_on: &Status, lease: Option<EventPair>, ___deadline: MonotonicInstant, ) -> Result<(Status, Option<EventPair>), Error>

Change notification for power source state using a “hanging-get” pattern.

The first call to this method returns the current hardware state immediately. Subsequent calls block until a change occurs that matches the provided masks.

At most one Watch call may be outstanding at a time per connection. Completing a call acknowledges that the client has received the previous update.

Power Management and Suspend

To prevent lost wakeups, the server (driver) must ensure that the Watch call remains active (and hardware interrupts armed) while the system is suspended.

• Interest Triggers: If a change in the interest mask occurs while the system is suspended, the server MUST NOT complete the Watch call until the system wakes for another reason (e.g., a wake_on event or external trigger). This ensures the CPU remains asleep for non-critical updates.
• Wake-On Triggers: If a change in the wake_on mask occurs, the server MUST wake the system and complete the call immediately with a wake_lease.

As a result of this queuing behavior, if multiple changes occur while the system is suspended, they may be merged into a single returned status table, and intermediate state transitions may be lost.

• interest: The client wants to be notified if any of the fields present in this table change. If any field in interest changes, the method returns.
• wake_on: Similar to interest, but if a change occurs in these fields, the server will attempt to keep the system awake using the provided lease (or by returning a wake_lease) until the client acknowledges the update.
• lease: A power lease token used to coordinate handoff between the server and client, ensuring the system does not suspend before the client can process a critical power event.

Returns:

• status: The updated status table containing the fields that changed.
• wake_lease: An optional lease token provided if the change triggered a wake_on condition and the server is maintaining system state.

Trait Implementations

impl Debug for SourceSynchronousProxy

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

Formats the value using the given formatter.

impl From<Channel> for SourceSynchronousProxy

Available on Fuchsia only.

fn from(value: Channel) -> Self

Converts to this type from the input type.

impl From<SourceSynchronousProxy> for NullableHandle

Available on Fuchsia only.

fn from(value: SourceSynchronousProxy) -> Self

Converts to this type from the input type.

impl FromClient for SourceSynchronousProxy

Available on Fuchsia only.

type Protocol = SourceMarker

The protocol.

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

Converts from a client.

impl SynchronousProxy for SourceSynchronousProxy

Available on Fuchsia only.

type Proxy = SourceProxy

The async proxy for the same protocol.

type Protocol = SourceMarker

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.