sol_flow_inspector Struct Reference

Structure containing a set of inspecting routines. More...

#include <sol-flow-inspector.h>

Data Fields
uint16_t	api_version
	API version. More...
void(*	did_connect_port )(const struct sol_flow_inspector *inspector, const struct sol_flow_node *src_node, uint16_t src_port, uint16_t src_conn_id, const struct sol_flow_node *dst_node, uint16_t dst_port, uint16_t dst_conn_id)
	Callback to trigger when a connection between ports is made. More...
void(*	did_open_node )(const struct sol_flow_inspector *inspector, const struct sol_flow_node *node, const struct sol_flow_node_options *options)
	Callback to trigger when a node is open. More...
void(*	will_close_node )(const struct sol_flow_inspector *inspector, const struct sol_flow_node *node)
	Callback to trigger when a node is about to be closed. More...
void(*	will_deliver_packet )(const struct sol_flow_inspector *inspector, const struct sol_flow_node *dst_node, uint16_t dst_port, uint16_t dst_conn_id, const struct sol_flow_packet *packet)
	Callback to trigger when a packet is about to be delivered. More...
void(*	will_disconnect_port )(const struct sol_flow_inspector *inspector, const struct sol_flow_node *src_node, uint16_t src_port, uint16_t src_conn_id, const struct sol_flow_node *dst_node, uint16_t dst_port, uint16_t dst_conn_id)
	Callback to trigger when a connection is terminated. More...
void(*	will_send_packet )(const struct sol_flow_inspector *inspector, const struct sol_flow_node *src_node, uint16_t src_port, const struct sol_flow_packet *packet)
	Callback to trigger when a packet is about to be sent. More...

Detailed Description

Structure containing a set of inspecting routines.

This structure is used to setup the inspector with a set of routines that should be called in specific point and actions that happens during the execution of a flow.

Field Documentation

uint16_t sol_flow_inspector::api_version

API version.

void(* sol_flow_inspector::did_connect_port)(const struct sol_flow_inspector *inspector, const struct sol_flow_node *src_node, uint16_t src_port, uint16_t src_conn_id, const struct sol_flow_node *dst_node, uint16_t dst_port, uint16_t dst_conn_id)

Callback to trigger when a connection between ports is made.

Connections are unidirectional. So it's only possible to send packets from the source to the destination node.

Parameters

inspector	This inspector
src_node	Source node
src_port	Connected port on the source node
src_conn_id	Connection ID on the source node
dst_node	Destination node
dst_port	Connected port on the destination node
dst_conn_id	Connection ID on the destination node

void(* sol_flow_inspector::did_open_node)(const struct sol_flow_inspector *inspector, const struct sol_flow_node *node, const struct sol_flow_node_options *options)

Callback to trigger when a node is open.

Parameters

inspector	This inspector
node	Node that was open
options	Node options

void(* sol_flow_inspector::will_close_node)(const struct sol_flow_inspector *inspector, const struct sol_flow_node *node)

Callback to trigger when a node is about to be closed.

Parameters

inspector	This inspector
node	Node that will be closed

void(* sol_flow_inspector::will_deliver_packet)(const struct sol_flow_inspector *inspector, const struct sol_flow_node *dst_node, uint16_t dst_port, uint16_t dst_conn_id, const struct sol_flow_packet *packet)

Callback to trigger when a packet is about to be delivered.

Parameters

inspector	This inspector
dst_node	Packet's destination node
dst_port	Packet's destination port
dst_conn_id	Connection ID on the destination node
packet	The packet

void(* sol_flow_inspector::will_disconnect_port)(const struct sol_flow_inspector *inspector, const struct sol_flow_node *src_node, uint16_t src_port, uint16_t src_conn_id, const struct sol_flow_node *dst_node, uint16_t dst_port, uint16_t dst_conn_id)

Callback to trigger when a connection is terminated.

Parameters

inspector	This inspector
src_node	Source node
src_port	Disconnected port on the source node
src_conn_id	Connection ID on the source node
dst_node	Destination node
dst_port	Disconnected port on the destination node
dst_conn_id	Connection ID on the destination node

void(* sol_flow_inspector::will_send_packet)(const struct sol_flow_inspector *inspector, const struct sol_flow_node *src_node, uint16_t src_port, const struct sol_flow_packet *packet)

Callback to trigger when a packet is about to be sent.

Parameters

inspector	This inspector
src_node	Packet's source node
src_port	Packet's source port
packet	The packet

---

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

• src/lib/flow/include/sol-flow-inspector.h