Function esp_idf_svc::sys::esp_event_dump

source ·
pub unsafe extern "C" fn esp_event_dump(file: *mut __sFILE) -> i32
Expand description

@brief Dumps statistics of all event loops.

Dumps event loop info in the format:

@verbatim event loop handler handler … event loop handler handler …

where:

event loop format: address,name rx:total_received dr:total_dropped where: address - memory address of the event loop name - name of the event loop, ‘none’ if no dedicated task total_received - number of successfully posted events total_dropped - number of events unsuccessfully posted due to queue being full

handler format: address ev:base,id inv:total_invoked run:total_runtime where: address - address of the handler function base,id - the event specified by event base and ID this handler executes total_invoked - number of times this handler has been invoked total_runtime - total amount of time used for invoking this handler

@endverbatim

@param[in] file the file stream to output to

@note this function is a noop when CONFIG_ESP_EVENT_LOOP_PROFILING is disabled

@return

  • ESP_OK: Success
  • ESP_ERR_NO_MEM: Cannot allocate memory for event loops list
  • Others: Fail