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

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.