Struct WakeGroupProxy

pub struct WakeGroupProxy { /* private fields */ }

Implementations

impl WakeGroupProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.net.power/WakeGroup.

pub fn take_event_stream(&self) -> WakeGroupEventStream

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

Panics

Panics if the event stream was already taken.

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

Registers the client to be woken up (in the form of a response) when there is incoming data available for any of the resources registered with this wake group.

Note that the client is required to “arm” this hanging get by calling Arm in order to ensure a response. Once the WaitForData call has returned, the next call to the method will hang until Arm has been called again and new data has arrived. In other words, Arm re-arms the hanging get and should be called when a response is required in order to be woken up.

If the caller is responsible for keeping the system awake while handling the incoming data, the netstack will delegate (baton-pass) a lease to the caller that it can retain until it is ready to allow the system to suspend.

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

Notifies the netstack that the client has handled any previous WaitForData response that has arrived on the channel, and expects to be woken up again when data arrives, in the form of a response to the pending WaitForData call.

In other words, calling this method “re-arms” the hanging get.

Trait Implementations

impl Clone for WakeGroupProxy

fn clone(&self) -> WakeGroupProxy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WakeGroupProxy

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

Formats the value using the given formatter.

impl Proxy for WakeGroupProxy

type Protocol = WakeGroupMarker

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 WakeGroupProxyInterface for WakeGroupProxy

type WaitForDataResponseFut = QueryResponseFut<WakeGroupWaitForDataResponse>

type ArmResponseFut = QueryResponseFut<()>

fn wait_for_data(&self) -> Self::WaitForDataResponseFut

fn arm(&self) -> Self::ArmResponseFut