com.neeve.server.mon
Interface ISrvMonSysMemoryStats

All Superinterfaces:

IRogValidatable

All Known Implementing Classes:

SrvMonSysMemoryStats

@Generated(value="com.neeve.adm.AdmGenerator",
           date="Wed Mar 28 10:54:31 EDT 2018")
@AdmGenerated(compatLevel="3.8.0",
              admVersion="nvx-adm v3.7.265 (build 0)",
              date="3/28/18 10:54 AM",
              buildInfo="nvx-talon-3.7.265 (nvx-codegen-plugin)")
public interface ISrvMonSysMemoryStats
extends IRogValidatable

Groups together stats related to the JVM's memory usage.

Method Summary

void	clearCommittedVirtualMemorySize() Clears the value of 'committedVirtualMemorySize' Field Description The amount of virtual memory that is guaranteed to be available to the running process in bytes.
void	clearFreePhysicalMemorySize() Clears the value of 'freePhysicalMemorySize' Field Description The amount of free physical memory in bytes..
void	clearFreeSwapSpaceSize() Clears the value of 'freeSwapSpaceSize' Field Description The amount of free swap space in bytes.
void	clearHeapUsage() Clears the value of 'heapUsage' Field Description Holds stats about heap memory usage.
void	clearNonHeapUsage() Clears the value of 'nonHeapUsage' Field Description Holds stats about non heap memory usage.
void	clearTotalPhysicalMemorySize() Clears the value of 'totalPhysicalMemorySize' Field Description The total amount of physical memory in bytes.
void	clearTotalSwapSpaceSize() Clears the value of 'totalSwapSpaceSize' Field Description The total amount of swap space in bytes.
long	getCommittedVirtualMemorySize() Gets the value of 'committedVirtualMemorySize' Field Description The amount of virtual memory that is guaranteed to be available to the running process in bytes.
long	getFreePhysicalMemorySize() Gets the value of 'freePhysicalMemorySize' Field Description The amount of free physical memory in bytes..
long	getFreeSwapSpaceSize() Gets the value of 'freeSwapSpaceSize' Field Description The amount of free swap space in bytes.
SrvMonSysMemoryUsage	getHeapUsage() Gets the value of 'heapUsage' Field Description Holds stats about heap memory usage.
void	getHeapUsageTo(SrvMonSysMemoryUsage val) Copies the value of SrvMonSysMemoryUsage into the provided value.
SrvMonSysMemoryUsage	getNonHeapUsage() Gets the value of 'nonHeapUsage' Field Description Holds stats about non heap memory usage.
void	getNonHeapUsageTo(SrvMonSysMemoryUsage val) Copies the value of SrvMonSysMemoryUsage into the provided value.
long	getTotalPhysicalMemorySize() Gets the value of 'totalPhysicalMemorySize' Field Description The total amount of physical memory in bytes.
long	getTotalSwapSpaceSize() Gets the value of 'totalSwapSpaceSize' Field Description The total amount of swap space in bytes.
boolean	hasCommittedVirtualMemorySize() Checks for the presence of 'committedVirtualMemorySize' Field Description The amount of virtual memory that is guaranteed to be available to the running process in bytes.
boolean	hasFreePhysicalMemorySize() Checks for the presence of 'freePhysicalMemorySize' Field Description The amount of free physical memory in bytes..
boolean	hasFreeSwapSpaceSize() Checks for the presence of 'freeSwapSpaceSize' Field Description The amount of free swap space in bytes.
boolean	hasHeapUsage() Checks for the presence of 'heapUsage' Field Description Holds stats about heap memory usage.
boolean	hasNonHeapUsage() Checks for the presence of 'nonHeapUsage' Field Description Holds stats about non heap memory usage.
boolean	hasTotalPhysicalMemorySize() Checks for the presence of 'totalPhysicalMemorySize' Field Description The total amount of physical memory in bytes.
boolean	hasTotalSwapSpaceSize() Checks for the presence of 'totalSwapSpaceSize' Field Description The total amount of swap space in bytes.
void	lendHeapUsage(SrvMonSysMemoryUsage val) 'Lends' a reference of the SrvMonSysMemoryUsage to the message for this field.
void	lendNonHeapUsage(SrvMonSysMemoryUsage val) 'Lends' a reference of the SrvMonSysMemoryUsage to the message for this field.
void	setCommittedVirtualMemorySize(long val) Sets the value of 'committedVirtualMemorySize' Field Description The amount of virtual memory that is guaranteed to be available to the running process in bytes.
void	setFreePhysicalMemorySize(long val) Sets the value of 'freePhysicalMemorySize' Field Description The amount of free physical memory in bytes..
void	setFreeSwapSpaceSize(long val) Sets the value of 'freeSwapSpaceSize' Field Description The amount of free swap space in bytes.
void	setHeapUsage(SrvMonSysMemoryUsage val) Sets the value of 'heapUsage' Field Description Holds stats about heap memory usage.
void	setNonHeapUsage(SrvMonSysMemoryUsage val) Sets the value of 'nonHeapUsage' Field Description Holds stats about non heap memory usage.
void	setTotalPhysicalMemorySize(long val) Sets the value of 'totalPhysicalMemorySize' Field Description The total amount of physical memory in bytes.
void	setTotalSwapSpaceSize(long val) Sets the value of 'totalSwapSpaceSize' Field Description The total amount of swap space in bytes.
SrvMonSysMemoryUsage	takeHeapUsage() 'Takes' a reference to the heapUsage field from the message.
SrvMonSysMemoryUsage	takeNonHeapUsage() 'Takes' a reference to the nonHeapUsage field from the message.

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

