Struct sorceress::scheduler::Scheduler

pub struct Scheduler(_);

An ahead-of-time scheduler for executing recurring tasks.

Implementations

impl Scheduler

pub fn new() -> Scheduler

Create a new scheduler

pub fn ahead_by(self, ahead_by: Duration) -> Self

Schedule the job in advance.

OSC messages sent to the SuperCollider server can have timestamps attached to them which lets SuperCollider execute the messages at a precise time. In this scenario the messages must be sent to the server before they need to be executed.

This function pushes the logical_time parameter passed to JobDef::init and Job::run into the future so that the OSC messages have time to be sent to the server and processed before they need to be scheduled.

Defaults to 100 milliseconds.

pub fn handle(&self) -> Handle

Returns a Handle which can be used to stop a Scheduler from another thread.

The Scheduler::run method will return immediately after Handle::cancel is called on the handle returned by this method.

pub fn run(self, job_def: impl JobDef) -> Result<()>

Creates the job and runs it until it returns None.

This function will block until the job has finished running. See Scheduler::handle for a way to interrupt this method from a different thread.

Trait Implementations

impl Debug for Scheduler

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Scheduler

fn default() -> Scheduler

Returns the “default value” for a type.