Message Pool
Platform Abstraction

This module includes the platform abstraction for the message pool.

Classes

struct otMessageBuffer
This struct represents an OpenThread message buffer.

Typedefs

typedef struct otMessageBuffer otMessageBuffer
This struct represents an OpenThread message buffer.

Functions

void otPlatMessagePoolInit ( otInstance *aInstance, uint16_t aMinNumFreeBuffers, size_t aBufferSize)
Initialize the platform implemented message pool.
otMessageBuffer * otPlatMessagePoolNew ( otInstance *aInstance)
Allocate a buffer from the platform managed buffer pool.
void otPlatMessagePoolFree ( otInstance *aInstance, otMessageBuffer *aBuffer)
This function is used to free a buffer back to the platform managed buffer pool.
uint16_t otPlatMessagePoolNumFreeBuffers ( otInstance *aInstance)
Get the number of free buffers.

Detailed Description

This module includes the platform abstraction for the message pool.

Function Documentation

◆ otPlatMessagePoolFree()

void otPlatMessagePoolFree ( otInstance * aInstance,
otMessageBuffer * aBuffer
)

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

This function is used when OPENTHREAD_CONFIG_PLATFORM_MESSAGE_MANAGEMENT is enabled.

Parameters
[in] aInstance A pointer to the OpenThread instance.
[in] aBuffer The buffer to free.

◆ otPlatMessagePoolInit()

void otPlatMessagePoolInit ( otInstance * aInstance,
uint16_t aMinNumFreeBuffers,
size_t aBufferSize
)

Initialize the platform implemented message pool.

This function is used when OPENTHREAD_CONFIG_PLATFORM_MESSAGE_MANAGEMENT is enabled.

Parameters
[in] aInstance A pointer to the OpenThread instance.
[in] aMinNumFreeBuffers An uint16 containing the minimum number of free buffers desired by OpenThread.
[in] aBufferSize The size in bytes of a buffer object.

◆ otPlatMessagePoolNew()

otMessageBuffer * otPlatMessagePoolNew ( otInstance * aInstance )

Allocate a buffer from the platform managed buffer pool.

This function is used when OPENTHREAD_CONFIG_PLATFORM_MESSAGE_MANAGEMENT is enabled.

The returned buffer instance MUST have at least aBufferSize bytes (as specified in otPlatMessagePoolInit() ).

Parameters
[in] aInstance A pointer to the OpenThread instance.
Returns
A pointer to the buffer or NULL if no buffers are available.

◆ otPlatMessagePoolNumFreeBuffers()

uint16_t otPlatMessagePoolNumFreeBuffers ( otInstance * aInstance )

Get the number of free buffers.

This function is used when OPENTHREAD_CONFIG_PLATFORM_MESSAGE_MANAGEMENT is enabled.

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