ESPHome  2024.4.2
Public Member Functions | Static Public Member Functions | Protected Attributes
esphome::RingBuffer Class Reference

#include <ring_buffer.h>

Public Member Functions

size_t read (void *data, size_t len, TickType_t ticks_to_wait=0)
 
size_t write (void *data, size_t len)
 
size_t available () const
 
size_t free () const
 
BaseType_t reset ()
 

Static Public Member Functions

static std::unique_ptr< RingBuffercreate (size_t len)
 

Protected Attributes

StreamBufferHandle_t handle_
 
StaticStreamBuffer_t structure_
 
uint8_t * storage_
 

Detailed Description

Definition at line 13 of file ring_buffer.h.

Member Function Documentation

◆ available()

size_t esphome::RingBuffer::available ( ) const

Definition at line 42 of file ring_buffer.cpp.

◆ create()

std::unique_ptr< RingBuffer > esphome::RingBuffer::create ( size_t  len)
static

Definition at line 14 of file ring_buffer.cpp.

◆ free()

size_t esphome::RingBuffer::free ( ) const

Definition at line 44 of file ring_buffer.cpp.

◆ read()

size_t esphome::RingBuffer::read ( void *  data,
size_t  len,
TickType_t  ticks_to_wait = 0 
)

Definition at line 28 of file ring_buffer.cpp.

◆ reset()

BaseType_t esphome::RingBuffer::reset ( )

Definition at line 46 of file ring_buffer.cpp.

◆ write()

size_t esphome::RingBuffer::write ( void *  data,
size_t  len 
)

Definition at line 32 of file ring_buffer.cpp.

Field Documentation

◆ handle_

StreamBufferHandle_t esphome::RingBuffer::handle_
protected

Definition at line 27 of file ring_buffer.h.

◆ storage_

uint8_t* esphome::RingBuffer::storage_
protected

Definition at line 29 of file ring_buffer.h.

◆ structure_

StaticStreamBuffer_t esphome::RingBuffer::structure_
protected

Definition at line 28 of file ring_buffer.h.


The documentation for this class was generated from the following files: