Struct LocalDispatcher 

pub struct LocalDispatcher { /* private fields */ }

The default non-networked dispatcher

Logs network messages at the info level and local messages at the warn level, then discards either.

Implementations

impl LocalDispatcher

pub fn new(notify_ready: KPromise<()>) -> LocalDispatcher

Creates a new local dispatcher

The notify_ready promise will be fulfilled, when the component received a Start event.

Trait Implementations

impl Actor for LocalDispatcher

type Message = DispatchEnvelope

The type of local messages the actor accepts

fn receive_local( &mut self, msg: <LocalDispatcher as Actor>::Message, ) -> Result<Handled, HandlerError>

Handle an incoming local message

fn receive_network(&mut self, msg: NetMessage) -> Result<Handled, HandlerError>

Handle an incoming network message

impl ComponentDefinition for LocalDispatcher

fn setup(&mut self, self_component: Arc<Component<LocalDispatcher>>)

Prepare the component for being run

fn execute(&mut self, _max_events: usize, _skip: usize) -> ExecuteResult

Execute events on the component’s ports

fn ctx_mut(&mut self) -> &mut ComponentContext<LocalDispatcher>

Return a mutable reference the component’s context field

fn ctx(&self) -> &ComponentContext<LocalDispatcher>

Return a reference the component’s context field

fn type_name() -> &'static str

Return the name of the component’s type

fn spawn_local<F>( &mut self, f: impl FnOnce(ComponentDefinitionAccess<Self>) -> F, )

where Self: 'static, F: Future<Output = Result<Handled, HandlerError>> + Send + 'static,

Run a Future on this component, allowing it mutable access to the component’s internal state on every poll.

fn spawn_off<R>( &self, future: impl Future<Output = R> + Send + 'static, ) -> Receiver<R>

where R: Send + 'static,

Run a Future on this system’s executor pool and return a handle to the result

impl ComponentLifecycle for LocalDispatcher

fn on_start(&mut self) -> Result<Handled, HandlerError>

Gets invoked every time a component receives a Start event

fn on_stop(&mut self) -> Result<Handled, HandlerError>

where Self: 'static,

Gets invoked every time a component receives a Stop event

fn on_kill(&mut self) -> Result<Handled, HandlerError>

where Self: 'static,

Gets invoked every time a component receives a Kill event

impl Dispatcher for LocalDispatcher

fn system_path(&mut self) -> SystemPath

Returns the system path for this dispatcher

impl DynamicPortAccess for LocalDispatcher

fn get_provided_port_as_any( &mut self, port_id: TypeId, ) -> Option<&mut (dyn Any + 'static)>

Internal API. Dynamically obtain a mutable reference to a ProvidedPort if self provides a port of the type indicated by the passed port_id.

fn get_required_port_as_any( &mut self, port_id: TypeId, ) -> Option<&mut (dyn Any + 'static)>

Internal API. Dynamically obtain a mutable reference to a RequiredPort if self requires a port of the type indicated by the passed port_id.