Symbols ![]()
loading...
Files ![]()
loading...
net_buf struct
Network buffer representation. This struct is used to represent network buffers. Such buffers are normally defined through the NET_BUF_POOL_*_DEFINE() APIs and allocated using the net_buf_alloc() API.
Syntax
struct net_buf
{
union {
sys_snode_t node;
struct net_buf *frags;
};
uint8_t ref;
uint8_t flags;
struct net_buf_pool *pool;
union {
struct {
uint8_t *data;
uint16_t len;
uint16_t size;
uint8_t *__buf;
};
struct net_buf_simple b;
};
uint8_t user_data[BLE_MESH_NET_BUF_USER_DATA_SIZE] __net_buf_align;
};
Fields
Field
Declared as
Description
Related Functions
Found 23 other functions taking a net_buf
argument:
Function
Description
Get a pointer to the user data of a buffer.
Put a buffer into a list Put a buffer to the end of a list. If the buffer contains follow-up fragments this function will take care of inserting them as well into the list.
Increment the reference count of a buffer.
Find the last fragment in the fragment list.
Get a zero-based index for a buffer. This function will translate a buffer into a zero-based index, based on its placement in its buffer pool. This can be useful if you want to associate an external array of meta-data contexts with the buffers of a pool.
Reset buffer Reset buffer data and flags so it can be reused for other purposes.
Insert a new fragment to a chain of bufs. Insert a new fragment into the buffer fragments list after the parent. Note: This function takes ownership of the fragment reference so the caller is not required to unref.
Add a new fragment to the end of a chain of bufs. Append a new fragment into the buffer fragments list. Note: This function takes ownership of the fragment reference so the caller is not required to unref.
Copy bytes from net_buf chain starting at offset to linear buffer Copy (extract) @a len bytes from @a src net_buf chain, starting from @a offset in it, to a linear buffer @a dst. Return number of bytes actually copied, which may be less than requested, if net_buf chain doesn't have enough data, or destination buffer is too small.
Append data to a list of net_buf Append data to a net_buf. If there is not enough space in the net_buf then more net_buf will be added, unless there are no free net_buf and timeout occurs.
Skip N number of bytes in a net_buf Skip N number of bytes starting from fragment's offset. If the total length of data is placed in multiple fragments, this function will skip from all fragments until it reaches N number of bytes. Any fully skipped buffers are removed from the net_buf list.
Calculate amount of bytes stored in fragments. Calculates the total amount of data stored in the given buffer and the fragments linked to it.