os::rtos::memory::allocator_stateless_default_resource< T > Class Template Reference

Standard allocator based on the RTOS system default memory manager. More...

#include <cmsis-plus/rtos/os.h>

Public Types
using	value_type = T
	Type of elements to be allocated.

Public Member Functions
Constructors & Destructor
	allocator_stateless_default_resource () noexcept=default
	Default constructor. Construct a default resource allocator object instance.
	allocator_stateless_default_resource (allocator_stateless_default_resource const &other)=default
	Copy constructor.
template<typename U >
	allocator_stateless_default_resource (allocator_stateless_default_resource< U > const &other) noexcept
	Copy constructor template.
	allocator_stateless_default_resource (allocator_stateless_default_resource &&other)=default
	Move constructor.
	~allocator_stateless_default_resource ()=default
	Destruct the default resource allocator object instance.
Operators
allocator_stateless_default_resource &	operator= (allocator_stateless_default_resource const &other)=default
	Copy assignment operator.
allocator_stateless_default_resource &	operator= (allocator_stateless_default_resource &&other)=default
	Move assignment operator.
Public Member Functions
value_type *	allocate (std::size_t elements)
	Allocate a number of memory blocks of type value_type.
void	deallocate (value_type *addr, std::size_t elements) noexcept
	Deallocate the number of memory blocks of type value_type.
std::size_t	max_size (void) const noexcept
	The maximum number of elements that can be passed to allocate().

Detailed Description

template<typename T>
class os::rtos::memory::allocator_stateless_default_resource< T >

Template Parameters

T	Type of elements to be allocated.

This class template is used as the default allocator for system classes. It gets memory from the system default memory manager os::rtos::memory::get_default_resource().

Note

As default allocator, this class must be stateless, i.e. have no member variables.

Definition at line 537 of file os-memory.h.

Member Typedef Documentation

value_type

template<typename T >

using os::rtos::memory::allocator_stateless_default_resource< T >::value_type = T

Definition at line 543 of file os-memory.h.

Constructor & Destructor Documentation

allocator_stateless_default_resource() [1/4]

template<typename T >

os::rtos::memory::allocator_stateless_default_resource< T >::allocator_stateless_default_resource ( )

defaultnoexcept

allocator_stateless_default_resource() [2/4]

template<typename T >

os::rtos::memory::allocator_stateless_default_resource< T >::allocator_stateless_default_resource ( allocator_stateless_default_resource< T > const &  other )

default

Parameters

other

Reference to existing allocator.

allocator_stateless_default_resource() [3/4]

template<typename T >

template<typename U >

os::rtos::memory::allocator_stateless_default_resource< T >::allocator_stateless_default_resource ( allocator_stateless_default_resource< U > const &  other )

noexcept

Parameters

other

Reference to allocator.

allocator_stateless_default_resource() [4/4]

template<typename T >

os::rtos::memory::allocator_stateless_default_resource< T >::allocator_stateless_default_resource ( allocator_stateless_default_resource< T > &&  other )

default

Parameters

other

Reference to existing allocator.

~allocator_stateless_default_resource()

template<typename T >

os::rtos::memory::allocator_stateless_default_resource< T >::~allocator_stateless_default_resource ( )

default

Member Function Documentation

allocate()

template<typename T >

value_type * os::rtos::memory::allocator_stateless_default_resource< T >::allocate

(

std::size_t

elements

)

Parameters

elements

Number of elements of type value_type.

Returns

Pointer to newly allocated memory blocks.

Referenced by os::rtos::internal::object_named_system::operator new().

deallocate()

template<typename T >

void os::rtos::memory::allocator_stateless_default_resource< T >::deallocate ( value_type *  addr, std::size_t  elements  )

noexcept

Parameters

addr	Pointer to previously allocated memory blocks.
elements	Number of elements of type value_type.

Returns

Nothing.

Referenced by os::rtos::memory_pool::~memory_pool(), os::rtos::message_queue::~message_queue(), and os::rtos::internal::object_named_system::operator delete().

max_size()

template<typename T >

std::size_t os::rtos::memory::allocator_stateless_default_resource< T >::max_size ( void  ) const

noexcept

Returns

Number of elements of type value_type.

operator=() [1/2]

template<typename T >

allocator_stateless_default_resource & os::rtos::memory::allocator_stateless_default_resource< T >::operator= ( allocator_stateless_default_resource< T > &&  other )

default

Parameters

other

Reference to existing allocator.

Returns

Reference to allocator.

operator=() [2/2]

template<typename T >

allocator_stateless_default_resource & os::rtos::memory::allocator_stateless_default_resource< T >::operator= ( allocator_stateless_default_resource< T > const &  other )

default

Parameters

other

Reference to existing allocator.

Returns

Reference to allocator.

---

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

• os-decls.h
• os-memory.h