javax.realtime.memory

Class ScopedMemoryParameters

java.lang.Object

javax.realtime.MemoryParameters

javax.realtime.memory.ScopedMemoryParameters

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ScopedMemoryParameters
extends MemoryParameters

Extends memory parameters to provide limits for scoped memory.

Since:

RTSJ 2.0

See Also:

MemoryParameters, Serialized Form

Field Summary

Fields inherited from class javax.realtime.MemoryParameters

NO_MAX, UNLIMITED

Constructor Summary

Constructors

Constructor and Description
ScopedMemoryParameters(long maxInitialArea, long maxImmortal, long maxContainingArea) Same as ScopedMemoryParameters(maxInitialArea, maxImmortal, MemoryParameters.UNLIMITED, maxGlobalBackingStore, 0, 0).
ScopedMemoryParameters(long maxInitialArea, long maxImmortal, long maxContainingArea, long maxInitialBackingStore) Same as ScopedMemoryParameters(maxInitialArea, maxImmortal, 0, maxContainingArea, maxInitialBackingStore, 0).
ScopedMemoryParameters(long maxInitialArea, long maxImmortal, long allocationRate, long maxContainingArea, long maxInitialBackingStore, long maxGlobalBackingStore) Creates a ScopedMemoryParameters instance with the given values that can allow access to any ScopedMemory

Method Summary

Modifier and Type	Method and Description
long	getMaxContainingArea() Determines the limit on allocation in the area where the task was created.
long	getMaxGlobalBackingStore() Determines the limit on backing store for this task from the global pool.
long	getMaxInitialBackingStore() Determines the limit on backing store for this task from its parent StackedMemory.

Methods inherited from class javax.realtime.MemoryParameters

clone, getAllocationRate, getMaxImmortal, getMaxInitialMemoryArea, getMaxMemoryArea, setAllocationRate, setAllocationRateIfFeasible, setMaxImmortalIfFeasible, setMaxMemoryAreaIfFeasible

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScopedMemoryParameters

public ScopedMemoryParameters(long maxInitialArea,
                              long maxImmortal,
                              long allocationRate,
                              long maxContainingArea,
                              long maxInitialBackingStore,
                              long maxGlobalBackingStore)
                       throws StaticIllegalArgumentException

Creates a ScopedMemoryParameters instance with the given values that can allow access to any ScopedMemory

Parameters:

maxInitialArea - A limit on the amount of memory the schedulable may allocate in its initial scoped memory area. Units are in bytes. When zero, no allocation is allowed in the memory area. When the initial memory area is not a ScopedMemory, this parameter has no effect. To specify no limit, use UNLIMITED.

maxImmortal - A limit on the amount of memory the schedulable may allocate in the immortal area. Units are in bytes. When zero, no allocation allowed in immortal. To specify no limit, use UNLIMITED.

allocationRate - A limit on the rate of allocation in the heap. Units are in bytes per second of wall clock time. When allocationRate is zero, no allocation is allowed in the heap. To specify no limit, use UNLIMITED. Measurement starts when the schedulable is first released for execution; not when it is constructed. Enforcement of the allocation rate is an implementation option. When the implementation does not enforce allocation rate limits, it treats all positive allocation rate limits as UNLIMITED.

maxContainingArea - A limit on the amount of memory the schedulable may allocate in memory area where it was created. Units are in bytes. When zero, no allocation is allowed in the memory area. When the containing memory area is not a ScopedMemory, this parameter has no effect. To specify no limit, use UNLIMITED.

maxInitialBackingStore - A limit on the amount of backing store the schedulable may allocate from backing store of its initial memory area when that memory area is an instance of StackedMemory, in bytes. When zero, no allocation is allowed in that backing store. Backing store that is returned to the area backing store is subtracted from the limit. To specify no limit, use UNLIMITED.

maxGlobalBackingStore - A limit on the amount of backing store the schedulable may allocate from the global backing store to scoped memory areas in bytes. When zero, no allocation is allowed in the memory area. To specify no limit, use UNLIMITED.

Throws:

StaticIllegalArgumentException - when any value other less than zero is passed as the value of maxInitialArea, maxImmortal, allocationRate, maxBackingStore, or maxContainingArea.

ScopedMemoryParameters

public ScopedMemoryParameters(long maxInitialArea,
                              long maxImmortal,
                              long maxContainingArea,
                              long maxInitialBackingStore)
                       throws StaticIllegalArgumentException

Same as ScopedMemoryParameters(maxInitialArea, maxImmortal, 0, maxContainingArea, maxInitialBackingStore, 0). This constructor disallows root StackedMemory, LTMemory, and Heap allocation.

Throws:

StaticIllegalArgumentException

ScopedMemoryParameters

public ScopedMemoryParameters(long maxInitialArea,
                              long maxImmortal,
                              long maxContainingArea)
                       throws StaticIllegalArgumentException

Same as ScopedMemoryParameters(maxInitialArea, maxImmortal, MemoryParameters.UNLIMITED, maxGlobalBackingStore, 0, 0). This constructor disallows host StackedMemory and LTMemory allocation.

Throws:

StaticIllegalArgumentException

Method Detail

getMaxGlobalBackingStore

public long getMaxGlobalBackingStore()

Determines the limit on backing store for this task from the global pool.

Returns:

the limit on backing store.

getMaxInitialBackingStore

public long getMaxInitialBackingStore()

Determines the limit on backing store for this task from its parent StackedMemory.

Returns:

the limit on backing store.

getMaxContainingArea

public long getMaxContainingArea()

Determines the limit on allocation in the area where the task was created.

Returns:

the limit on allocation in the area where the task was created.