pbuf Struct Reference

#include <pbuf.h>

Collaboration diagram for pbuf:

Public Attributes
struct pbuf *	next
void *	payload
u16_t	tot_len
u16_t	len
u8_t	type_internal
u8_t	flags
LWIP_PBUF_REF_T	ref
u8_t	if_idx

Detailed Description

Main packet buffer struct

Definition at line 186 of file pbuf.h.

Member Data Documentation

flags

u8_t pbuf::flags

misc flags

Definition at line 211 of file pbuf.h.

if_idx

u8_t pbuf::if_idx

For incoming packets, this contains the input netif's index

Definition at line 221 of file pbuf.h.

len

u16_t pbuf::len

length of this buffer

Definition at line 203 of file pbuf.h.

Referenced by lwip_tx_func(), pbuf_copy_partial_pbuf(), and START_TEST().

next

struct pbuf* pbuf::next

next pbuf in singly linked pbuf chain

Definition at line 188 of file pbuf.h.

Referenced by lwip_tx_func(), pbuf_copy_partial_pbuf(), and START_TEST().

payload

void* pbuf::payload

pointer to the actual data in the buffer

Definition at line 191 of file pbuf.h.

Referenced by lwip_tx_func(), pbuf_add_header_impl(), pbuf_alloc_reference(), pbuf_copy_partial_pbuf(), and pbuf_remove_header().

ref

LWIP_PBUF_REF_T pbuf::ref

the reference count always equals the number of pointers that refer to this pbuf. This can be pointers from an application, the stack itself, or pbuf->next pointers from a chain.

Definition at line 218 of file pbuf.h.

Referenced by pbuf_free(), and START_TEST().

tot_len

u16_t pbuf::tot_len

total length of this buffer and all next buffers in chain belonging to the same packet.

For non-queue packet chains this is the invariant: p->tot_len == p->len + (p->next? p->next->tot_len: 0)

Definition at line 200 of file pbuf.h.

Referenced by pbuf_copy(), pbuf_copy_partial_pbuf(), and START_TEST().

type_internal

u8_t pbuf::type_internal

a bit field indicating pbuf type and allocation sources (see PBUF_TYPE_FLAG_*, PBUF_ALLOC_FLAG_* and PBUF_TYPE_ALLOC_SRC_MASK)

Definition at line 208 of file pbuf.h.

Referenced by pbuf_add_header_impl().

---

The documentation for this struct was generated from the following file:

• drivers/network/tcpip/lwip/src/include/lwip/pbuf.h