Struct ntex::task::LocalWaker [−][src]
pub struct LocalWaker { /* fields omitted */ }
Expand description
A synchronization primitive for task wakeup.
Sometimes the task interested in a given event will change over time.
An LocalWaker
can coordinate concurrent notifications with the consumer
potentially “updating” the underlying task to wake up. This is useful in
scenarios where a computation completes in another task and wants to
notify the consumer, but the consumer is in the process of being migrated to
a new logical task.
Consumers should call register
before checking the result of a computation
and producers should call wake
after producing the computation (this
differs from the usual thread::park
pattern). It is also permitted for
wake
to be called before register
. This results in a no-op.
A single LocalWaker
may be reused for any number of calls to register
or
wake
.
Implementations
Create an LocalWaker
.
Registers the waker to be notified on calls to wake
.
Returns true
if waker was registered before.
Calls wake
on the last Waker
passed to register
.
If register
has not been called yet, then this does nothing.
Trait Implementations
Returns the “default value” for a type. Read more
Auto Trait Implementations
impl !RefUnwindSafe for LocalWaker
impl !Send for LocalWaker
impl !Sync for LocalWaker
impl Unpin for LocalWaker
impl UnwindSafe for LocalWaker
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more