mirror/lwip
1
0
Fork 0
mirror of https://github.com/lwip-tcpip/lwip.git synced 2024-11-19 05:10:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

lwiperf: Complete documentation of lwiperf_report_fn

Browse Source 
Doxygen did not like only annotating one parameter.
This commit is contained in:
Erik Ekman 2021-11-27 20:09:59 +01:00
parent e594742801
commit 2711dbcac0
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/include/lwip/apps/lwiperf.h
View File

@ -76,7 +76,16 @@ enum lwiperf_client_type
/** Prototype of a report function that is called when a session is finished. /** Prototype of a report function that is called when a session is finished.
This report function can show the test results. This report function can show the test results.
@param report_type contains the test result */ @param arg Report_arg from when the test was started.
@param report_type contains the test result
@param local_addr The local address from the session
@param local_port The local port
@param remote_addr The remote address from the session
@param remote_port The remote port
@param bytes_transferred Total transferred bytes
@param ms_duration Total session duration, in milliseconds
@param bandwidth_kbitpsec Average bandwidth during the session, in kbps
*/
typedef void (*lwiperf_report_fn)(void *arg, enum lwiperf_report_type report_type, typedef void (*lwiperf_report_fn)(void *arg, enum lwiperf_report_type report_type,
const ip_addr_t* local_addr, u16_t local_port, const ip_addr_t* remote_addr, u16_t remote_port, const ip_addr_t* local_addr, u16_t local_port, const ip_addr_t* remote_addr, u16_t remote_port,
u32_t bytes_transferred, u32_t ms_duration, u32_t bandwidth_kbitpsec); u32_t bytes_transferred, u32_t ms_duration, u32_t bandwidth_kbitpsec);