Struct stakker::sync::PipedLink

pub struct PipedLink<O: Send + Sync + 'static, I: Send + Sync + 'static> { /* private fields */ }

Link from a PipedThread thread back to the main thread

Implementations

impl<O: Send + Sync + 'static, I: Send + Sync + 'static> PipedLink<O, I>

pub fn send(&mut self, msg: I) -> bool

Send a message back to the main thread. Returns true on success. If false is returned, then the PipedThread has been dropped and this thread should terminate itself.

pub fn recv(&mut self) -> Option<O>

Receive a message from the main thread. Blocks if there is no message already waiting. Returns None if the PipedThread has been dropped, in which case this thread should terminate itself.

pub fn cancel(&mut self) -> bool

Check whether cancellation has been flagged by the main thread. When the PipedThread is dropped, the cancel flag is set to tell this thread to terminate. If the thread is doing a long-running operation or blocking, it should check the cancel flag from time to time to recognise this condition and to clean up in good time.