xref: /nrf52832-nimble/rt-thread/components/net/lwip-2.1.0/src/include/lwip/altcp_tcp.h (revision 104654410c56c573564690304ae786df310c91fc)
1*10465441SEvalZero /**
2*10465441SEvalZero  * @file
3*10465441SEvalZero  * Application layered TCP connection API (to be used from TCPIP thread)\n
4*10465441SEvalZero  * This interface mimics the tcp callback API to the application while preventing
5*10465441SEvalZero  * direct linking (much like virtual functions).
6*10465441SEvalZero  * This way, an application can make use of other application layer protocols
7*10465441SEvalZero  * on top of TCP without knowing the details (e.g. TLS, proxy connection).
8*10465441SEvalZero  *
9*10465441SEvalZero  * This file contains the base implementation calling into tcp.
10*10465441SEvalZero  */
11*10465441SEvalZero 
12*10465441SEvalZero /*
13*10465441SEvalZero  * Copyright (c) 2017 Simon Goldschmidt
14*10465441SEvalZero  * All rights reserved.
15*10465441SEvalZero  *
16*10465441SEvalZero  * Redistribution and use in source and binary forms, with or without modification,
17*10465441SEvalZero  * are permitted provided that the following conditions are met:
18*10465441SEvalZero  *
19*10465441SEvalZero  * 1. Redistributions of source code must retain the above copyright notice,
20*10465441SEvalZero  *    this list of conditions and the following disclaimer.
21*10465441SEvalZero  * 2. Redistributions in binary form must reproduce the above copyright notice,
22*10465441SEvalZero  *    this list of conditions and the following disclaimer in the documentation
23*10465441SEvalZero  *    and/or other materials provided with the distribution.
24*10465441SEvalZero  * 3. The name of the author may not be used to endorse or promote products
25*10465441SEvalZero  *    derived from this software without specific prior written permission.
26*10465441SEvalZero  *
27*10465441SEvalZero  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
28*10465441SEvalZero  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
29*10465441SEvalZero  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
30*10465441SEvalZero  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31*10465441SEvalZero  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
32*10465441SEvalZero  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33*10465441SEvalZero  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34*10465441SEvalZero  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
35*10465441SEvalZero  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
36*10465441SEvalZero  * OF SUCH DAMAGE.
37*10465441SEvalZero  *
38*10465441SEvalZero  * This file is part of the lwIP TCP/IP stack.
39*10465441SEvalZero  *
40*10465441SEvalZero  * Author: Simon Goldschmidt <[email protected]>
41*10465441SEvalZero  *
42*10465441SEvalZero  */
43*10465441SEvalZero #ifndef LWIP_HDR_ALTCP_TCP_H
44*10465441SEvalZero #define LWIP_HDR_ALTCP_TCP_H
45*10465441SEvalZero 
46*10465441SEvalZero #include "lwip/opt.h"
47*10465441SEvalZero 
48*10465441SEvalZero #if LWIP_ALTCP /* don't build if not configured for use in lwipopts.h */
49*10465441SEvalZero 
50*10465441SEvalZero #include "lwip/altcp.h"
51*10465441SEvalZero 
52*10465441SEvalZero #ifdef __cplusplus
53*10465441SEvalZero extern "C" {
54*10465441SEvalZero #endif
55*10465441SEvalZero 
56*10465441SEvalZero struct altcp_pcb *altcp_tcp_new_ip_type(u8_t ip_type);
57*10465441SEvalZero 
58*10465441SEvalZero #define altcp_tcp_new() altcp_tcp_new_ip_type(IPADDR_TYPE_V4)
59*10465441SEvalZero #define altcp_tcp_new_ip6() altcp_tcp_new_ip_type(IPADDR_TYPE_V6)
60*10465441SEvalZero 
61*10465441SEvalZero struct altcp_pcb *altcp_tcp_alloc(void *arg, u8_t ip_type);
62*10465441SEvalZero 
63*10465441SEvalZero struct tcp_pcb;
64*10465441SEvalZero struct altcp_pcb *altcp_tcp_wrap(struct tcp_pcb *tpcb);
65*10465441SEvalZero 
66*10465441SEvalZero #ifdef __cplusplus
67*10465441SEvalZero }
68*10465441SEvalZero #endif
69*10465441SEvalZero 
70*10465441SEvalZero #endif /* LWIP_ALTCP */
71*10465441SEvalZero 
72*10465441SEvalZero #endif /* LWIP_HDR_ALTCP_TCP_H */
73