Struct aleph_bft::Terminator

pub struct Terminator { /* private fields */ }

Struct that holds connections to offspring and parent components/tasks and enables a clean/synchronized shutdown

Implementations

impl Terminator

pub fn create_root(exit: Receiver<()>, name: &'static str) -> Self

Creates a terminator for the root component

pub async fn get_exit(&mut self) -> Result<(), ()>

When ready, returns reason why we should exit. Ok should be interpreted as “all good, our parent decided to gracefully exit”. Err is returned when our parent autonomously decided to exit, without first receiving such request from its parent.

pub fn add_offspring_connection(&mut self, name: &'static str) -> Terminator

Add a connection to an offspring component/task

pub async fn terminate_sync(self)

Perform a synchronized shutdown

Trait Implementations

impl Debug for Terminator

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

Formats the value using the given formatter.