Rtos API example

Embed: (wiki syntax)

« Back to documentation index

pbuf Struct Reference

pbuf Struct Reference

Main packet buffer struct. More...

#include <pbuf.h>

Data Fields

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

Detailed Description

Main packet buffer struct.

Definition at line 142 of file pbuf.h.


Field Documentation

u8_t flags

misc flags

Definition at line 165 of file pbuf.h.

u16_t len

length of this buffer

Definition at line 159 of file pbuf.h.

struct pbuf* next

next pbuf in singly linked pbuf chain

Definition at line 144 of file pbuf.h.

void* payload

pointer to the actual data in the buffer

Definition at line 147 of file pbuf.h.

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

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

u8_t type

pbuf_type as u8_t instead of enum to save space

Definition at line 162 of file pbuf.h.