class %SYSTEM.Config.SharedMemoryHeap
extends %SYSTEM.Help
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.
• parameter DOMAIN = "%Utility";
Default Localization Domain
• classmethod FreeCount()
as %String
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.
• final classmethod GetUsageSummary()
as %String
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.
• classmethod MaxCount()
as %Integer
Return configured shared memory heap in bytes.
• deprecatedfinal classmethod RecommendedSize(NumberOfProcess As %Integer = 0)
as %Integer
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.
• query UsageQuery(ConsumerID As %Integer = -1)
Selects
Description As %String, Allocated SMH/ST As %Integer, SMH/ST Available As %Integer, SMH/ST Used As %Integer, SMT Used As %Integer, GST Used As %Integer, All Used As %Integer
Return Usage of shared memory heap for each consumer.
• query WebList()
Selects
Description As %String, Allocated SMH/ST As %Integer, SMH/ST Available As %Integer, SMH/ST Used As %Integer, SMT Used As %Integer, GST Used As %Integer, All Used As %Integer
Return Usage of shared memory heap for each consumer.
