pbuf Struct Reference

#include <esp-open-lwip/include/lwip/pbuf.h>

Collaboration diagram for pbuf:

Data Fields
struct pbuf *	next
void *	payload
u16_t	tot_len
u16_t	len
u8_t	type
u8_t	flags
u16_t	ref
void *	eb

Detailed Description

Definition at line 76 of file pbuf.h.

Field Documentation

eb

void* pbuf::eb

Definition at line 109 of file pbuf.h.

flags

u8_t pbuf::flags

misc flags

Definition at line 99 of file pbuf.h.

Referenced by ip_output_if(), and pbuf_alloc().

len

u16_t pbuf::len

length of this buffer

Definition at line 93 of file pbuf.h.

Referenced by acl_check_packet(), espconn_udp_sendto(), espconn_udp_sent(), handle_dhcp(), inet_chksum_pbuf(), ip_input(), ip_output_if(), netif_set_link_down(), pbuf_alloc(), pbuf_cat(), pbuf_coalesce(), pbuf_copy(), pbuf_copy_partial(), pbuf_dechain(), pbuf_get_at(), pbuf_header(), pbuf_memcmp(), pbuf_realloc(), pbuf_take(), send_ack(), send_nak(), and send_offer().

next

struct pbuf* pbuf::next

next pbuf in singly linked pbuf chain

Definition at line 78 of file pbuf.h.

Referenced by espconn_udp_sendto(), espconn_udp_sent(), handle_dhcp(), inet_chksum_pbuf(), inet_chksum_pseudo(), inet_chksum_pseudo_partial(), netif_set_link_down(), pbuf_alloc(), pbuf_cat(), pbuf_clen(), pbuf_coalesce(), pbuf_copy_partial(), pbuf_dechain(), pbuf_free(), pbuf_get_at(), pbuf_memcmp(), pbuf_realloc(), pbuf_take(), send_ack(), send_nak(), and send_offer().

payload

void* pbuf::payload

pointer to the actual data in the buffer

Definition at line 81 of file pbuf.h.

Referenced by acl_check_packet(), espconn_udp_sendto(), espconn_udp_sent(), handle_dhcp(), inet_chksum_pbuf(), ip_input(), ip_output(), ip_output_if(), ip_router(), pbuf_alloc(), pbuf_coalesce(), pbuf_copy_partial(), pbuf_get_at(), pbuf_header(), pbuf_realloc(), pbuf_take(), send_ack(), send_nak(), and send_offer().

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

Referenced by espconn_udp_sendto(), espconn_udp_sent(), ip_output(), ip_output_if(), pbuf_alloc(), pbuf_free(), pbuf_ref(), send_ack(), send_nak(), and send_offer().

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

Referenced by espconn_client_recv(), espconn_server_recv(), handle_dhcp(), ip_input(), ip_output_if(), netif_set_link_down(), pbuf_alloc(), pbuf_cat(), pbuf_coalesce(), pbuf_dechain(), pbuf_header(), pbuf_memfind(), pbuf_realloc(), pbuf_strstr(), pbuf_take(), send_ack(), send_nak(), and send_offer().

type

u8_t pbuf::type

pbuf_type as u8_t instead of enum to save space

Definition at line 96 of file pbuf.h.

Referenced by pbuf_alloc(), pbuf_free(), pbuf_header(), and pbuf_realloc().

---

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

• esp-open-lwip/include/lwip/pbuf.h