Trait fuel_core_services::Service

pub trait Service {
    // Required methods
    fn start(&self) -> Result<()>;
    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;
    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;
    fn stop(&self) -> bool;
    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;
    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;
    fn state(&self) -> State;
    fn state_watcher(&self) -> StateWatcher;
}

Trait for service runners, providing a minimal interface for managing the lifecycle of services such as start/stop and health status.

Required Methods

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.

Implementors

impl<S> Service for ServiceRunner<S>

where S: RunnableService + 'static,