HeapBufMP_Params Struct Reference

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

#include <HeapBufMP.h>

Data Fields
String	name
UInt16	regionId
SizeT	blockSize
UInt	numBlocks
SizeT	align
Bool	exact
GateMP_Handle	gate

Detailed Description

Structure defining parameters for the HeapBufMP module.

Field Documentation

String HeapBufMP_Params::name

Name of this instance.

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

UInt16 HeapBufMP_Params::regionId

Shared region ID

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

SizeT HeapBufMP_Params::blockSize

Size (in MAUs) of each block.

HeapBufMP will round the blockSize up to the nearest multiple of the alignment, so the actual blockSize may be larger. When creating a HeapBufMP 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 HeapBufMP_Params::numBlocks

Number of fixed-size blocks.

This is a required parameter for all new HeapBufMP instances.

SizeT HeapBufMP_Params::align

Alignment (in MAUs) of each block.

The alignment must be a power of 2. If the value 0 is specified, the value will be changed to meet minimum structure alignment requirements and the cache alignment size of the region in which the heap will be placed. Therefore, the actual alignment may be larger.

The default alignment is 0.

Bool HeapBufMP_Params::exact

Use exact matching

Setting this flag will allow allocation only if the requested size is equal to (rather than less than or equal to) the buffer's block size.

GateMP_Handle HeapBufMP_Params::gate

GateMP used for critical region management of the shared memory

Using the default value of NULL will result in use of the GateMP system gate for context protection.

The documentation for this struct was generated from the following file:

HeapBufMP.h

HeapBufMP_Params Struct Reference