Struct GenBackgroundService 

pub struct GenBackgroundService<A> {
    pub threads: Option<usize>,
    /* private fields */
}

A generic type of background service

Fields

threads: Option<usize>

The number of threads. Default is 1

Implementations

impl<A> GenBackgroundService<A>

pub fn new(name: String, task: Arc<A>) -> Self

Generates a background service that can run in the pingora runtime

pub fn task(&self) -> Arc<A>

Return the task behind Arc to be shared other logic.

Trait Implementations

impl<A> ServiceWithDependents for GenBackgroundService<A>

where A: BackgroundService + Send + Sync + 'static,

fn start_service<'life0, 'async_trait>( &'life0 mut self, _fds: Option<ListenFds>, shutdown: ShutdownWatch, _listeners_per_fd: usize, ready: ServiceReadyNotifier, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

This function will be called when the server is ready to start the service.

fn name(&self) -> &str

The name of the service, just for logging and naming the threads assigned to this service

fn threads(&self) -> Option<usize>

The preferred number of threads to run this service

fn on_startup_delay(&self, time_waited: Duration)

This is currently called to inform the service about the delay it experienced from between waiting on its dependencies. Default behavior is to log the time.