Struct ServiceWorkerManager

#[non_exhaustive]
pub struct ServiceWorkerManager { /* private fields */ }

ServiceWorkerManager allows plugin services to create long-live jobs and manage their life cycle.

Implementations

impl ServiceWorkerManager

pub fn register_job<F>(&self, job: F) -> Result<()>

where F: FnOnce(CancellationToken) + 'static,

Add a new job to the execution. Job work life cycle will be tied to the service life cycle; this means that job will be canceled just before service is stopped.

Arguments

• job: callback that will be executed in separated fiber. Note that it is your responsibility to organize job graceful shutdown, see a CancellationToken for details.

Examples

use std::time::Duration;
use picodata_plugin::background::CancellationToken;


// this job will print "hello" every second,
// and print "bye" after being canceled
fn hello_printer(cancel: CancellationToken) {
    while cancel.wait_timeout(Duration::from_secs(1)).is_err() {
        println!("hello!");
    }
    println!("job cancelled, bye!")
}
worker_manager.register_job(hello_printer).unwrap();

pub fn register_tagged_job<F>(&self, job: F, tag: &str) -> Result<()>

where F: FnOnce(CancellationToken) + 'static,

Same as ServiceWorkerManager::register_job but caller may provide a special tag. This tag may be used for manual job cancellation using ServiceWorkerManager::cancel_tagged.

Arguments

• job: callback that will be executed in separated fiber
• tag: tag, that will be related to a job, single tag may be related to the multiple jobs

pub fn cancel_tagged(&self, tag: &str, timeout: Duration) -> Result<(), Error>

Cancel all jobs related to the given tag. This function return after all related jobs will be gracefully shutdown or after timeout duration. May return Error::PartialCompleted if timeout is reached.

Arguments

• tag: determine what jobs should be cancelled
• timeout: shutdown timeout

pub fn set_shutdown_timeout(&self, timeout: Duration)

👎Deprecated: use PicoContext::set_jobs_shutdown_timeout instead

In case when jobs were canceled by picodata use this function for determine a shutdown timeout - time duration that picodata uses to ensure that all jobs gracefully end.

By default, 5-second timeout are used.

Trait Implementations

impl Clone for ServiceWorkerManager

fn clone(&self) -> ServiceWorkerManager

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServiceWorkerManager

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

Formats the value using the given formatter.