Link to this section Summary

Sorts components (keys) of component network topologicaly, but according to backward edges, because edge means subscription relation (not comes after but comes before). So instead of indegree implementation use outdegee. Its wrath of kahn's algorithm.

Link to this section Types

component()

@type component() :: {component_type(), term()}

Full representation of particular component.

component_type()

@type component_type() ::
  :input_topic
  | :load_topic
  | :tick_timezip
  | :template
  | :output_sink
  | :timezip

Part of component identifier.

subscription()

@type subscription() :: {component(), subscription_properties()}

Subscription edge defined with destination and props.

subscription_properties()

@type subscription_properties() :: term()

Additional properties of subscription/edge. E.g. selector for Broadcast dispatcher.

t()

@type t() :: %{required(component()) => [subscription()]}

Component network is adjacency graph with subscription edges.

Link to this section Functions

convert_to_network(scenario_templates)

@spec convert_to_network([Runbox.ScenarioTemplate.t()]) :: t()

Creates base network with only template nodes

create(scenario_templates, opts \\ [])

@spec create([Runbox.ScenarioTemplate.t()], Keyword.t()) ::
  {:ok, t()} | {:error, term()}

Main function. Given list of template modules, expands them into components network with input streams, timezips etc...

options
Options

:direct_ticking - if true (default), creates network using direct ticking

input_topics(component_network)

@spec input_topics(t()) :: [String.t()]

Return all input topic names that are being subscribed to in component network.

topology_sort(network)

@spec topology_sort(t()) :: [component()]