Specification of how a static flow should work. More...

Data Fields
uint16_t	api_version
	API version number. More...

int(*	child_opts_set )(const struct sol_flow_node_type type, uint16_t child_index, const struct sol_flow_node_options opts, struct sol_flow_node_options *child_opts)
	Function to allow the static flow control the options used to create its nodes. More...

const struct sol_flow_static_conn_spec *	conns
	Array specifying the connections between nodes in the static flow. More...

void(*	dispose )(const void *type_data)
	Function called after the static type is disposed. More...

const struct sol_flow_static_port_spec *	exported_in
	Array specifying which input ports from the flow are going to be exported by the static flow. More...

const struct sol_flow_static_port_spec *	exported_out
	Array specifying which output ports from the flow are going to be exported by the static flow. More...

uint16_t	flags

const struct sol_flow_static_node_spec *	nodes
	Array specifying the node types that are used by the static flow. More...

Detailed Description

Specification of how a static flow should work.

Note: Note that the arrays and functions provided are assumed to be available and valid while the static flow type created from it is being used.

Field Documentation

uint16_t sol_flow_static_spec::api_version

API version number.

int(* sol_flow_static_spec::child_opts_set)(const struct sol_flow_node_type *type, uint16_t child_index, const struct sol_flow_node_options *opts, struct sol_flow_node_options *child_opts)

Function to allow the static flow control the options used to create its nodes.

It is called for each node every time a new flow is created from this type.

const struct sol_flow_static_conn_spec* sol_flow_static_spec::conns

Array specifying the connections between nodes in the static flow.

This array must be sorted by node index and port indexes. It should terminate with a SOL_FLOW_STATIC_CONN_SPEC_GUARD.

void(* sol_flow_static_spec::dispose)(const void *type_data)

Function called after the static type is disposed.

The user is passed the type_data pointer, that can be used to store reference to extra resources to be disposed.

const struct sol_flow_static_port_spec* sol_flow_static_spec::exported_in

Array specifying which input ports from the flow are going to be exported by the static flow.

When static flow is used as a node in another flow, these will be its input ports. It should terminate with a SOL_FLOW_STATIC_PORT_SPEC_GUARD.

const struct sol_flow_static_port_spec* sol_flow_static_spec::exported_out

Array specifying which output ports from the flow are going to be exported by the static flow.

When static flow is used as a node in another flow, these will be its output ports. It should terminate with a SOL_FLOW_STATIC_PORT_SPEC_GUARD.

uint16_t sol_flow_static_spec::flags

const struct sol_flow_static_node_spec* sol_flow_static_spec::nodes

Array specifying the node types that are used by the static flow.

The documentation for this struct was generated from the following file: