abc/lwip
1
0
Fork 0
mirror of https://git.savannah.nongnu.org/git/lwip.git synced 2025-08-03 21:14:40 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add some dual-stack notes to documentation

Browse Source
This commit is contained in:
Dirk Ziegelmeier 2016-08-26 15:58:18 +02:00
parent 05a6d82fa1
commit 4b45baee10
4 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/core/raw.c
View File

@ -472,6 +472,8 @@ raw_new(u8_t proto)
* could not be allocated. * could not be allocated.
* *
* @param type IP address type, see IPADDR_TYPE_XX definitions. * @param type IP address type, see IPADDR_TYPE_XX definitions.
* If you want to listen to IPv4 and IPv6 (dual-stack) packets,
* supply @ref IPADDR_TYPE_ANY as argument and bind to @ref IP_ANY_TYPE.
* @param proto the protocol number (next header) of the IPv6 packet payload * @param proto the protocol number (next header) of the IPv6 packet payload
* (e.g. IP6_NEXTH_ICMP6) * (e.g. IP6_NEXTH_ICMP6)
* *

2
src/core/tcp.c
View File

@ -1603,6 +1603,8 @@ tcp_new(void)
* The pcb is not put on any list until binding using tcp_bind(). * The pcb is not put on any list until binding using tcp_bind().
* *
* @param type IP address type, see IPADDR_TYPE_XX definitions. * @param type IP address type, see IPADDR_TYPE_XX definitions.
* If you want to listen to IPv4 and IPv6 (dual-stack) connections,
* supply @ref IPADDR_TYPE_ANY as argument and bind to @ref IP_ANY_TYPE.
* @return a new tcp_pcb that initially is in state CLOSED * @return a new tcp_pcb that initially is in state CLOSED
*/ */
struct tcp_pcb * struct tcp_pcb *

2
src/core/udp.c
View File

@ -1145,6 +1145,8 @@ udp_new(void)
* Create a UDP PCB for specific IP type. * Create a UDP PCB for specific IP type.
* *
* @param type IP address type, see IPADDR_TYPE_XX definitions. * @param type IP address type, see IPADDR_TYPE_XX definitions.
* If you want to listen to IPv4 and IPv6 (dual-stack) packets,
* supply @ref IPADDR_TYPE_ANY as argument and bind to @ref IP_ANY_TYPE.
* @return The UDP PCB which was created. NULL if the PCB data structure * @return The UDP PCB which was created. NULL if the PCB data structure
* could not be allocated. * could not be allocated.
* *

6
src/include/lwip/ip_addr.h
View File

@ -47,9 +47,13 @@
extern "C" { extern "C" {
#endif #endif
/** These are the values for ip_addr_t.type */ /** Value for ip_addr_t.type: IPv4 */
#define IPADDR_TYPE_V4 0U #define IPADDR_TYPE_V4 0U
/** Value for ip_addr_t.type: IPv6 */
#define IPADDR_TYPE_V6 6U #define IPADDR_TYPE_V6 6U
/** Value for ip_addr_t.type: IPv4+IPv6 ("dual-stack")
* @see tcp_new_ip_type(), udp_new_ip_type(), raw_new_ip_type().
*/
#define IPADDR_TYPE_ANY 46U #define IPADDR_TYPE_ANY 46U
#if LWIP_IPV4 && LWIP_IPV6 #if LWIP_IPV4 && LWIP_IPV6