EM-ODP 4.4.0
Event Machine on ODP
Loading...
Searching...
No Matches
em_eo_param_t Struct Reference

#include <event_machine_eo.h>

Collaboration diagram for em_eo_param_t:

Data Fields

em_start_func_t start
 
em_start_local_func_t local_start
 
em_eo_start_local_mode_t local_start_mode
 
em_stop_func_t stop
 
em_stop_local_func_t local_stop
 
em_eo_stop_local_mode_t local_stop_mode
 
em_receive_func_t receive
 
const void * eo_ctx
 
uint32_t __internal_check
 

Detailed Description

Execution Object (EO) parameters for em_eo_create_param(...)

Examples
dyn_cores.c.

Definition at line 475 of file event_machine_eo.h.

Field Documentation

◆ __internal_check

uint32_t em_eo_param_t::__internal_check

Internal check - don't touch!

EM will verify that em_eo_param_init(param) has been called before creating an EO with em_eo_create_param(..., param)

Definition at line 536 of file event_machine_eo.h.

◆ eo_ctx

const void* em_eo_param_t::eo_ctx

User defined EO context data, optional (NULL if no context). EM only passes the value.

Examples
dyn_cores.c.

Definition at line 528 of file event_machine_eo.h.

◆ local_start

em_start_local_func_t em_eo_param_t::local_start

EO core-local start function, optional (set NULL if not used). Called on all EM-cores (of type EM_CORE_TYPE_WORKER or EM_CORE_TYPE_CONTROL) after 'start' has completed.

Examples
dyn_cores.c.

Definition at line 490 of file event_machine_eo.h.

◆ local_start_mode

em_eo_start_local_mode_t em_eo_param_t::local_start_mode

EO local start function mode (see type documentation), set if using a local start function.

Examples
dyn_cores.c.

Definition at line 495 of file event_machine_eo.h.

◆ local_stop

em_stop_local_func_t em_eo_param_t::local_stop

EO core-local stop function, optional (set NULL if not used). Called and completed on all EM-cores (of type EM_CORE_TYPE_WORKER or EM_CORE_TYPE_CONTROL) before 'stop'.

Examples
dyn_cores.c.

Definition at line 511 of file event_machine_eo.h.

◆ local_stop_mode

em_eo_stop_local_mode_t em_eo_param_t::local_stop_mode

EO local stop function mode (see type documentation), set if using a local stop function.

Examples
dyn_cores.c.

Definition at line 516 of file event_machine_eo.h.

◆ receive

em_receive_func_t em_eo_param_t::receive

EO receive function for multiple events, mandatory. Only EM-cores of type of type EM_CORE_TYPE_WORKER or EM_CORE_TYPE_CONTROL will run this function.

Examples
dyn_cores.c.

Definition at line 523 of file event_machine_eo.h.

◆ start

em_start_func_t em_eo_param_t::start

EO start function, mandatory. Called once on one EM-core, triggered by em_eo_start/_start_sync(). First EO-function to be called. The 'start' function can be called on any core type, i.e. also on EM_CORE_TYPE_EXTERNAL if em_eo_start/start_sync() is called from there.

Examples
dyn_cores.c.

Definition at line 484 of file event_machine_eo.h.

◆ stop

em_stop_func_t em_eo_param_t::stop

EO stop function, mandatory. Called once on one EM-core, triggered by em_eo_stop/_stop_sync(). Last EO-function to be called. The 'stop' function can be called on any core type, i.e. also on EM_CORE_TYPE_EXTERNAL if em_eo_stop/stop_sync() is called from there.

Examples
dyn_cores.c.

Definition at line 505 of file event_machine_eo.h.


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