setCommittedVirtualMemorySize

void setCommittedVirtualMemorySize(long val)

Sets the value of 'committedVirtualMemorySize'

Field Description

The amount of virtual memory that is guaranteed to be available to the running process in bytes.

Parameters:

val - The value to set.

getCommittedVirtualMemorySize

long getCommittedVirtualMemorySize()

Gets the value of 'committedVirtualMemorySize'

Field Description

The amount of virtual memory that is guaranteed to be available to the running process in bytes.

Returns:

The amount of virtual memory that is guaranteed to be available to the running process in bytes.

clearCommittedVirtualMemorySize

void clearCommittedVirtualMemorySize()

Clears the value of 'committedVirtualMemorySize'

Field Description

The amount of virtual memory that is guaranteed to be available to the running process in bytes.

See Also:

setCommittedVirtualMemorySize(long)

hasCommittedVirtualMemorySize

boolean hasCommittedVirtualMemorySize()

Checks for the presence of 'committedVirtualMemorySize'

Field Description

The amount of virtual memory that is guaranteed to be available to the running process in bytes.

See Also:

getCommittedVirtualMemorySize()

setFreePhysicalMemorySize

void setFreePhysicalMemorySize(long val)

Sets the value of 'freePhysicalMemorySize'

Field Description

The amount of free physical memory in bytes..

Parameters:

val - The value to set.

getFreePhysicalMemorySize

long getFreePhysicalMemorySize()

Gets the value of 'freePhysicalMemorySize'

Field Description

The amount of free physical memory in bytes..

Returns:

The amount of free physical memory in bytes..

clearFreePhysicalMemorySize

void clearFreePhysicalMemorySize()

Clears the value of 'freePhysicalMemorySize'

Field Description

The amount of free physical memory in bytes..

See Also:

setFreePhysicalMemorySize(long)

hasFreePhysicalMemorySize

boolean hasFreePhysicalMemorySize()

Checks for the presence of 'freePhysicalMemorySize'

Field Description

The amount of free physical memory in bytes..

See Also:

getFreePhysicalMemorySize()

setFreeSwapSpaceSize

void setFreeSwapSpaceSize(long val)

Sets the value of 'freeSwapSpaceSize'

Field Description

The amount of free swap space in bytes.

Parameters:

val - The value to set.

getFreeSwapSpaceSize

long getFreeSwapSpaceSize()

Gets the value of 'freeSwapSpaceSize'

Field Description

The amount of free swap space in bytes.

Returns:

The amount of free swap space in bytes.

clearFreeSwapSpaceSize

