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

String HeapQueueMgr_Params::name

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.

UInt16 HeapQueueMgr_Params::regionId

Shared region ID

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

SizeT HeapQueueMgr_Params::blockSize

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.

UInt HeapQueueMgr_Params::numBlocks

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:

HeapQueueMgr.h

HeapQueueMgr_Params Struct Reference