Struct organix::service::ServiceState

pub struct ServiceState<T: Service> { /* fields omitted */ }

this is the object that every services has access to

each service has its own ServiceState. It allows to connect to other services [intercom_with] as well as getting access to the service's settings or state

Implementations

impl<T: Service> ServiceState<T>

pub fn identifier(&self) -> ServiceIdentifier

access the service's Identifier

this is just similar to calling <T as Service>::SERVICE_IDENTIFIER

pub fn intercom_with<O: Service>(&self) -> Intercom<O>

open an Intercom handle with the given service O

pub fn watchdog_controller(&self) -> &WatchdogQuery

access the WatchdogQuery allowing raw command access to all watchdog commands.

pub fn intercom_mut(&mut self) -> &mut IntercomReceiver<T::IntercomMsg>

access the service's IntercomReceiver end

this is the end that will receive intercom messages from other services

pub fn status_reader(&self) -> &StatusReader

access the status reader of the service. If the status is updated to be shutdown then the reader will receive the notification event and will be able to prepare for shutdown gracefully

pub fn runtime_handle(&self) -> &Handle

access the service's Runtime handle

This object can be cloned and send between tasks allowing for other tasks to create their own subtasks and so on

pub fn spawn<F>(&self, future: F) -> JoinHandle<F::Output> where
    F: Future + Send + 'static,
    F::Output: Send + 'static, 

spawn the given future in the context of the Service's Runtime.

While there is no way to enforce the users to actually spawn tasks within the Runtime we can at least urge the users to do so and avoid using the global runtime context as it may be used for other purposes.