void clearFreeSwapSpaceSize()

Clears the value of 'freeSwapSpaceSize'

Field Description

The amount of free swap space in bytes.

See Also:

setFreeSwapSpaceSize(long)

hasFreeSwapSpaceSize

boolean hasFreeSwapSpaceSize()

Checks for the presence of 'freeSwapSpaceSize'

Field Description

The amount of free swap space in bytes.

See Also:

getFreeSwapSpaceSize()

setTotalPhysicalMemorySize

void setTotalPhysicalMemorySize(long val)

Sets the value of 'totalPhysicalMemorySize'

Field Description

The total amount of physical memory in bytes.

Parameters:

val - The value to set.

getTotalPhysicalMemorySize

long getTotalPhysicalMemorySize()

Gets the value of 'totalPhysicalMemorySize'

Field Description

The total amount of physical memory in bytes.

Returns:

The total amount of physical memory in bytes.

clearTotalPhysicalMemorySize

void clearTotalPhysicalMemorySize()

Clears the value of 'totalPhysicalMemorySize'

Field Description

The total amount of physical memory in bytes.

See Also:

setTotalPhysicalMemorySize(long)

hasTotalPhysicalMemorySize

boolean hasTotalPhysicalMemorySize()

Checks for the presence of 'totalPhysicalMemorySize'

Field Description

The total amount of physical memory in bytes.

See Also:

getTotalPhysicalMemorySize()

setTotalSwapSpaceSize

void setTotalSwapSpaceSize(long val)

Sets the value of 'totalSwapSpaceSize'

Field Description

The total amount of swap space in bytes.

Parameters:

val - The value to set.

getTotalSwapSpaceSize

long getTotalSwapSpaceSize()

Gets the value of 'totalSwapSpaceSize'

Field Description

The total amount of swap space in bytes.

Returns:

The total amount of swap space in bytes.

clearTotalSwapSpaceSize

void clearTotalSwapSpaceSize()

Clears the value of 'totalSwapSpaceSize'

Field Description

The total amount of swap space in bytes.

See Also:

setTotalSwapSpaceSize(long)

hasTotalSwapSpaceSize

boolean hasTotalSwapSpaceSize()

Checks for the presence of 'totalSwapSpaceSize'

Field Description

The total amount of swap space in bytes.

See Also:

getTotalSwapSpaceSize()

setHeapUsage

void setHeapUsage(SrvMonSysMemoryUsage val)

Sets the value of 'heapUsage'

Field Description

Holds stats about heap memory usage.

Parameters:

val - The value to set.

lendHeapUsage

void lendHeapUsage(SrvMonSysMemoryUsage val)

'Lends' a reference of the SrvMonSysMemoryUsage to the message for this field.

Field Description

Holds stats about heap memory usage.

NOTE:
It is illegal to hold onto an entity 'set' on a message post the disposal of the container message. This is true even if a reference to the entity is explicitly 'acquired' by the application via acquire().

To hold onto the reference of an entity beyond the lifecycle of its container message, an application must own a reference to the entity (via, for example, 'taking' the entity off an inbound message) and then 'lend' the entity to the message for sending. The act of 'lending' an entity to a message implies that the application continues to own the entity even though the message is holding a reference to it for the duration of the send.

Parameters:

val - the value to 'lend' to lend.

getHeapUsage

SrvMonSysMemoryUsage getHeapUsage()

Gets the value of 'heapUsage'

Field Description

Holds stats about heap memory usage.

Returns:

Holds stats about heap memory usage.

getHeapUsageTo

void getHeapUsageTo(SrvMonSysMemoryUsage val)

Copies the value of SrvMonSysMemoryUsage into the provided value.

IF the value is not set, then the contents of the provided SrvMonSysMemoryUsage are cleared.

Parameters:

val - the value to copy into

See Also:

SrvMonSysMemoryUsage.copyInto(SrvMonSysMemoryUsage)

takeHeapUsage

SrvMonSysMemoryUsage takeHeapUsage()

'Takes' a reference to the heapUsage field from the message.

Field Description

Holds stats about heap memory usage.

