Struct DispatcherFrame 

pub struct DispatcherFrame { /* private fields */ }

Represents an execution loop in the Dispatcher.

Frames are shared handles: set_continue can be called from any thread.

Implementations

impl DispatcherFrame

pub fn new() -> Arc<DispatcherFrame>

Constructs a new instance of the frame for the current dispatcher. The frame exits when all frames are requested to exit.

pub fn with_exit_when_requested( exit_when_requested: bool, ) -> Arc<DispatcherFrame>

Constructs a new instance of the frame for the current dispatcher.

exit_when_requested indicates whether or not this frame will exit when all frames are requested to exit. Dispatcher frames typically break down into two categories:

1. Long running, general purpose frames, that exit only when told to. These frames should exit when requested.
2. Short running, very specific frames that exit themselves when an important criteria is met. These frames may consider not exiting when requested in favor of waiting for their important criteria to be met. These frames should have a timeout associated with them.

pub fn dispatcher(&self) -> &Arc<Dispatcher>

The dispatcher this frame runs on.

pub fn continue_(&self) -> bool

Indicates that this dispatcher frame should continue.

pub fn set_continue(&self, value: bool)

Sets whether this dispatcher frame should continue. Setting it to false exits the loop the frame is running.