See memory-buffer.h
for source code.
#define EMBER_NULL_BUFFER |
A special EmberBuffer ID indicating that no memory is currently allocated.
Definition at line 19
of file memory-buffer.h
.
EmberBuffer emberAllocateBuffer |
( |
uint16_t |
dataSizeInBytes | ) |
|
Dynamically allocates memory.
- Parameters
-
dataSizeInBytes | The size in bytes of the memory to be allocated. |
- Returns
- An EmberBuffer value of EMBER_NULL_BUFFER if the memory management system could not allocate the requested memory, or any other EmberBuffer value indicating that the requested memory was successfully allocated. The allocated memory can easily be freed by assigning an EmberBuffer variable to EMBER_NULL_BUFFER. The memory will be freed by the garbage collector during the next emberTick() call.
uint16_t emberGetAvailableBufferMemory |
( |
void |
| ) |
|
An API that returns the available memory at the buffer manager in bytes.
- Returns
- The number of available bytes.
Returns the length in bytes of the passed EmberBuffer buffer.
- Parameters
-
buffer | A pointer to the EmberBuffer buffer for which the corresponding length in bytes should be returned. |
- Returns
- The length in bytes of a memory segment corresponding to the passed EmberBuffer buffer.
Returns a pointer to the memory segment corresponding to the passed EmberBuffer buffer. Notice that the garbage collector can move memory segments to defragment the available memory. As result, the application should always use this API to obtain an updated pointer prior to accessing the memory.
- Parameters
-
buffer | A pointer to the EmberBuffer buffer for which the corresponding memory pointer should be returned. |
- Returns
- A NULL pointer if the passed EmberBuffer value is EMBER_NULL_BUFFER. Otherwise, a pointer to the corresponding memory segment.
void emberMarkApplicationBuffersHandler |
( |
void |
| ) |
|
This handler is invoked by the memory buffers system garbage collector and allows the application to properly mark the application-defined EmberBuffer variables.