HeapMemMP_Params Struct Reference

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

#include <HeapMemMP.h>

Data Fields
String	name
UInt16	regionId
SizeT	sharedBufSize
GateMP_Handle	gate

Detailed Description

Structure defining parameters for the HeapMemMP module.

Field Documentation

String HeapMemMP_Params::name

Name of this instance.

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

UInt16 HeapMemMP_Params::regionId

Shared region ID

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

SizeT HeapMemMP_Params::sharedBufSize

Size of shared buffer

This is the size of the buffer to be used in the HeapMemMP instance. The actual buffer size in the created instance might actually be less than the value supplied in 'sharedBufSize' because of alignment constraints.

It is important to note that the total amount of shared memory required for a HeapMemMP instance will be greater than the size supplied here. Additional space will be consumed by shared instance attributes and alignment-related padding.

GateMP_Handle HeapMemMP_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:

HeapMemMP.h

HeapMemMP_Params Struct Reference