abc/lwip
1
0
Fork 0
mirror of https://git.savannah.nongnu.org/git/lwip.git synced 2026-05-25 01:27:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update doxgen docs: PBUF layers, IPv4 and IPv6 functions, add some missing tcp raw API functions

Browse Source
This commit is contained in:
Dirk Ziegelmeier
2016-08-06 20:28:49 +02:00
parent 2acfa0ebe7
commit 87855b0e0e
4 changed files with 39 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
src/include/lwip/pbuf.h
View File

@@ -65,11 +65,33 @@ extern "C" {
#define PBUF_IP_HLEN 20
#endif
/**
* @ingroup pbuf
* Enumeration of pbuf layers
*/
typedef enum {
/** Includes spare room for transport layer header, e.g. TCP header.
* Use this if you intend to pass the pbuf to functions like udp_send(),
* tcp_write(), netconn_send() or netconn_write().
*/
PBUF_TRANSPORT,
/** Includes spare room for IP header.
* Use this if you intend to pass the pbuf to functions like raw_send().
*/
PBUF_IP,
/** Includes spare room for link layer header (ethernet header).
* Use this if you intend to pass the pbuf to functions like ip4_output(),
* ip6_output() or ip_output().
*/
PBUF_LINK,
/** Includes spare room for additional encapsulation header before ethernet headers (e.g. 802.11).
* Use this if you intend to pass the pbuf to functions like netif->linkoutput()
*/
PBUF_RAW_TX,
/** No spare room, final packet for sending.
* Use this if you intend to pass the pbuf to functions like netif->linkoutput()
* or for input packets received by ethernet-layer netif drivers.
*/
PBUF_RAW
} pbuf_layer;