Struct overlord::overlord::Overlord

pub struct Overlord<T: Codec, S: Codec, F: Consensus<T, S>, C: Crypto> { /* fields omitted */ }

An overlord consensus instance.

Methods

impl<T, S, F, C> Overlord<T, S, F, C> where
    T: Codec + Send + Sync + 'static,
    S: Codec + Send + Sync + 'static,
    F: Consensus<T, S> + 'static,
    C: Crypto + Send + Sync + 'static, 

pub fn new(address: Address, consensus: Arc<F>, crypto: C) -> Self

Create a new overlord and return an overlord instance with an unbounded receiver.

pub fn get_handler(&self) -> OverlordHandler<T>

Get the overlord handler from the overlord instance.

pub async fn run<'_>(
    &'_ self,
    interval: u64,
    timer_config: Option<DurationConfig>
) -> ConsensusResult<()>

Run overlord consensus process. The interval is the epoch interval as millisecond.