Struct WakeGroupSynchronousProxy

pub struct WakeGroupSynchronousProxy { /* private fields */ }

Implementations

impl WakeGroupSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

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

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, ___deadline: MonotonicInstant) -> Result<(), Error>

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 Debug for WakeGroupSynchronousProxy

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

Formats the value using the given formatter.

impl From<Channel> for WakeGroupSynchronousProxy

fn from(value: Channel) -> Self

Converts to this type from the input type.

impl From<WakeGroupSynchronousProxy> for Handle

fn from(value: WakeGroupSynchronousProxy) -> Self

Converts to this type from the input type.

impl FromClient for WakeGroupSynchronousProxy

type Protocol = WakeGroupMarker

The protocol.

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

Converts from a client.

impl SynchronousProxy for WakeGroupSynchronousProxy

type Proxy = WakeGroupProxy

The async proxy for the same protocol.

type Protocol = WakeGroupMarker

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.