Crate zenoh_flow

Source
Expand description

Zenoh Flow provides a zenoh-based data flow programming framework for computations that span from the cloud to the device.

Zenoh Flow allows users to declare a data flow graph, via a YAML file, and uses tags to express location affinity and requirements for the operators that makeup the graph. When deploying the data flow graph, Zenoh Flow automatically deals with distribution by linking remote operators through zenoh.

A data flow is composed of set of nodes: sources — producing data, operators — computing over the data, and sinks — consuming the resulting data. These nodes are dynamically loaded at runtime.

Remote source, operators, and sinks leverage zenoh to communicate in a transparent manner. In other terms, the data flow the data flow graph retails location transparency and could be deployed in different ways depending on specific needs.

Zenoh Flow provides several working examples that illustrate how to define operators, sources and sinks as well as how to declaratively define they data flow graph by means of a YAML file.

Re-exports§

pub use zfresult::DaemonResult;
pub use zfresult::ZFResult as Result;
pub use ::zenoh_flow_derive;

Modules§

io
model
prelude
runtime
traits
types
utils
zfresult

Macros§

FLOW_SELECTOR_BY_FLOW
Generates the flow selector by flow, for all runtimes.
FLOW_SELECTOR_BY_INSTANCE
Generates the flow selector by instance, for all runtimes.
JQ_DONE_JOB
Generates the done job key expression
JQ_FAILED_JOB
Generates the done job key expression
JQ_STARTED_JOB
Generates the started job key expression
JQ_SUMBITTED_JOB
Generates the sumbitted job key expression
JQ_SUMBITTED_SEL
Generates the sumbitted jobs key expression (selector)
REG_GRAPH_SELECTOR
Generates the graph key expression.
RT_CONFIGURATION_PATH
Generates the runtime configuration key expression.
RT_FLOW_PATH
Generates the flow instance key expression.
RT_FLOW_SELECTOR_ALL
Generate the selector for all flows.
RT_FLOW_SELECTOR_BY_FLOW
Generates the flow selector by flow id.
RT_FLOW_SELECTOR_BY_INSTANCE
Generates the flow selector by instance id.
RT_INFO_PATH
Generates the runtime info key expression.
RT_STATUS_PATH
Generates the runtime status key expression.
anyhow
Construct an ad-hoc error from a string or existing non-anyhow error value.
bail
zferror

Constants§

FULL_VERSION
Complete string with the Zenoh Flow version, including commit id.
GIT_VERSION
Commit id of latest commit on Zenoh Flow
VERSION
Version of Zenoh Flow Cargo Package This is used to verify compatibility in nodes dynamic loading.

Statics§

DEFAULT_SHM_ALLOCATION_BACKOFF_NS
Default Shared allocation backoff time (100ms)
DEFAULT_SHM_ELEMENT_SIZE
Default Shared Memory size (10MiB).
DEFAULT_SHM_TOTAL_ELEMENTS
Default Shared Memory elements (10).
DEFAULT_USE_SHM
Default Shared memory usage (false)