Ring buffer instance. More...
#include <ring_buf.h>
Collaboration diagram for ring_buf:
Data Fields | |
| void * | space |
| Pointer to the buffer's data space. | |
| ring_buf_size_t | size |
| Size of the ring buffer. | |
| struct ring_buf_zone | put |
| Put zone. | |
| struct ring_buf_zone | get |
| Get zone. | |
Detailed Description
Ring buffer instance.
Represents a ring buffer with its associated data and zones for putting and getting data.
- Note
- This structure needs to exist within the header.
Definition at line 128 of file ring_buf.h.
Field Documentation
◆ get
| struct ring_buf_zone ring_buf::get |
Get zone.
Contains the zone for getting data in the ring buffer.
Definition at line 151 of file ring_buf.h.
◆ put
| struct ring_buf_zone ring_buf::put |
Put zone.
Contains the zone for putting data in the ring buffer.
Definition at line 145 of file ring_buf.h.
◆ size
| ring_buf_size_t ring_buf::size |
Size of the ring buffer.
Indicates the total size of the buffer in bytes.
Definition at line 139 of file ring_buf.h.
◆ space
| void* ring_buf::space |
Pointer to the buffer's data space.
Points to the memory area where the ring buffer's data is stored.
Definition at line 133 of file ring_buf.h.
The documentation for this struct was generated from the following file:
- include/ring_buf.h
