esphome::RAMAllocator< T > Class Template Reference

An STL allocator that uses SPI or internal RAM. More...

#include <helpers.h>

Public Types
enum	Flags {   NONE = 0 , ALLOC_EXTERNAL = 1 << 0 , ALLOC_INTERNAL = 1 << 1 , ALLOW_FAILURE = 1 << 2 ,   PREFER_INTERNAL = 1 << 3 }
using	value_type = T

Public Member Functions
constexpr	RAMAllocator ()=default
constexpr	RAMAllocator (uint8_t flags)
template<class U >
constexpr	RAMAllocator (const RAMAllocator< U > &other)
T *	allocate (size_t n)
T *	allocate (size_t n, size_t manual_size)
T *	reallocate (T *p, size_t n)
T *	reallocate (T *p, size_t n, size_t manual_size)
void	deallocate (T *p, size_t n)
template<typename... Args>
RAMUniquePtr< T >	make_unique (Args &&...args)
	Value initialize one T; empty on exhaustion.
RAMUniquePtr< T[]>	make_unique_array_for_overwrite (size_t n)
	n elements left uninitialized, as std::make_unique_for_overwrite does; empty on exhaustion, overflow, and n == 0
size_t	get_free_heap_size () const
	Return the total heap space available via this allocator.
size_t	get_max_free_block_size () const
	Return the maximum size block this allocator could allocate.

Detailed Description

template<class T>
class esphome::RAMAllocator< T >

An STL allocator that uses SPI or internal RAM.

Returns nullptr in case no memory is available.

By setting flags, it can be configured to:

• perform external allocation falling back to internal memory if SPI RAM is full or unavailable (default)
• perform internal allocation falling back to external memory (with PREFER_INTERNAL)
• perform external allocation only
• perform internal allocation only

Definition at line 2142 of file helpers.h.

Member Typedef Documentation

value_type

template<class T >

using esphome::RAMAllocator< T >::value_type = T

Definition at line 2144 of file helpers.h.

Member Enumeration Documentation

Flags

template<class T >

enum esphome::RAMAllocator::Flags

Enumerator
NONE
ALLOC_EXTERNAL
ALLOC_INTERNAL
ALLOW_FAILURE
PREFER_INTERNAL

Definition at line 2146 of file helpers.h.

Constructor & Destructor Documentation

RAMAllocator() [1/3]

template<class T >

esphome::RAMAllocator< T >::RAMAllocator ( )

constexprdefault

RAMAllocator() [2/3]

template<class T >

esphome::RAMAllocator< T >::RAMAllocator ( uint8_t flags )

inlineconstexpr

Definition at line 2155 of file helpers.h.

RAMAllocator() [3/3]

template<class T >

template<class U >

esphome::RAMAllocator< T >::RAMAllocator ( const RAMAllocator< U > & other )

inlineconstexpr

Definition at line 2167 of file helpers.h.

Member Function Documentation

allocate() [1/2]

template<class T >

T * esphome::RAMAllocator< T >::allocate ( size_t n )

inline

Definition at line 2169 of file helpers.h.

allocate() [2/2]

template<class T >

T * esphome::RAMAllocator< T >::allocate ( size_t n, size_t manual_size )

inline

Definition at line 2171 of file helpers.h.

deallocate()

template<class T >

void esphome::RAMAllocator< T >::deallocate ( T * p, size_t n )

inline

Definition at line 2199 of file helpers.h.

get_free_heap_size()

template<class T >

size_t esphome::RAMAllocator< T >::get_free_heap_size ( ) const

inline

Return the total heap space available via this allocator.

Definition at line 2226 of file helpers.h.

get_max_free_block_size()

template<class T >

size_t esphome::RAMAllocator< T >::get_max_free_block_size ( ) const

inline

Return the maximum size block this allocator could allocate.

This may be an approximation on some platforms

Definition at line 2247 of file helpers.h.

make_unique()

template<class T >

template<typename... Args>

RAMUniquePtr< T > esphome::RAMAllocator< T >::make_unique ( Args &&... args )

inline

Value initialize one T; empty on exhaustion.

new (std::nothrow) aborts on ESP-IDF instead. Default flags prefer PSRAM; pass PREFER_INTERNAL to keep an object where plain new put it.

Definition at line 2205 of file helpers.h.

make_unique_array_for_overwrite()

template<class T >

RAMUniquePtr< T[]> esphome::RAMAllocator< T >::make_unique_array_for_overwrite ( size_t n )

inline

n elements left uninitialized, as std::make_unique_for_overwrite does; empty on exhaustion, overflow, and n == 0

Definition at line 2215 of file helpers.h.

reallocate() [1/2]

template<class T >

T * esphome::RAMAllocator< T >::reallocate ( T * p, size_t n )

inline

Definition at line 2184 of file helpers.h.

reallocate() [2/2]

template<class T >

T * esphome::RAMAllocator< T >::reallocate ( T * p, size_t n, size_t manual_size )

inline

Definition at line 2186 of file helpers.h.

---

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

• esphome/core/helpers.h