nRF5 SDK for Thread and Zigbee v1.0.0
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages

This module includes the platform abstraction for the message pool. More...

Functions

void otPlatMessagePoolInit (otInstance *aInstance, uint16_t aMinNumFreeBuffers, size_t aBufferSize)
 
otMessageotPlatMessagePoolNew (otInstance *aInstance)
 
void otPlatMessagePoolFree (otInstance *aInstance, otMessage *aBuffer)
 
uint16_t otPlatMessagePoolNumFreeBuffers (otInstance *aInstance)
 

Detailed Description

This module includes the platform abstraction for the message pool.

Function Documentation

void otPlatMessagePoolFree ( otInstance aInstance,
otMessage aBuffer 
)

This function is used to free a Buffer back to the platform managed buffer pool.

Parameters
[in]aInstanceA pointer to the OpenThread instance.
[in]aBufferThe Buffer to free.
void otPlatMessagePoolInit ( otInstance aInstance,
uint16_t  aMinNumFreeBuffers,
size_t  aBufferSize 
)

Initialize the platform implemented message pool.

Parameters
[in]aInstanceA pointer to the OpenThread instance.
[in]aMinNumFreeBuffersAn uint16 containing the minimum number of free buffers desired by OpenThread.
[in]aBufferSizeThe size in bytes of a Buffer object.
otMessage* otPlatMessagePoolNew ( otInstance aInstance)

Allocate a buffer from the platform managed buffer pool.

Parameters
[in]aInstanceA pointer to the OpenThread instance.
Returns
A pointer to the Buffer or NULL if no Buffers are available.
uint16_t otPlatMessagePoolNumFreeBuffers ( otInstance aInstance)

Get the number of free buffers.

Parameters
[in]aInstanceA pointer to the OpenThread instance.
Returns
The number of buffers currently free and available to OpenThread.