sol_flow_simple_c_type_event Struct Reference

Simple C event structure. More...

#include <sol-flow-simple-c-type.h>

Public Types
enum	sol_flow_simple_c_type_event_type {   SOL_FLOW_SIMPLE_C_TYPE_EVENT_TYPE_OPEN, SOL_FLOW_SIMPLE_C_TYPE_EVENT_TYPE_CLOSE, SOL_FLOW_SIMPLE_C_TYPE_EVENT_TYPE_CONNECT_PORT_IN, SOL_FLOW_SIMPLE_C_TYPE_EVENT_TYPE_DISCONNECT_PORT_IN,   SOL_FLOW_SIMPLE_C_TYPE_EVENT_TYPE_PROCESS_PORT_IN, SOL_FLOW_SIMPLE_C_TYPE_EVENT_TYPE_CONNECT_PORT_OUT, SOL_FLOW_SIMPLE_C_TYPE_EVENT_TYPE_DISCONNECT_PORT_OUT }
	Event type. More...

Data Fields
uint16_t	conn_id
	If type is one of SOL_FLOW_SIMPLE_C_TYPE_EVENT_TYPE_PORT_* events, the reference connection identifier. More...
const struct sol_flow_node_options *	options
const struct sol_flow_packet *	packet
uint16_t	port
	If type is one of SOL_FLOW_SIMPLE_C_TYPE_EVENT_TYPE_PORT_* events, the reference port index. More...
const char *	port_name
enum sol_flow_simple_c_type_event::sol_flow_simple_c_type_event_type	type

Detailed Description

Simple C event structure.

Examples:

/src/samples/flow/c-api/simple-c-type.c.

Member Enumeration Documentation

enum sol_flow_simple_c_type_event::sol_flow_simple_c_type_event_type

Event type.

Warning

Use it before accessing the other members of this structure.

Enumerator
SOL_FLOW_SIMPLE_C_TYPE_EVENT_TYPE_OPEN	Node is being open (instantiated)
SOL_FLOW_SIMPLE_C_TYPE_EVENT_TYPE_CLOSE	Node is being closed (deleted)
SOL_FLOW_SIMPLE_C_TYPE_EVENT_TYPE_CONNECT_PORT_IN	The input port defined by port index and port_name name is being connected.
SOL_FLOW_SIMPLE_C_TYPE_EVENT_TYPE_DISCONNECT_PORT_IN	The input port defined by port index and port_name name is being disconnected.
SOL_FLOW_SIMPLE_C_TYPE_EVENT_TYPE_PROCESS_PORT_IN	The input port defined by port index and port_name name received an incoming packet.
SOL_FLOW_SIMPLE_C_TYPE_EVENT_TYPE_CONNECT_PORT_OUT	The output port defined by port index and port_name name is being connected.
SOL_FLOW_SIMPLE_C_TYPE_EVENT_TYPE_DISCONNECT_PORT_OUT	The output port defined by port index and port_name name is being disconnected.

Field Documentation

uint16_t sol_flow_simple_c_type_event::conn_id

If type is one of SOL_FLOW_SIMPLE_C_TYPE_EVENT_TYPE_PORT_* events, the reference connection identifier.

Examples:

/src/samples/flow/c-api/simple-c-type.c.

Referenced by mytype_func().

const struct sol_flow_node_options* sol_flow_simple_c_type_event::options

Examples:

/src/samples/flow/c-api/simple-c-type.c.

Referenced by mytype_func().

const struct sol_flow_packet* sol_flow_simple_c_type_event::packet

Examples:

/src/samples/flow/c-api/simple-c-type.c.

Referenced by isodd(), and mytype_func().

uint16_t sol_flow_simple_c_type_event::port

If type is one of SOL_FLOW_SIMPLE_C_TYPE_EVENT_TYPE_PORT_* events, the reference port index.

Examples:

/src/samples/flow/c-api/simple-c-type.c.

Referenced by mytype_func().

const char* sol_flow_simple_c_type_event::port_name

Examples:

/src/samples/flow/c-api/simple-c-type.c.

Referenced by mytype_func().

enum sol_flow_simple_c_type_event::sol_flow_simple_c_type_event_type sol_flow_simple_c_type_event::type

Examples:

/src/samples/flow/c-api/simple-c-type.c.

Referenced by isodd(), and mytype_func().

---

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

• src/lib/flow/include/sol-flow-simple-c-type.h