Skip to main content

ExecutorNodeRuntime

Struct ExecutorNodeRuntime 

Source
pub struct ExecutorNodeRuntime { /* private fields */ }
Expand description

Executor-backed component runtime.

Owns the Executor and one slot per registered component. The register / spin lifecycle:

  1. from_executor wraps an open Executor.
  2. register_node builds the component’s State, runs [Node::register] over an internal NodeRuntime adapter that materialises nodes / pubs / subs / timers on the real executor, and wires each subscription + timer callback to dispatch into ExecutableNode::on_callback with the right CallbackId.
  3. spin / spin_once drive the executor; between iterations every registered component’s ExecutableNode::tick runs.

Implementations§

Source§

impl ExecutorNodeRuntime

Source

pub fn from_executor(executor: Executor) -> Self

Wrap an already-built Executor.

Source

pub fn executor(&self) -> &Executor

Borrow the underlying executor.

Source

pub fn executor_mut(&mut self) -> &mut Executor

Mutably borrow the underlying executor — for advanced wiring (parameter services, custom guard conditions). Don’t use during spin from another thread; the runtime is single-threaded.

Source

pub fn component_count(&self) -> usize

Number of registered components.

Source

pub fn register_node<C: ExecutableNode + 'static>( &mut self, ) -> NodeResult<RegisteredNode<C>>
where C::State: 'static,

Register a [Node] (which must also be ExecutableNode) into this runtime. Builds the component’s State (via ExecutableNode::init) and walks [Node::register] over the live executor — every declared node / pub / sub / timer materialises as a real executor handle, and subscription + timer callbacks are wired to dispatch into ExecutableNode::on_callback.

Source

pub fn spin_once(&mut self, timeout: Duration) -> Result<(), ExecutorError>

Drive one executor iteration + a tick per registered component.

Source

pub fn dispatch_callback(&mut self, cb_id: &str, ctx: &mut CallbackCtx<'_>)

Phase 216.B.3 / C.3 follow-up — route a signaled callback to every registered component slot.

The RTIC (nros-board-rtic-stm32f4) and Embassy (nros-board-embassy-stm32f4) dispatch tasks dequeue a nros_platform::SignaledCallback envelope from their SPSC queue / Embassy channel and need a routing entry point that hands the callback off to the right Node’s on_callback trampoline. This method is that entry point.

§Strategy — linear scan

Each registered slot’s dispatch_fn is the codegen-emitted d() trampoline from nros::node!() (see packages/core/nros-macros/src/lib.rs). That trampoline calls <NodeTy as ExecutableNode>::on_callback, whose body matches on the callback’s own tag set (Subscription / Timer / Service / Action ids) and is a no-op for non-matching cb_ids. So a linear scan across every slot is correct — each slot self-filters and at most one component actually acts on a given cb_id. A focused cb_id → slot index is a separate follow-up; the trampoline’s tag dispatch already gates the real work cheaply (string compare on statically known literals), so the linear scan is the minimum-viable wiring that closes the conceptual gap left by the B.3 / C.3 skeleton emits.

§Borrow semantics

Each ComponentCell’s slot lives behind a RefCell; the per-slot dispatch takes try_borrow_mut and is a no-op on re-entrancy. The runtime is single-threaded by construction (the dispatch task owns it via &mut self), so the borrow always succeeds in normal flow.

Source

pub fn spin(&mut self) -> Result<(), ExecutorError>

Spin until the executor’s halt flag is raised. Hosted-only; on bare-metal the BSP wraps spin_once in its own loop.

Source

pub fn halt(&self)

Halt a running spin. Idempotent.

Trait Implementations§

Source§

impl NodeDispatchRuntime for ExecutorNodeRuntime

Source§

fn spin_once(&mut self, timeout_ms: u32) -> Result<(), ()>

Drive the underlying executor for at most timeout_ms milliseconds. Ok(()) on a clean spin (including timeout); Err(()) if the executor surfaces a spin error. Read more
Source§

fn executor_handle(&mut self) -> *mut c_void

Phase 258 (Track 2, 2a) — raw *mut Executor (as void*) for the owned-spin entry, so a Node pkg’s register(runtime) wrapper can call the uniform __nros_component_<pkg>_install(.., executor, ..) seam (nros::install_node_typed) instead of the retired opaque-fn-ptr register_dispatch_slot_dyn bridge. A pointer crosses the nros-platformnros layering wall cleanly (the concrete ExecutorNodeRuntime lives in nros; this trait can’t name it). Read more
Source§

fn observed_callback_counts(&self) -> (usize, usize)

Observability counters from hosted/runtime tests. Read more
Source§

fn signal_callback(&mut self, _cb: SignaledCallback<'_>)

Hand a signaled callback to the framework-side dispatcher (Phase 216.A.2). Only meaningful for DispatchStrategy::Deferred (RTIC / Embassy) runtimes — Inline runtimes drive callbacks directly from spin_once and never call this. The default panic surfaces the mis-wire loudly rather than silently dropping the callback signal.
Source§

fn dispatch_strategy(&self) -> DispatchStrategy

Declare how this runtime delivers callbacks (Phase 216.A.2). nros check (Phase 216.D.1) cross-validates each Node pkg’s Node::DISPATCH against this value. Defaults to Inline so every existing impl reports the historical behavior unchanged.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.