Struct RelayContext 

pub struct RelayContext { /* private fields */ }

Relay context.

Implementations

impl RelayContext

pub fn new( topology_context: &TopologyContext, component_context: &ComponentContext, component_registry: ComponentRegistry, health_handle: Health, dispatcher: PayloadsDispatcher, spawner: ComponentSpawner, ) -> Self

Creates a new RelayContext.

pub fn take_shutdown_handle(&mut self) -> ShutdownHandle

Consumes the shutdown handle of this relay context.

Panics

Panics if the shutdown handle has already been taken.

pub fn take_health_handle(&mut self) -> Health

Consumes the health handle of this relay context.

Panics

Panics if the health handle has already been taken.

pub fn topology_context(&self) -> &TopologyContext

Returns a reference to the topology context.

pub fn component_context(&self) -> &ComponentContext

Returns a reference to the component context.

pub fn component_registry(&self) -> &ComponentRegistry

Returns a reference to the component registry.

pub fn dispatcher(&self) -> &PayloadsDispatcher

Returns a reference to the payloads dispatcher.

pub fn spawner(&self) -> &ComponentSpawner

Returns a spawner for supervised child tasks belonging to this component.

All child tasks spawned through this mechanism are tied to the lifecycle of the component itself, such that they’re automatically shutdown/stopped when the component is stopped during topology shutdown, etc.

Trait Implementations

impl Clone for RelayContext

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.