Skip to main content

DataFlowComponentAction

Trait DataFlowComponentAction 

Source
pub trait DataFlowComponentAction: ComponentAction {
    // Provided methods
    fn on_execute(&mut self, _exec_handle: u32) -> ReturnCode { ... }
    fn on_state_update(&mut self, _exec_handle: u32) -> ReturnCode { ... }
    fn on_rate_changed(&mut self, _exec_handle: u32) -> ReturnCode { ... }
}
Expand description

Spec §5.3.1 — DataFlowComponentAction. Extends ComponentAction with periodic-sampled-data-processing callbacks.

Per tick (at the frequency ExecutionContext::get_rate), on_execute (read-only phase) followed by on_state_update (state-mutation phase) is invoked.

Provided Methods§

Source

fn on_execute(&mut self, _exec_handle: u32) -> ReturnCode

Spec §5.3.1.x — read-only phase of a periodic tick.

Source

fn on_state_update(&mut self, _exec_handle: u32) -> ReturnCode

Spec §5.3.1.x — state-mutation phase of a periodic tick.

Source

fn on_rate_changed(&mut self, _exec_handle: u32) -> ReturnCode

Spec §5.3.1.x — on_rate_changed when ExecutionContext:: set_rate is invoked.

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§