Rtos API example

Embed: (wiki syntax)

« Back to documentation index

lwiperf.h File Reference

lwiperf.h File Reference

lwIP iPerf server implementation More...

Go to the source code of this file.

Typedefs

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, u32_t bytes_transferred, u32_t ms_duration, u32_t bandwidth_kbitpsec)
 Prototype of a report function that is called when a session is finished.

Enumerations

enum  lwiperf_report_type {
  LWIPERF_TCP_DONE_SERVER, LWIPERF_TCP_DONE_CLIENT, LWIPERF_TCP_ABORTED_LOCAL, LWIPERF_TCP_ABORTED_LOCAL_DATAERROR,
  LWIPERF_TCP_ABORTED_LOCAL_TXERROR, LWIPERF_TCP_ABORTED_REMOTE
}
 

lwIPerf test results

More...

Functions

void * lwiperf_start_tcp_server (const ip_addr_t *local_addr, u16_t local_port, lwiperf_report_fn report_fn, void *report_arg)
 Start a TCP iperf server on a specific IP address and port and listen for incoming connections from iperf clients.
void * lwiperf_start_tcp_server_default (lwiperf_report_fn report_fn, void *report_arg)
 Start a TCP iperf server on the default TCP port (5001) and listen for incoming connections from iperf clients.
void lwiperf_abort (void *lwiperf_session)
 Abort an iperf session (handle returned by lwiperf_start_tcp_server*())

Detailed Description

lwIP iPerf server implementation

Definition in file lwiperf.h.


Typedef Documentation

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, u32_t bytes_transferred, u32_t ms_duration, u32_t bandwidth_kbitpsec)

Prototype of a report function that is called when a session is finished.

This report function can show the test results.

Parameters:
report_typecontains the test result

Definition at line 69 of file lwiperf.h.


Enumeration Type Documentation

lwIPerf test results

Enumerator:
LWIPERF_TCP_DONE_SERVER 

The server side test is done.

LWIPERF_TCP_DONE_CLIENT 

The client side test is done.

LWIPERF_TCP_ABORTED_LOCAL 

Local error lead to test abort.

LWIPERF_TCP_ABORTED_LOCAL_DATAERROR 

Data check error lead to test abort.

LWIPERF_TCP_ABORTED_LOCAL_TXERROR 

Transmit error lead to test abort.

LWIPERF_TCP_ABORTED_REMOTE 

Remote side aborted the test.

Definition at line 50 of file lwiperf.h.