esphome::usb_uart::RingBuffer Class Reference

#include <usb_uart.h>

Public Member Functions
	RingBuffer (uint16_t buffer_size)
bool	is_empty () const
size_t	get_available () const
size_t	get_free_space () const
uint8_t	peek () const
void	push (uint8_t item)
void	push (const uint8_t *data, size_t len)
uint8_t	pop ()
size_t	pop (uint8_t *data, size_t len)
void	clear ()

Protected Attributes
uint16_t	insert_pos_ = 0
uint16_t	read_pos_ = 0
uint16_t	buffer_size_
uint8_t *	buffer_

Detailed Description

Definition at line 48 of file usb_uart.h.

Constructor & Destructor Documentation

RingBuffer()

esphome::usb_uart::RingBuffer::RingBuffer ( uint16_t buffer_size )

inline

Definition at line 50 of file usb_uart.h.

Member Function Documentation

clear()

void esphome::usb_uart::RingBuffer::clear ( )

inline

Definition at line 61 of file usb_uart.h.

get_available()

size_t esphome::usb_uart::RingBuffer::get_available ( ) const

inline

Definition at line 52 of file usb_uart.h.

get_free_space()

size_t esphome::usb_uart::RingBuffer::get_free_space ( ) const

inline

Definition at line 55 of file usb_uart.h.

is_empty()

bool esphome::usb_uart::RingBuffer::is_empty ( ) const

inline

Definition at line 51 of file usb_uart.h.

peek()

uint8_t esphome::usb_uart::RingBuffer::peek ( ) const

inline

Definition at line 56 of file usb_uart.h.

pop() [1/2]

uint8_t esphome::usb_uart::RingBuffer::pop

(

)

Definition at line 123 of file usb_uart.cpp.

pop() [2/2]

size_t esphome::usb_uart::RingBuffer::pop	(	uint8_t *	data,
		size_t	len )

Definition at line 128 of file usb_uart.cpp.

push() [1/2]

void esphome::usb_uart::RingBuffer::push	(	const uint8_t *	data,
		size_t	len )

Definition at line 116 of file usb_uart.cpp.

push() [2/2]

void esphome::usb_uart::RingBuffer::push

(

uint8_t

item

)

Definition at line 112 of file usb_uart.cpp.

Field Documentation

buffer_

uint8_t* esphome::usb_uart::RingBuffer::buffer_

protected

Definition at line 67 of file usb_uart.h.

buffer_size_

uint16_t esphome::usb_uart::RingBuffer::buffer_size_

protected

Definition at line 66 of file usb_uart.h.

insert_pos_

uint16_t esphome::usb_uart::RingBuffer::insert_pos_ = 0

protected

Definition at line 64 of file usb_uart.h.

read_pos_

uint16_t esphome::usb_uart::RingBuffer::read_pos_ = 0

protected

Definition at line 65 of file usb_uart.h.

---

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

• esphome/components/usb_uart/usb_uart.h
• esphome/components/usb_uart/usb_uart.cpp