Struct ServiceContext 

pub struct ServiceContext { /* private fields */ }

Shared runtime context provided to all managed services.

Implementations

impl ServiceContext

pub fn new(name: impl Into<String>, protocol: Option<Protocol>) -> Self

Creates a new service context.

pub fn name(&self) -> &str

Returns the service name.

pub fn protocol(&self) -> Option<Protocol>

Returns the service protocol, if one exists.

pub fn started_at(&self) -> DateTime<Utc>

Returns when the context was created.

pub fn cancellation_token(&self) -> CancellationToken

Returns the shared cancellation token.

pub fn child_token(&self) -> CancellationToken

Returns a child token for scoped tasks.

pub fn cancel(&self)

Cancels the context and all child scopes.

pub fn is_cancelled(&self) -> bool

Returns whether cancellation has been requested.

pub fn subscribe(&self) -> Receiver<ServiceEvent>

Subscribes to service events.

pub fn emit( &self, event: ServiceEvent, ) -> Result<usize, SendError<ServiceEvent>>

Emits a service event.

pub fn track_task(&self, label: impl Into<String>, handle: &JoinHandle<()>)

Tracks an externally-spawned task under the context.

pub fn spawn_task<F>( &self, label: impl Into<String>, future: F, ) -> JoinHandle<()>

where F: Future<Output = ()> + Send + 'static,

Spawns and tracks a unit-returning background task.

pub fn tracked_tasks(&self) -> Vec<String>

Returns the tracked task labels.

pub fn abort_tracked_tasks(&self)

Aborts all tracked tasks.

Trait Implementations

impl Clone for ServiceContext

fn clone(&self) -> ServiceContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServiceContext

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

Formats the value using the given formatter.