Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Fork of mbed-rtos by
MemoryPool< T, pool_sz > Class Template Reference
Define and manage fixed-size memory pools of objects of a given type. More...
#include <MemoryPool.h>
Public Member Functions | |
MemoryPool () | |
Create and Initialize a memory pool. | |
T * | alloc (void) |
Allocate a memory block of type T from a memory pool. | |
T * | calloc (void) |
Allocate a memory block of type T from a memory pool and set memory block to zero. | |
osStatus | free (T *block) |
Return an allocated memory block back to a specific memory pool. |
Detailed Description
template<typename T, uint32_t pool_sz>
class rtos::MemoryPool< T, pool_sz >
Define and manage fixed-size memory pools of objects of a given type.
- Template Parameters:
-
T data type of a single object (element). queue_sz maximum number of objects (elements) in the memory pool.
Definition at line 37 of file MemoryPool.h.
Constructor & Destructor Documentation
MemoryPool | ( | ) |
Create and Initialize a memory pool.
Definition at line 40 of file MemoryPool.h.
Member Function Documentation
T* alloc | ( | void | ) |
Allocate a memory block of type T from a memory pool.
- Returns:
- address of the allocated memory block or NULL in case of no memory available.
Definition at line 54 of file MemoryPool.h.
T* calloc | ( | void | ) |
Allocate a memory block of type T from a memory pool and set memory block to zero.
- Returns:
- address of the allocated memory block or NULL in case of no memory available.
Definition at line 61 of file MemoryPool.h.
osStatus free | ( | T * | block ) |
Return an allocated memory block back to a specific memory pool.
- Parameters:
-
address of the allocated memory block that is returned to the memory pool.
- Returns:
- status code that indicates the execution status of the function.
Definition at line 69 of file MemoryPool.h.
Generated on Wed Jul 13 2022 18:32:39 by
