DataFlowInstance

zenoh_flow::runtime::dataflow::instance

Struct DataFlowInstance 

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

A DataFlowInstance is an instance of a data flow that is ready to be run.

All Zenoh-Flow daemons involved in the deployment of an instance of a data flow will create this structure to manage the nodes they are responsible for. Each daemon will keep in that structure only their view of the instance.

Implementations§

Source§

impl DataFlowInstance

Source

pub fn get_sinks(&self) -> Vec<NodeId> ⓘ

Retrieve the NodeId of the Sinks of this data flow instance running on the current daemon.

CAVEAT: It is possible (and likely) that not all Sinks run on a single daemon. Hence, this list will be a subset of the list of all Sinks of this data flow.

Source

pub fn get_sources(&self) -> Vec<NodeId> ⓘ

Retrieve the NodeId of the Sources of this data flow instance running on the current daemon.

CAVEAT: It is possible (and likely) that not all Sources run on a single daemon. Hence, this list will be a subset of the list of all Sources of this data flow.

Source

pub fn get_operators(&self) -> Vec<NodeId> ⓘ

Retrieve the NodeId of the Operators of this data flow instance running on the current daemon.

CAVEAT: It is possible (and likely) that not all Operators run on a single daemon. Hence, this list will be a subset of the list of all Operators of this data flow.

Source

pub fn get_connectors(&self) -> Vec<NodeId> ⓘ

Retrieve the NodeId of the ZFConnectors of this data flow instance running on the current daemon.

CAVEAT: It is possible (and likely) that not all ZFConnectors run on a single daemon. Hence, this list will be a subset of the list of all ZFConnectors of this data flow.

Source

pub fn start_node(&mut self, node_id: &NodeId) -> Result<()>

Start the node whose id matches the one provided.

Start means launching as many tasks as necessary to run continuously the Node, input and/or output callbacks.

Start is idempotent, if the node is already running, nothing will happen.

§Error

This method can return an error if the provided node_id is not found.

Source

pub async fn stop_node(&mut self, node_id: &NodeId) -> Result<()>

Stop the node whose id matches the one provided.

Stop means canceling all the tasks that were launched. Note that stop does not interrupt a currently running task. The task will effectively be stopped the next time it encounters an await.

Stop is idempotent, if the node is not running, nothing will happen.

§Error

This method can return an error if the provided node_id is not found.

Source

pub async fn try_instantiate(data_flow: DataFlow, hlc: Arc<HLC>) -> Result<Self>

Given a DataFlow and an HLC, try to instantiate the data flow by generating all the nodes (via their factories) and all the connections — running on the daemon.

§Error

This function can return an error if:

  • some links are missing which resulted in some missing connections,
  • a factory failed to generate a node.

Trait Implementations§

Source§

impl Deref for DataFlowInstance

Source§

type Target = DataFlow

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.

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> AsNode<T> for T

Source§

fn as_node(&self) -> &T

Source§

impl<T> AsNodeMut<T> for T

Source§

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

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SendSyncAny for T
where T: 'static + Send + Sync,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Source§

fn as_mut_any(&mut self) -> &mut (dyn Any + 'static)

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,