Trait casper_node::reactor::Reactor

pub trait Reactor: Sized {
    type Event: Send + Debug + Display + 'static;
    type Config;
    type Error: Send + Sync + 'static;
    fn dispatch_event(
        &mut self, 
        effect_builder: EffectBuilder<Self::Event>, 
        rng: &mut dyn CryptoRngCore, 
        event: Self::Event
    ) -> Effects<Self::Event>;
    fn new(
        cfg: Self::Config, 
        registry: &Registry, 
        event_queue: EventQueueHandle<Self::Event>, 
        rng: &mut dyn CryptoRngCore
    ) -> Result<(Self, Effects<Self::Event>), Self::Error>;

    fn is_stopped(&mut self) -> bool { ... }
    fn update_metrics(
        &mut self, 
        _event_queue_handle: EventQueueHandle<Self::Event>
    ) { ... }
}

Reactor core.

Any reactor should implement this trait and be executed by the reactor::run function.

Associated Types

type Event: Send + Debug + Display + 'static

Event type associated with reactor.

Defines what kind of event the reactor processes.

type Config

A configuration for the reactor

type Error: Send + Sync + 'static

The error type returned by the reactor.

Loading content...

Required methods

fn dispatch_event(
    &mut self,
    effect_builder: EffectBuilder<Self::Event>,
    rng: &mut dyn CryptoRngCore,
    event: Self::Event
) -> Effects<Self::Event>

Dispatches an event on the reactor.

This function is typically only called by the reactor itself to dispatch an event. It is safe to call regardless, but will cause the event to skip the queue and things like accounting.

fn new(
    cfg: Self::Config,
    registry: &Registry,
    event_queue: EventQueueHandle<Self::Event>,
    rng: &mut dyn CryptoRngCore
) -> Result<(Self, Effects<Self::Event>), Self::Error>

Creates a new instance of the reactor.

This method creates the full state, which consists of all components, and returns a reactor instance along with the effects that the components generated upon instantiation.

If any instantiation fails, an error is returned.

Loading content...

Provided methods

fn is_stopped(&mut self) -> bool

Indicates that the reactor has completed all its work and should no longer dispatch events.

fn update_metrics(&mut self, _event_queue_handle: EventQueueHandle<Self::Event>)

Instructs the reactor to update performance metrics, if any.

Loading content...

Implementors

impl Reactor for Initializer

type Event = InitializerEvent

type Error = InitializerError

type Config = WithDir<Config>

fn dispatch_event(
    &mut self,
    effect_builder: EffectBuilder<Self::Event>,
    rng: &mut dyn CryptoRngCore,
    event: Self::Event
) -> Effects<Self::Event>

fn new(
    cfg: Self::Config,
    registry: &Registry,
    event_queue: EventQueueHandle<Self::Event>,
    rng: &mut dyn CryptoRngCore
) -> Result<(Self, Effects<Self::Event>), Self::Error>

impl Reactor for casper_node::reactor::initializer::Reactor

type Event = Event

type Config = WithDir<Config>

type Error = Error

fn new(
    config: Self::Config,
    registry: &Registry,
    event_queue: EventQueueHandle<Self::Event>,
    _rng: &mut dyn CryptoRngCore
) -> Result<(Self, Effects<Self::Event>), Error>

fn dispatch_event(
    &mut self,
    effect_builder: EffectBuilder<Self::Event>,
    rng: &mut dyn CryptoRngCore,
    event: Event
) -> Effects<Self::Event>

fn is_stopped(&mut self) -> bool

impl Reactor for casper_node::reactor::joiner::Reactor

type Event = Event

type Config = WithDir<Reactor>

type Error = Error

fn new(
    initializer: Self::Config,
    registry: &Registry,
    event_queue: EventQueueHandle<Self::Event>,
    rng: &mut dyn CryptoRngCore
) -> Result<(Self, Effects<Self::Event>), Self::Error>

fn dispatch_event(
    &mut self,
    effect_builder: EffectBuilder<Self::Event>,
    rng: &mut dyn CryptoRngCore,
    event: Self::Event
) -> Effects<Self::Event>

fn is_stopped(&mut self) -> bool

fn update_metrics(&mut self, event_queue_handle: EventQueueHandle<Self::Event>)

impl Reactor for casper_node::reactor::validator::Reactor

type Event = Event

type Config = ValidatorInitConfig

type Error = Error

fn new(
    config: Self::Config,
    registry: &Registry,
    event_queue: EventQueueHandle<Self::Event>,
    _rng: &mut dyn CryptoRngCore
) -> Result<(Self, Effects<Event>), Error>

fn dispatch_event(
    &mut self,
    effect_builder: EffectBuilder<Self::Event>,
    rng: &mut dyn CryptoRngCore,
    event: Event
) -> Effects<Self::Event>

fn update_metrics(&mut self, event_queue_handle: EventQueueHandle<Self::Event>)

Loading content...