Message Pool

This module includes the platform abstraction for the message pool.

Summary

Typedefs
otMessageBuffer typedef
This struct represents an OpenThread message buffer.

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

Structs
otMessageBuffer

This struct represents an OpenThread message buffer.

Typedefs

otMessageBuffer

struct otMessageBuffer otMessageBuffer

This struct represents an OpenThread message buffer.

Functions

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.

Details
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.

Details
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()).

Details
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.

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

Resources

OpenThread API Reference topics originate from the source code, available on GitHub. For more information, or to contribute to our documentation, refer to Resources.