SharedMemoryHeap Class Reference

The SYSTEM.Config.SharedMemoryHeap class provides an interface to return amount of shared memory heap used by InterSystems IRIS instance. More...

Inheritance diagram for SharedMemoryHeap:

Collaboration diagram for SharedMemoryHeap:

Static Public Member Functions
_.Library.String	FreeCount ()
_.Library.String	GetUsageSummary ()
	Return the total SMH memory used, SMH pages allocated and configured SMH memory. More...
_.Library.Integer	MaxCount ()
	Return configured shared memory heap in bytes.
_.Library.Integer	RecommendedSize (_.Library.Integer NumberOfProcess)
	Returns a recommended amount of shared memory heap to be configured in. More...
Static Public Member Functions inherited from Help
_.Library.String	Help (_.Library.String method)
	This is a helper class that is used by the various SYSTEM classes to provide a Help method. More...

Static Public Attributes
	DOMAIN = None
	Default Localization Domain.

Detailed Description

The SYSTEM.Config.SharedMemoryHeap class provides an interface to return amount of shared memory heap used by InterSystems IRIS instance.

It also provides API to get available shared memory heap and recommended shared nemory heap parameter for configuration.

Member Function Documentation

FreeCount()

_.Library.String FreeCount ( )

static

Return available shared memory heap in bytes

This returns a string in total,pages,smt,genstrtab format.
total - total shared memory heap available including pages,smt,genstrtab.
pages - total available shared memory heap pages(in bytes).
smt - total available memory in SMT table.
genstrtab - total available memory in General String Table.

GetUsageSummary()

_.Library.String GetUsageSummary ( )

static

Return the total SMH memory used, SMH pages allocated and configured SMH memory.

It returns a string with following information, they are separated by ',' and all the units are in byte.:
Total SMH memory used.
Total SMH pages allocated.
Total SMH memory configured.

RecommendedSize()

_.Library.Integer RecommendedSize ( _.Library.Integer  NumberOfProcess )

static

Returns a recommended amount of shared memory heap to be configured in.

kilobytes. This is based on the current utilization of shared memory heap but does not accurately predict future needs.