Struct bastion::dispatcher::Dispatcher

pub struct Dispatcher { /* fields omitted */ }

A generic implementation of the Bastion dispatcher

The main idea of the dispatcher is to provide an alternative way to communicate between a group of actors. For example, dispatcher can be used when a developer wants to send a specific message or share a local state between the specific group of registered actors with the usage of a custom dispatcher.

Implementations

impl Dispatcher

pub fn dispatcher_type(&self) -> DispatcherType

Returns the type of the dispatcher.

pub fn handler(&self) -> &(dyn DispatcherHandler + Send + Sync + 'static)

Returns the used handler by the dispatcher.

pub fn with_dispatcher_type(self, dispatcher_type: DispatcherType) -> Self

Sets the dispatcher type.

pub fn with_type(dispatcher_type: DispatcherType) -> Self

Creates a dispatcher with a specific dispatcher type.

pub fn with_handler(
    self,
    handler: Box<dyn DispatcherHandler + Send + Sync + 'static>
) -> Self

Sets the handler for the dispatcher.

pub fn notify(&self, from_child: &ChildRef, notification_type: NotificationType)

Forwards the message to the handler for processing.

pub fn broadcast_message(&self, message: &Arc<SignedMessage>)

Sends the message to the group of actors. The logic of who and how should receive the message relies onto the handler implementation.

Trait Implementations

impl Debug for Dispatcher

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

Formats the value using the given formatter.

impl Default for Dispatcher

fn default() -> Self

Returns the "default value" for a type.