EM-ODP  3.7.0
Event Machine on ODP
em_eo_multircv_param_t Struct Reference

#include <event_machine_eo.h>

Collaboration diagram for em_eo_multircv_param_t:

Data Fields

em_start_func_t start
 
em_start_local_func_t local_start
 
em_stop_func_t stop
 
em_stop_local_func_t local_stop
 
em_receive_multi_func_t receive_multi
 
int max_events
 
const void * eo_ctx
 
uint32_t __internal_check
 

Detailed Description

EO parameters for em_eo_create_multircv(...)

Examples
loop_multircv.c.

Definition at line 338 of file event_machine_eo.h.

Field Documentation

◆ __internal_check

uint32_t em_eo_multircv_param_t::__internal_check

Internal check - don't touch!

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

Definition at line 386 of file event_machine_eo.h.

◆ eo_ctx

const void* em_eo_multircv_param_t::eo_ctx

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

Definition at line 378 of file event_machine_eo.h.

◆ local_start

em_start_local_func_t em_eo_multircv_param_t::local_start

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

Definition at line 349 of file event_machine_eo.h.

◆ local_stop

em_stop_local_func_t em_eo_multircv_param_t::local_stop

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

Definition at line 360 of file event_machine_eo.h.

◆ max_events

int em_eo_multircv_param_t::max_events

Maximum number of events passed to the receive function. EM will dispatch 1 to 'max-events' at a time to the EO's multi-event receive function. Use '0' for an EM default value (=EM_EO_MULTIRCV_MAX_EVENTS). The user provided 'receive_multi' function must be able to handle 'max_events' events at a time.

Definition at line 373 of file event_machine_eo.h.

◆ receive_multi

em_receive_multi_func_t em_eo_multircv_param_t::receive_multi

EO receive function for multiple events, mandatory.

Examples
loop_multircv.c.

Definition at line 364 of file event_machine_eo.h.

◆ start

em_start_func_t em_eo_multircv_param_t::start

EO start function, mandatory. Called once on one core, triggered by em_eo_start/_start_sync(). First EO-function to be called.

Examples
loop_multircv.c.

Definition at line 344 of file event_machine_eo.h.

◆ stop

em_stop_func_t em_eo_multircv_param_t::stop

EO stop function, mandatory. Called once on one core, triggered by em_eo_stop/_stop_sync(). Last EO-function to be called.

Examples
loop_multircv.c.

Definition at line 355 of file event_machine_eo.h.


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