Detailed Description

Core mmbuf data structure.

Note: The contents of this data structure should never need to be accessed directly. Rather the various functions provided as part of this API should be used.

 +----------------------------------------------------------+
 | RESERVED |              Data            |    RESERVED    |
 +----------------------------------------------------------+
 ^          ^                              ^                ^
 |          |                              |                |
 |          |<-----------data_len--------->|                |
 |     start_offset                                         |
 |                                                          |
 |<-----------------------buf_len-------------------------->|
buf

Definition at line 52 of file mmbuf.h.

#include <mmbuf.h>

Data Fields
uint8_t *	buf
	The buffer where data is stored. More...

uint32_t	buf_len
	Length of the buffer. More...

uint32_t	start_offset
	Offset where actual data starts in the buffer. More...

uint32_t	data_len
	Length of actual data in the buffer. More...

const struct mmbuf_ops *	ops
	Reference to operations data structure for this mmbuf. More...

struct mmbuf *volatile	next
	Pointer that can be used to construct linked lists. More...

Field Documentation

◆ buf

uint8_t* mmbuf::buf

The buffer where data is stored.

Definition at line 55 of file mmbuf.h.

◆ buf_len

uint32_t mmbuf::buf_len

Length of the buffer.

Definition at line 57 of file mmbuf.h.

◆ data_len

uint32_t mmbuf::data_len

Length of actual data in the buffer.

Definition at line 61 of file mmbuf.h.

◆ next

struct mmbuf* volatile mmbuf::next

Pointer that can be used to construct linked lists.

Definition at line 65 of file mmbuf.h.

◆ ops

const struct mmbuf_ops* mmbuf::ops

Reference to operations data structure for this mmbuf.

Definition at line 63 of file mmbuf.h.

◆ start_offset

uint32_t mmbuf::start_offset

Offset where actual data starts in the buffer.

Definition at line 59 of file mmbuf.h.

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

mmbuf.h