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