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

Member Data Documentation

flags

u8_t pbuf::flags

misc flags

Referenced by pbuf_init_alloced_pbuf(), and pbuf_realloc().

if_idx

u8_t pbuf::if_idx

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

Referenced by pbuf_init_alloced_pbuf().

len

u16_t pbuf::len

length of this buffer

Referenced by inet_chksum(), inet_chksum_pbuf(), low_level_input(), low_level_output(), pbuf_add_header_impl(), pbuf_cat(), pbuf_copy(), pbuf_copy_partial(), pbuf_dechain(), pbuf_free_header(), pbuf_get_contiguous(), pbuf_init_alloced_pbuf(), pbuf_memcmp(), pbuf_put_at(), pbuf_realloc(), pbuf_remove_header(), pbuf_skip_const(), pbuf_take(), pbuf_take_at(), pbuf_try_get_at(), slipif_output(), and slipif_rxbyte().

next

struct pbuf* pbuf::next

next pbuf in singly linked pbuf chain

Referenced by inet_chksum_pbuf(), inet_cksum_pseudo_base(), inet_cksum_pseudo_partial_base(), low_level_input(), low_level_output(), pbuf_alloc(), pbuf_cat(), pbuf_clen(), pbuf_coalesce(), pbuf_copy(), pbuf_copy_partial(), pbuf_dechain(), pbuf_free(), pbuf_free_header(), pbuf_init_alloced_pbuf(), pbuf_memcmp(), pbuf_realloc(), pbuf_skip_const(), pbuf_take(), pbuf_take_at(), slipif_output(), and slipif_rxbyte().

payload

void* pbuf::payload

pointer to the actual data in the buffer

Referenced by inet_chksum_pbuf(), low_level_input(), low_level_output(), pbuf_add_header_impl(), pbuf_alloc(), pbuf_alloc_reference(), pbuf_copy(), pbuf_copy_partial(), pbuf_get_contiguous(), pbuf_init_alloced_pbuf(), pbuf_put_at(), pbuf_realloc(), pbuf_remove_header(), pbuf_take(), pbuf_take_at(), pbuf_try_get_at(), slipif_output(), and slipif_rxbyte().

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.

Referenced by pbuf_free(), pbuf_init_alloced_pbuf(), and pbuf_ref().

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)

Referenced by pbuf_add_header_impl(), pbuf_cat(), pbuf_clone(), pbuf_copy(), pbuf_dechain(), pbuf_init_alloced_pbuf(), pbuf_memcmp(), pbuf_memfind(), pbuf_realloc(), pbuf_remove_header(), pbuf_strstr(), pbuf_take(), pbuf_take_at(), slipif_output(), and tcpRecvCallback().

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)

Referenced by pbuf_add_header_impl(), and pbuf_init_alloced_pbuf().

---

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

• ConOpSys/Engine/Communication/LwIP/src/include/lwip/pbuf.h