xref: /nrf52832-nimble/rt-thread/components/net/lwip-2.1.0/src/include/lwip/apps/lwiperf.h (revision 104654410c56c573564690304ae786df310c91fc)
1*10465441SEvalZero /**
2*10465441SEvalZero  * @file
3*10465441SEvalZero  * lwIP iPerf server implementation
4*10465441SEvalZero  */
5*10465441SEvalZero 
6*10465441SEvalZero /*
7*10465441SEvalZero  * Copyright (c) 2014 Simon Goldschmidt
8*10465441SEvalZero  * All rights reserved.
9*10465441SEvalZero  *
10*10465441SEvalZero  * Redistribution and use in source and binary forms, with or without modification,
11*10465441SEvalZero  * are permitted provided that the following conditions are met:
12*10465441SEvalZero  *
13*10465441SEvalZero  * 1. Redistributions of source code must retain the above copyright notice,
14*10465441SEvalZero  *    this list of conditions and the following disclaimer.
15*10465441SEvalZero  * 2. Redistributions in binary form must reproduce the above copyright notice,
16*10465441SEvalZero  *    this list of conditions and the following disclaimer in the documentation
17*10465441SEvalZero  *    and/or other materials provided with the distribution.
18*10465441SEvalZero  * 3. The name of the author may not be used to endorse or promote products
19*10465441SEvalZero  *    derived from this software without specific prior written permission.
20*10465441SEvalZero  *
21*10465441SEvalZero  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
22*10465441SEvalZero  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
23*10465441SEvalZero  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
24*10465441SEvalZero  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25*10465441SEvalZero  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
26*10465441SEvalZero  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27*10465441SEvalZero  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28*10465441SEvalZero  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
29*10465441SEvalZero  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
30*10465441SEvalZero  * OF SUCH DAMAGE.
31*10465441SEvalZero  *
32*10465441SEvalZero  * This file is part of the lwIP TCP/IP stack.
33*10465441SEvalZero  *
34*10465441SEvalZero  * Author: Simon Goldschmidt
35*10465441SEvalZero  *
36*10465441SEvalZero  */
37*10465441SEvalZero #ifndef LWIP_HDR_APPS_LWIPERF_H
38*10465441SEvalZero #define LWIP_HDR_APPS_LWIPERF_H
39*10465441SEvalZero 
40*10465441SEvalZero #include "lwip/opt.h"
41*10465441SEvalZero #include "lwip/ip_addr.h"
42*10465441SEvalZero 
43*10465441SEvalZero #ifdef __cplusplus
44*10465441SEvalZero extern "C" {
45*10465441SEvalZero #endif
46*10465441SEvalZero 
47*10465441SEvalZero #define LWIPERF_TCP_PORT_DEFAULT  5001
48*10465441SEvalZero 
49*10465441SEvalZero /** lwIPerf test results */
50*10465441SEvalZero enum lwiperf_report_type
51*10465441SEvalZero {
52*10465441SEvalZero   /** The server side test is done */
53*10465441SEvalZero   LWIPERF_TCP_DONE_SERVER,
54*10465441SEvalZero   /** The client side test is done */
55*10465441SEvalZero   LWIPERF_TCP_DONE_CLIENT,
56*10465441SEvalZero   /** Local error lead to test abort */
57*10465441SEvalZero   LWIPERF_TCP_ABORTED_LOCAL,
58*10465441SEvalZero   /** Data check error lead to test abort */
59*10465441SEvalZero   LWIPERF_TCP_ABORTED_LOCAL_DATAERROR,
60*10465441SEvalZero   /** Transmit error lead to test abort */
61*10465441SEvalZero   LWIPERF_TCP_ABORTED_LOCAL_TXERROR,
62*10465441SEvalZero   /** Remote side aborted the test */
63*10465441SEvalZero   LWIPERF_TCP_ABORTED_REMOTE
64*10465441SEvalZero };
65*10465441SEvalZero 
66*10465441SEvalZero /** Control */
67*10465441SEvalZero enum lwiperf_client_type
68*10465441SEvalZero {
69*10465441SEvalZero   /** Unidirectional tx only test */
70*10465441SEvalZero   LWIPERF_CLIENT,
71*10465441SEvalZero   /** Do a bidirectional test simultaneously */
72*10465441SEvalZero   LWIPERF_DUAL,
73*10465441SEvalZero   /** Do a bidirectional test individually */
74*10465441SEvalZero   LWIPERF_TRADEOFF
75*10465441SEvalZero };
76*10465441SEvalZero 
77*10465441SEvalZero /** Prototype of a report function that is called when a session is finished.
78*10465441SEvalZero     This report function can show the test results.
79*10465441SEvalZero     @param report_type contains the test result */
80*10465441SEvalZero typedef void (*lwiperf_report_fn)(void *arg, enum lwiperf_report_type report_type,
81*10465441SEvalZero   const ip_addr_t* local_addr, u16_t local_port, const ip_addr_t* remote_addr, u16_t remote_port,
82*10465441SEvalZero   u32_t bytes_transferred, u32_t ms_duration, u32_t bandwidth_kbitpsec);
83*10465441SEvalZero 
84*10465441SEvalZero void* lwiperf_start_tcp_server(const ip_addr_t* local_addr, u16_t local_port,
85*10465441SEvalZero                                lwiperf_report_fn report_fn, void* report_arg);
86*10465441SEvalZero void* lwiperf_start_tcp_server_default(lwiperf_report_fn report_fn, void* report_arg);
87*10465441SEvalZero void* lwiperf_start_tcp_client(const ip_addr_t* remote_addr, u16_t remote_port,
88*10465441SEvalZero                                enum lwiperf_client_type type,
89*10465441SEvalZero                                lwiperf_report_fn report_fn, void* report_arg);
90*10465441SEvalZero void* lwiperf_start_tcp_client_default(const ip_addr_t* remote_addr,
91*10465441SEvalZero                                lwiperf_report_fn report_fn, void* report_arg);
92*10465441SEvalZero 
93*10465441SEvalZero void  lwiperf_abort(void* lwiperf_session);
94*10465441SEvalZero 
95*10465441SEvalZero 
96*10465441SEvalZero #ifdef __cplusplus
97*10465441SEvalZero }
98*10465441SEvalZero #endif
99*10465441SEvalZero 
100*10465441SEvalZero #endif /* LWIP_HDR_APPS_LWIPERF_H */
101