Data Fields

HeapQueueMgr_Params Struct Reference

Structure defining parameters for the HeapQueueMgr module. More...

#include <HeapQueueMgr.h>

Data Fields

String name
UInt16 regionId
SizeT blockSize
UInt numBlocks

Detailed Description

Structure defining parameters for the HeapQueueMgr module.

Field Documentation

Name of this instance.

The name (if not NULL) must be unique among all HeapQueueMgr instances in the entire system. When creating a new heap, it is necessary to supply an instance name.

The name does not have to be persistent. The supplied string is copied into persistent memory.

Shared region ID

The index corresponding to the shared region from which shared memory will be allocated.

Size (in MAUs) of each block.

HeapQueueMgr will round the blockSize up to the nearest multiple of the alignment, so the actual blockSize may be larger. When creating a HeapQueueMgr dynamically, this needs to be taken into account to determine the proper buffer size to pass in.

Required parameter.

The default size of the blocks is 0 MAUs.

Number of fixed-size blocks.

This is a required parameter for all new HeapQueueMgr instances.

The documentation for this struct was generated from the following file:
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines

Copyright 2011, Texas Instruments Incorporated