inet::tcp::pbuf Struct Reference

#include <pbuf.h>

Public Attributes
struct pbuf *	next
	next pbuf in singly linked pbuf chain More...
void *	payload
	pointer to the actual data in the buffer More...
u16_t	tot_len
	total length of this buffer and all next buffers in chain belonging to the same packet. More...
u16_t	len
	length of this buffer More...
u8_t	type
	pbuf_type as u8_t instead of enum to save space More...
u8_t	flags
	misc flags More...
u16_t	ref
	the reference count always equals the number of pointers that refer to this pbuf. More...

Member Data Documentation

u8_t inet::tcp::pbuf::flags

misc flags

Referenced by inet::tcp::pbuf_alloc().

u16_t inet::tcp::pbuf::len

length of this buffer

Referenced by inet::tcp::pbuf_alloc(), inet::tcp::pbuf_cat(), inet::tcp::pbuf_copy(), inet::tcp::pbuf_copy_partial(), inet::tcp::pbuf_dechain(), inet::tcp::pbuf_header(), inet::tcp::pbuf_realloc(), inet::tcp::pbuf_take(), and inet::tcp::TCP_lwIP::tcp_event_recv().

struct pbuf* inet::tcp::pbuf::next

next pbuf in singly linked pbuf chain

Referenced by inet::tcp::pbuf_alloc(), inet::tcp::pbuf_cat(), inet::tcp::pbuf_clen(), inet::tcp::pbuf_coalesce(), inet::tcp::pbuf_copy(), inet::tcp::pbuf_copy_partial(), inet::tcp::pbuf_dechain(), inet::tcp::pbuf_free(), inet::tcp::pbuf_realloc(), and inet::tcp::pbuf_take().

void* inet::tcp::pbuf::payload

pointer to the actual data in the buffer

Referenced by inet::tcp::pbuf_alloc(), inet::tcp::pbuf_copy(), inet::tcp::pbuf_copy_partial(), inet::tcp::pbuf_header(), inet::tcp::pbuf_realloc(), inet::tcp::pbuf_take(), and inet::tcp::TCP_lwIP::tcp_event_recv().

u16_t inet::tcp::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.

Referenced by inet::tcp::pbuf_alloc(), inet::tcp::pbuf_free(), and inet::tcp::pbuf_ref().

u16_t inet::tcp::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)

Referenced by inet::tcp::pbuf_alloc(), inet::tcp::pbuf_cat(), inet::tcp::pbuf_coalesce(), inet::tcp::pbuf_copy(), inet::tcp::pbuf_dechain(), inet::tcp::pbuf_header(), inet::tcp::pbuf_realloc(), inet::tcp::pbuf_take(), and inet::tcp::TCP_lwIP::tcp_event_recv().

u8_t inet::tcp::pbuf::type

pbuf_type as u8_t instead of enum to save space

Referenced by inet::tcp::pbuf_alloc(), inet::tcp::pbuf_free(), inet::tcp::pbuf_header(), and inet::tcp::pbuf_realloc().

---

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

• pbuf.h