2 * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
5 * Redistribution and use in source and binary forms, with or without modification,
6 * are permitted provided that the following conditions are met:
8 * 1. Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright notice,
11 * this list of conditions and the following disclaimer in the documentation
12 * and/or other materials provided with the distribution.
13 * 3. The name of the author may not be used to endorse or promote products
14 * derived from this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
18 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
19 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
21 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
24 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
27 * This file is part of the lwIP TCP/IP stack.
29 * Author: Adam Dunkels <adam@sics.se>
32 #ifndef __LWIP_API_MSG_H__
33 #define __LWIP_API_MSG_H__
37 #if LWIP_NETCONN /* don't build if not configured for use in lwipopts.h */
39 #include <stddef.h> /* for size_t */
41 #include "lwip/ip_addr.h"
44 #include "lwip/igmp.h"
51 /* For the netconn API, these values are use as a bitmask! */
52 #define NETCONN_SHUT_RD 1
53 #define NETCONN_SHUT_WR 2
54 #define NETCONN_SHUT_RDWR (NETCONN_SHUT_RD | NETCONN_SHUT_WR)
56 /* IP addresses and port numbers are expected to be in
57 * the same byte order as in the corresponding pcb.
59 /** This struct includes everything that is necessary to execute a function
60 for a netconn in another thread context (mainly used to process netconns
61 in the tcpip_thread context to be thread safe). */
63 /** The netconn which to process - always needed: it includes the semaphore
64 which is used to block the application thread until the function finished. */
66 /** The return value of the function executed in tcpip_thread. */
68 /** Depending on the executed function, one of these union members is used */
70 /** used for do_send */
72 /** used for do_newconn */
76 /** used for do_bind and do_connect */
81 /** used for do_getaddr */
87 /** used for do_write */
93 /** used for do_recv */
97 /** used for do_close (/shutdown) */
102 /** used for do_join_leave_group */
104 ip_addr_t
*multiaddr
;
105 ip_addr_t
*netif_addr
;
106 enum netconn_igmp join_or_leave
;
108 #endif /* LWIP_IGMP */
109 #if TCP_LISTEN_BACKLOG
113 #endif /* TCP_LISTEN_BACKLOG */
117 /** This struct contains a function to execute in another thread context and
118 a struct api_msg_msg that serves as an argument for this function.
119 This is passed to tcpip_apimsg to execute functions in tcpip_thread context. */
121 /** function to execute in tcpip_thread context */
122 void (* function
)(struct api_msg_msg
*msg
);
123 /** arguments for this function */
124 struct api_msg_msg msg
;
128 /** As do_gethostbyname requires more arguments but doesn't require a netconn,
129 it has its own struct (to avoid struct api_msg getting bigger than necessary).
130 do_gethostbyname must be called using tcpip_callback instead of tcpip_apimsg
131 (see netconn_gethostbyname). */
133 /** Hostname to query or dotted IP address string */
135 /** Rhe resolved address is stored here */
137 /** This semaphore is posted when the name is resolved, the application thread
138 should wait on it. */
140 /** Errors are given back here */
143 #endif /* LWIP_DNS */
145 void do_newconn ( struct api_msg_msg
*msg
);
146 void do_delconn ( struct api_msg_msg
*msg
);
147 void do_bind ( struct api_msg_msg
*msg
);
148 void do_connect ( struct api_msg_msg
*msg
);
149 void do_disconnect ( struct api_msg_msg
*msg
);
150 void do_listen ( struct api_msg_msg
*msg
);
151 void do_send ( struct api_msg_msg
*msg
);
152 void do_recv ( struct api_msg_msg
*msg
);
153 void do_write ( struct api_msg_msg
*msg
);
154 void do_getaddr ( struct api_msg_msg
*msg
);
155 void do_close ( struct api_msg_msg
*msg
);
156 void do_shutdown ( struct api_msg_msg
*msg
);
158 void do_join_leave_group( struct api_msg_msg
*msg
);
159 #endif /* LWIP_IGMP */
162 void do_gethostbyname(void *arg
);
163 #endif /* LWIP_DNS */
165 struct netconn
* netconn_alloc(enum netconn_type t
, netconn_callback callback
);
166 void netconn_free(struct netconn
*conn
);
172 #endif /* LWIP_NETCONN */
174 #endif /* __LWIP_API_MSG_H__ */