Struct MultiWaker

pub struct MultiWaker { /* private fields */ }

A utility type ensures that multiple pollers can all be waken up.

With tokio’s design, poll_* functions will only wake up the waker associated with the last poller. This works well with tokio’s types, however due to OT-lib design issues, we might have multiple pollers (e.g. Uart’s API takes &self instead of &mut self). This utility ensures that even if multiple pollers are present, no wake messages will be lost.

Implementations

impl MultiWaker

pub fn new() -> Self

Create a new MultiWaker.

pub fn waker(&self) -> Waker

Obtain a waker that can be used to wake up all registered wakers.

pub fn register(&self) -> MultiWakerRegistration<'_>

Signal the intent to register a waker.

When registration eventually happens, it is treated as if the registration happens at this point in time. This is a cheap operation compared to the actual registration of the waker.

pub fn poll_with<T, F: FnOnce(&mut Context<'_>) -> Poll<T>>( &self, cx: &mut Context<'_>, f: F, ) -> Poll<T>

Call a polling function with the guarantee of not losing Waker.

For the guarantee to be upheld the same MultiWaker instance should be used for every poll call.

Trait Implementations

impl Default for MultiWaker

fn default() -> Self

Returns the “default value” for a type.