Struct vector::topology::RunningTopology

pub struct RunningTopology { /* private fields */ }

Implementations

impl RunningTopology

pub fn new(config: Config, abort_tx: UnboundedSender<ShutdownError>) -> Self

pub const fn config(&self) -> &Config

Gets the configuration that represents this running topology.

pub fn watch(&self) -> Receiver<TapResource>

Creates a subscription to topology changes.

This is used by the tap API to observe configuration changes, and re-wire tap sinks.

pub fn sources_finished(&self) -> BoxFuture<'static, ()>

Signal that all sources in this topology are ended.

The future returned by this function will finish once all the sources in this topology have finished. This allows the caller to wait for or detect that the sources in the topology are no longer producing. Application, as an example, uses this as a shutdown signal.

pub fn stop(self) -> impl Future<Output = ()>

Shut down all topology components.

This function sends the shutdown signal to all sources in this topology and returns a future that resolves once all components (sources, transforms, and sinks) have finished shutting down. Transforms and sinks will shut down automatically once their input tasks finish.

This function takes ownership of self, so once it returns everything in the RunningTopology instance has been dropped except for the tasks map. This map gets moved into the returned future and is used to poll for when the tasks have completed. Once the returned future is dropped then everything from this RunningTopology instance is fully dropped.

pub async fn reload_config_and_respawn( &mut self, new_config: Config, extra_context: ExtraContext, ) -> Result<bool, ()>

Attempts to load a new configuration and update this running topology.

If the new configuration was valid, and all changes were able to be made – removing of old components, changing of existing components, adding of new components – then Ok(true) is returned.

If the new configuration is not valid, or not all of the changes in the new configuration were able to be made, then this method will attempt to undo the changes made and bring the topology back to its previous state. If either of these scenarios occur, then Ok(false) is returned.

Errors

If all changes from the new configuration cannot be made, and the current configuration cannot be fully restored, then Err(()) is returned.

pub async fn start_init_validated( config: Config, extra_context: ExtraContext, ) -> Option<(Self, ShutdownErrorReceiver)>

pub async fn start_validated( config: Config, diff: ConfigDiff, pieces: TopologyPieces, ) -> Option<(Self, ShutdownErrorReceiver)>