NOTE:
A nested entity reference returned by getXXX() is only valid until the entity is disposed i.e. the act of getting an entity does not transfer ownership of the entity to the application A message disposes of its reference to its contained entities when it is disposed itself.

An AEP engine disposes a message on return from its message handler. Therefore, applications working with AEP engines that wish to hold onto a nested entity reference post return from its containing message's handler must either acquire a reference to the container message or 'take' the nested entity itself from the container message. The act of 'taking' an entity differs from 'getting' an entity in that 'take' does what is necessary to ensure that the entity contents are not cleared and the entity not disposed when the message itself is disposed. For a taken entity to be disposed, the application must explicitly dispose it when done working with it.

Returns:

a 'taken' reference to the field or null if the field is not set.

hasHeapUsage

boolean hasHeapUsage()

Checks for the presence of 'heapUsage'

Field Description

Holds stats about heap memory usage.

See Also:

getHeapUsage()

clearHeapUsage

void clearHeapUsage()

Clears the value of 'heapUsage'

Field Description

Holds stats about heap memory usage.

See Also:

setHeapUsage(SrvMonSysMemoryUsage)

setNonHeapUsage

void setNonHeapUsage(SrvMonSysMemoryUsage val)

Sets the value of 'nonHeapUsage'

Field Description

Holds stats about non heap memory usage.

Parameters:

val - The value to set.

lendNonHeapUsage

void lendNonHeapUsage(SrvMonSysMemoryUsage val)

'Lends' a reference of the SrvMonSysMemoryUsage to the message for this field.

Field Description

Holds stats about non heap memory usage.

NOTE:
It is illegal to hold onto an entity 'set' on a message post the disposal of the container message. This is true even if a reference to the entity is explicitly 'acquired' by the application via acquire().

To hold onto the reference of an entity beyond the lifecycle of its container message, an application must own a reference to the entity (via, for example, 'taking' the entity off an inbound message) and then 'lend' the entity to the message for sending. The act of 'lending' an entity to a message implies that the application continues to own the entity even though the message is holding a reference to it for the duration of the send.

Parameters:

val - the value to 'lend' to lend.

getNonHeapUsage

SrvMonSysMemoryUsage getNonHeapUsage()

Gets the value of 'nonHeapUsage'

Field Description

Holds stats about non heap memory usage.

Returns:

Holds stats about non heap memory usage.

getNonHeapUsageTo

void getNonHeapUsageTo(SrvMonSysMemoryUsage val)

Copies the value of SrvMonSysMemoryUsage into the provided value.

IF the value is not set, then the contents of the provided SrvMonSysMemoryUsage are cleared.

Parameters:

val - the value to copy into

See Also:

SrvMonSysMemoryUsage.copyInto(SrvMonSysMemoryUsage)

takeNonHeapUsage

SrvMonSysMemoryUsage takeNonHeapUsage()

'Takes' a reference to the nonHeapUsage field from the message.

Field Description

Holds stats about non heap memory usage.

NOTE:
A nested entity reference returned by getXXX() is only valid until the entity is disposed i.e. the act of getting an entity does not transfer ownership of the entity to the application A message disposes of its reference to its contained entities when it is disposed itself.

An AEP engine disposes a message on return from its message handler. Therefore, applications working with AEP engines that wish to hold onto a nested entity reference post return from its containing message's handler must either acquire a reference to the container message or 'take' the nested entity itself from the container message. The act of 'taking' an entity differs from 'getting' an entity in that 'take' does what is necessary to ensure that the entity contents are not cleared and the entity not disposed when the message itself is disposed. For a taken entity to be disposed, the application must explicitly dispose it when done working with it.

Returns:

a 'taken' reference to the field or null if the field is not set.

hasNonHeapUsage

boolean hasNonHeapUsage()

Checks for the presence of 'nonHeapUsage'

Field Description

Holds stats about non heap memory usage.

See Also:

getNonHeapUsage()

clearNonHeapUsage

void clearNonHeapUsage()

Clears the value of 'nonHeapUsage'

Field Description

Holds stats about non heap memory usage.

See Also:

setNonHeapUsage(SrvMonSysMemoryUsage)