Struct ServiceRunner

pub struct ServiceRunner<S>
where
    S: RunnableService + 'static,
{
    pub shared: S::SharedData,
    /* private fields */
}

The service runner manages the lifecycle, execution and error handling of a RunnableService. It can be cloned and passed between threads.

Fields

shared: S::SharedData

The shared state of the service

Implementations

impl<S> ServiceRunner<S>

where S: RunnableService + 'static, S::TaskParams: Default,

pub fn new(service: S) -> Self

Initializes a new ServiceRunner containing a RunnableService

impl<S> ServiceRunner<S>

where S: RunnableService + 'static,

pub fn new_with_params(service: S, params: S::TaskParams) -> Self

Initializes a new ServiceRunner containing a RunnableService with parameters for underlying Task

Trait Implementations

impl<S> Debug for ServiceRunner<S>

where S: RunnableService + 'static + Debug, S::SharedData: Debug,

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

Formats the value using the given formatter.

impl<S> Drop for ServiceRunner<S>

where S: RunnableService + 'static,

fn drop(&mut self)

Executes the destructor for this type.

impl<S> Service for ServiceRunner<S>

where S: RunnableService + 'static,

fn start(&self) -> Result<()>

Send a start signal to the service without waiting for it to start. Returns an error if the service was already started.

fn start_and_await<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<State>> + Send + 'async_trait>>

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

Send a start signal to the service and wait for it to start up. Returns an error if the service was already started.

fn await_start_or_stop<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<State>> + Send + 'async_trait>>

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

Wait for service to start or stop (without sending any signal).

fn stop(&self) -> bool

Send a stop signal to the service without waiting for it to shutdown. Returns false if the service was already stopped, true if it is running.

fn stop_and_await<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<State>> + Send + 'async_trait>>

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

Send stop signal to service and wait for it to shutdown.

fn await_stop<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<State>> + Send + 'async_trait>>

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

Wait for service to stop (without sending a stop signal).

fn state(&self) -> State

The current state of the service (i.e. Started, Stopped, etc..)

fn state_watcher(&self) -> StateWatcher

Returns the state watcher of the service.