Struct holochain::core::queue_consumer::TriggerSender

pub struct TriggerSender { /* private fields */ }

The means of nudging a queue consumer to tell it to look for more work

Implementations

impl TriggerSender

pub fn new() -> (TriggerSender, TriggerReceiver)

Create a new channel for waking a consumer

pub fn new_with_loop(
    range: Range<Duration>,
    reset_on_trigger: bool
) -> (TriggerSender, TriggerReceiver)

Create a new channel trigger that will also trigger on a loop. The duration takes a range so that the loop can be set to back off from the lowest to the highest duration. If you do not want a back off, set the duration range to the same value like: Duration::from_millis(10)..Duration::from_millis(10) If reset_on_trigger is true, the back off will be reset whenever a trigger is received.

pub fn trigger(&self, context: &'static &'static str)

Lazily nudge the consumer task, ignoring the case where the consumer already has a pending trigger signal

pub fn reset_back_off(&self)

Reset the back off to the lowest duration. If no back off is set this is a no-op.

pub fn pause_loop(&self)

Pause the trigger loop if there is one.

pub fn resume_loop_now(&self)

Resume the trigger loop now if there is one.

This will resume the loop even if it is currently listening (the workflow is not running). The downside to this call is that if the workflow is running it will immediately run a second time.

This call is a no-op if the loop is not paused.

pub fn resume_loop(&self)

Resume the trigger loop if there is one.

This will cause the loop to to resume after the next trigger (or if the workflow is currently in progress). It will not cause the loop to resume immediately. If the loop is currently listening (the workflow is not running) then nothing will happen until the next trigger. See resume_loop_now for a version that will resume immediately.

This call is a no-op if the loop is not paused.

Trait Implementations

impl Clone for TriggerSender

fn clone(&self) -> TriggerSender

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.