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
u8_t	flags
u16_t	ref

Detailed Description

Definition at line 79 of file pbuf.h.

Member Data Documentation

flags

u8_t pbuf::flags

misc flags

Definition at line 102 of file pbuf.h.

len

u16_t pbuf::len

length of this buffer

Definition at line 96 of file pbuf.h.

Referenced by pbuf_copy().

next

struct pbuf* pbuf::next

next pbuf in singly linked pbuf chain

Definition at line 81 of file pbuf.h.

Referenced by pbuf_copy().

payload

void* pbuf::payload

pointer to the actual data in the buffer

Definition at line 84 of file pbuf.h.

Referenced by pbuf_copy(), and pbuf_header().

ref

u16_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 109 of file pbuf.h.

Referenced by pbuf_free().

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 93 of file pbuf.h.

Referenced by pbuf_copy().

type

u8_t pbuf::type

pbuf_type as u8_t instead of enum to save space

Definition at line 99 of file pbuf.h.

---

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

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