com.neeve.server.mon
Class SrvMonSysMemoryStats

java.lang.Object
  com.neeve.server.mon.SrvMonSysMemoryStats

All Implemented Interfaces:

IRogValidatable, ISrvMonSysMemoryStats, UtlPool.Item<SrvMonSysMemoryStats>, com.neeve.xbuf.IXbufDesyncer

@Generated(value="com.neeve.adm.AdmXbufGenerator",
           date="Wed Mar 28 10:54:31 EDT 2018")
@AdmGenerated(encoding="Xbuf",
              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)")
@AdmFactoryInfo(factoryClass=SrvMonFactory.class,
                vfid=32,
                ofid=32,
                typeId=212)
public final class SrvMonSysMemoryStats
extends Object
implements com.neeve.xbuf.IXbufDesyncer, UtlPool.Item<SrvMonSysMemoryStats>, ISrvMonSysMemoryStats

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

Nested Class Summary

static class	SrvMonSysMemoryStats.Field The SrvMonSysMemoryStats xbuf field (used internally when this entity is used as a field of another entity).
static class	SrvMonSysMemoryStats.ListField The SrvMonSysMemoryStats list field (used internally when this entity is used as an array field of another entity).

Field Summary

static SrvMonSysMemoryStats[]

EMPTY_ARRAY A preallocated empty array used to avoid garbage when returning empty arrays of this type.

Constructor Summary

SrvMonSysMemoryStats()

SrvMonSysMemoryStats(int initialBackingBufferSize)

Method Summary

SrvMonSysMemoryStats	acquire()
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	clearContent()
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.
void	clearXRogType()
Object	clone() Creates a clone of this object.
SrvMonSysMemoryStats	copy() Creates a copy of this SrvMonSysMemoryStats.
void	copyInto(SrvMonSysMemoryStats copy) Copies the contents of this SrvMonSysMemoryStats into the target.
static SrvMonSysMemoryStats	create()
static SrvMonSysMemoryStats	createFrom(byte[] serializedContainer)
static SrvMonSysMemoryStats	createFrom(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
static SrvMonSysMemoryStats	createFromSerializedXbufContainer(byte[] serializedContainer)
static SrvMonSysMemoryStats	createFromSerializedXbufContainer(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
static com.neeve.xbuf.XbufSchema	createSchema()
SrvMonSysMemoryStats	deserializeFromByteArray(byte[] array)
SrvMonSysMemoryStats	deserializeFromByteArray(byte[] array, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonSysMemoryStats	deserializeFromByteBuffer(ByteBuffer buffer)
SrvMonSysMemoryStats	deserializeFromByteBuffer(ByteBuffer buffer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonSysMemoryStats	deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length)
SrvMonSysMemoryStats	deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonSysMemoryStats	deserializeFromNative(long address, int offset, int length)
SrvMonSysMemoryStats	deserializeFromNative(long address, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
int	desync(PktBuffer buffer, int pos, boolean frameOnly)
void	desyncFieldBitmask()
void	dispose()
PktBuffer	getBackingBuffer()
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.
com.neeve.xbuf.XbufVariableLongField	getCommittedVirtualMemorySizeField()
static int	getCommittedVirtualMemorySizeFieldId() Get the field id for 'committedVirtualMemorySize' This method can be used to set field interests.
static com.neeve.xbuf.XbufDesyncPolicy	getDesyncPolicy()
long	getFreePhysicalMemorySize() Gets the value of 'freePhysicalMemorySize' Field Description The amount of free physical memory in bytes..
com.neeve.xbuf.XbufVariableLongField	getFreePhysicalMemorySizeField()
static int	getFreePhysicalMemorySizeFieldId() Get the field id for 'freePhysicalMemorySize' This method can be used to set field interests.
long	getFreeSwapSpaceSize() Gets the value of 'freeSwapSpaceSize' Field Description The amount of free swap space in bytes.
com.neeve.xbuf.XbufVariableLongField	getFreeSwapSpaceSizeField()
static int	getFreeSwapSpaceSizeFieldId() Get the field id for 'freeSwapSpaceSize' This method can be used to set field interests.
SrvMonSysMemoryUsage	getHeapUsage() Gets the value of 'heapUsage' Field Description Holds stats about heap memory usage.
static int	getHeapUsageFieldId() Get the field id for 'heapUsage' This method can be used to set field interests.
void	getHeapUsageTo(SrvMonSysMemoryUsage to) Copies the value of SrvMonSysMemoryUsage into the provided value.
boolean	getIsReadOnly()
SrvMonSysMemoryUsage	getNonHeapUsage() Gets the value of 'nonHeapUsage' Field Description Holds stats about non heap memory usage.
static int	getNonHeapUsageFieldId() Get the field id for 'nonHeapUsage' This method can be used to set field interests.
void	getNonHeapUsageTo(SrvMonSysMemoryUsage to) Copies the value of SrvMonSysMemoryUsage into the provided value.
int	getOwnerCount()
UtlPool<SrvMonSysMemoryStats>	getPool() Get a pool item's pool.
int	getSerializeToNativeLength()
long	getTotalPhysicalMemorySize() Gets the value of 'totalPhysicalMemorySize' Field Description The total amount of physical memory in bytes.
com.neeve.xbuf.XbufVariableLongField	getTotalPhysicalMemorySizeField()
static int	getTotalPhysicalMemorySizeFieldId() Get the field id for 'totalPhysicalMemorySize' This method can be used to set field interests.
long	getTotalSwapSpaceSize() Gets the value of 'totalSwapSpaceSize' Field Description The total amount of swap space in bytes.
com.neeve.xbuf.XbufVariableLongField	getTotalSwapSpaceSizeField()
static int	getTotalSwapSpaceSizeFieldId() Get the field id for 'totalSwapSpaceSize' This method can be used to set field interests.
void	getValidationErrors(List<XString> results, String errorPrefix) Collects validation errors into the provided list.
short	getXRogType()
com.neeve.xbuf.XbufVariableShortField	getXRogTypeField()
static int	getXRogTypeFieldId() Get the field id for 'xRogType' This method can be used to set field interests.
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.
boolean	hasXRogType()
SrvMonSysMemoryStats	init() Initialize an item.
boolean	isBufferBacked()
boolean	isDirty()
boolean	isReferenceCounted()
boolean	isValid() Tests if this object has any validation errors.
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.
static void	optimizeFor(int val)
byte[]	serializeToByteArray()
ByteBuffer	serializeToByteBuffer()
com.neeve.io.IOBuffer	serializeToIOBuffer(boolean useNative)
int	serializeToNative(long address, int addressOffset)
void	setAsReadOnly()
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	setCommittedVirtualMemorySizeFrom(com.neeve.xbuf.XbufVariableLongField val)
static void	setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
static void	setFieldInterest(List<Integer> fieldIds)
void	setFreePhysicalMemorySize(long val) Sets the value of 'freePhysicalMemorySize' Field Description The amount of free physical memory in bytes..
void	setFreePhysicalMemorySizeFrom(com.neeve.xbuf.XbufVariableLongField val)
void	setFreeSwapSpaceSize(long val) Sets the value of 'freeSwapSpaceSize' Field Description The amount of free swap space in bytes.
void	setFreeSwapSpaceSizeFrom(com.neeve.xbuf.XbufVariableLongField val)
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.
SrvMonSysMemoryStats	setPool(UtlPool<SrvMonSysMemoryStats> pool) Set a pool item's pool.
void	setTotalPhysicalMemorySize(long val) Sets the value of 'totalPhysicalMemorySize' Field Description The total amount of physical memory in bytes.
void	setTotalPhysicalMemorySizeFrom(com.neeve.xbuf.XbufVariableLongField val)
void	setTotalSwapSpaceSize(long val) Sets the value of 'totalSwapSpaceSize' Field Description The total amount of swap space in bytes.
void	setTotalSwapSpaceSizeFrom(com.neeve.xbuf.XbufVariableLongField val)
void	setXRogType(short val)
void	setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)
void	sync()
void	syncFieldBitmask()
SrvMonSysMemoryUsage	takeHeapUsage() 'Takes' a reference to the heapUsage field from the message.
SrvMonSysMemoryUsage	takeNonHeapUsage() 'Takes' a reference to the nonHeapUsage field from the message.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY_ARRAY

public static final SrvMonSysMemoryStats[] EMPTY_ARRAY

A preallocated empty array used to avoid garbage when returning empty arrays of this type.

Constructor Detail

SrvMonSysMemoryStats

public SrvMonSysMemoryStats()

SrvMonSysMemoryStats

public SrvMonSysMemoryStats(int initialBackingBufferSize)

Method Detail

create

public static SrvMonSysMemoryStats create()

createFromSerializedXbufContainer

public static SrvMonSysMemoryStats createFromSerializedXbufContainer(byte[] serializedContainer,
                                                                     com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

createFromSerializedXbufContainer

public static SrvMonSysMemoryStats createFromSerializedXbufContainer(byte[] serializedContainer)

createFrom

public static SrvMonSysMemoryStats createFrom(byte[] serializedContainer,
                                              com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

createFrom

public static SrvMonSysMemoryStats createFrom(byte[] serializedContainer)

setDesyncPolicy

public static final void setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)

getDesyncPolicy

public static final com.neeve.xbuf.XbufDesyncPolicy getDesyncPolicy()

setFieldInterest

public static final void setFieldInterest(List<Integer> fieldIds)

clearContent

public final void clearContent()

syncFieldBitmask

public final void syncFieldBitmask()

desyncFieldBitmask

public final void desyncFieldBitmask()

getBackingBuffer

public final PktBuffer getBackingBuffer()

optimizeFor

public static final void optimizeFor(int val)

setAsReadOnly

public final void setAsReadOnly()

getIsReadOnly

public final boolean getIsReadOnly()

getXRogTypeFieldId

public static final int getXRogTypeFieldId()

Get the field id for 'xRogType'

This method can be used to set field interests.

See Also:

getXRogType()

setXRogType

public final void setXRogType(short val)

getXRogType

public final short getXRogType()

setXRogTypeFrom

public final void setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)

getXRogTypeField

public final com.neeve.xbuf.XbufVariableShortField getXRogTypeField()

hasXRogType

public final boolean hasXRogType()

clearXRogType

public final void clearXRogType()

getCommittedVirtualMemorySizeFieldId

public static final int getCommittedVirtualMemorySizeFieldId()

Get the field id for 'committedVirtualMemorySize'

This method can be used to set field interests.

See Also:

getCommittedVirtualMemorySize()

setCommittedVirtualMemorySize

public final void setCommittedVirtualMemorySize(long val)

Description copied from interface: ISrvMonSysMemoryStats

Sets the value of 'committedVirtualMemorySize'

Field Description

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

Specified by:

setCommittedVirtualMemorySize in interface ISrvMonSysMemoryStats

Parameters:

val - The value to set.

getCommittedVirtualMemorySize

public final long getCommittedVirtualMemorySize()

Description copied from interface: ISrvMonSysMemoryStats

Gets the value of 'committedVirtualMemorySize'

Field Description

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

Specified by:

getCommittedVirtualMemorySize in interface ISrvMonSysMemoryStats

Returns:

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

setCommittedVirtualMemorySizeFrom

public final void setCommittedVirtualMemorySizeFrom(com.neeve.xbuf.XbufVariableLongField val)

getCommittedVirtualMemorySizeField

public final com.neeve.xbuf.XbufVariableLongField getCommittedVirtualMemorySizeField()

hasCommittedVirtualMemorySize

public final boolean hasCommittedVirtualMemorySize()

Description copied from interface: ISrvMonSysMemoryStats

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.

Specified by:

hasCommittedVirtualMemorySize in interface ISrvMonSysMemoryStats

See Also:

ISrvMonSysMemoryStats.getCommittedVirtualMemorySize()

clearCommittedVirtualMemorySize

public final void clearCommittedVirtualMemorySize()

Description copied from interface: ISrvMonSysMemoryStats

Clears the value of 'committedVirtualMemorySize'

Field Description

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

Specified by:

clearCommittedVirtualMemorySize in interface ISrvMonSysMemoryStats

See Also:

ISrvMonSysMemoryStats.setCommittedVirtualMemorySize(long)

getFreePhysicalMemorySizeFieldId

public static final int getFreePhysicalMemorySizeFieldId()

Get the field id for 'freePhysicalMemorySize'

This method can be used to set field interests.

See Also:

getFreePhysicalMemorySize()

setFreePhysicalMemorySize

public final void setFreePhysicalMemorySize(long val)

Description copied from interface: ISrvMonSysMemoryStats

Sets the value of 'freePhysicalMemorySize'

Field Description

The amount of free physical memory in bytes..

Specified by:

setFreePhysicalMemorySize in interface ISrvMonSysMemoryStats

Parameters:

val - The value to set.

getFreePhysicalMemorySize

public final long getFreePhysicalMemorySize()

Description copied from interface: ISrvMonSysMemoryStats

Gets the value of 'freePhysicalMemorySize'

Field Description

The amount of free physical memory in bytes..

Specified by:

getFreePhysicalMemorySize in interface ISrvMonSysMemoryStats

Returns:

The amount of free physical memory in bytes..

setFreePhysicalMemorySizeFrom

public final void setFreePhysicalMemorySizeFrom(com.neeve.xbuf.XbufVariableLongField val)

getFreePhysicalMemorySizeField

public final com.neeve.xbuf.XbufVariableLongField getFreePhysicalMemorySizeField()

hasFreePhysicalMemorySize

public final boolean hasFreePhysicalMemorySize()

Description copied from interface: ISrvMonSysMemoryStats

Checks for the presence of 'freePhysicalMemorySize'

Field Description

The amount of free physical memory in bytes..

Specified by:

hasFreePhysicalMemorySize in interface ISrvMonSysMemoryStats

See Also:

ISrvMonSysMemoryStats.getFreePhysicalMemorySize()

clearFreePhysicalMemorySize

public final void clearFreePhysicalMemorySize()

Description copied from interface: ISrvMonSysMemoryStats

Clears the value of 'freePhysicalMemorySize'

Field Description

The amount of free physical memory in bytes..

Specified by:

clearFreePhysicalMemorySize in interface ISrvMonSysMemoryStats

See Also:

ISrvMonSysMemoryStats.setFreePhysicalMemorySize(long)

getFreeSwapSpaceSizeFieldId

public static final int getFreeSwapSpaceSizeFieldId()

Get the field id for 'freeSwapSpaceSize'

This method can be used to set field interests.

See Also:

getFreeSwapSpaceSize()

setFreeSwapSpaceSize

public final void setFreeSwapSpaceSize(long val)

Description copied from interface: ISrvMonSysMemoryStats

Sets the value of 'freeSwapSpaceSize'

Field Description

The amount of free swap space in bytes.

Specified by:

setFreeSwapSpaceSize in interface ISrvMonSysMemoryStats

Parameters:

val - The value to set.

getFreeSwapSpaceSize

public final long getFreeSwapSpaceSize()

Description copied from interface: ISrvMonSysMemoryStats

Gets the value of 'freeSwapSpaceSize'

Field Description

The amount of free swap space in bytes.

Specified by:

getFreeSwapSpaceSize in interface ISrvMonSysMemoryStats

Returns:

The amount of free swap space in bytes.

setFreeSwapSpaceSizeFrom

public final void setFreeSwapSpaceSizeFrom(com.neeve.xbuf.XbufVariableLongField val)

getFreeSwapSpaceSizeField

public final com.neeve.xbuf.XbufVariableLongField getFreeSwapSpaceSizeField()

hasFreeSwapSpaceSize

public final boolean hasFreeSwapSpaceSize()

Description copied from interface: ISrvMonSysMemoryStats

Checks for the presence of 'freeSwapSpaceSize'

Field Description

The amount of free swap space in bytes.

Specified by:

hasFreeSwapSpaceSize in interface ISrvMonSysMemoryStats

See Also:

ISrvMonSysMemoryStats.getFreeSwapSpaceSize()

clearFreeSwapSpaceSize

public final void clearFreeSwapSpaceSize()

Description copied from interface: ISrvMonSysMemoryStats

Clears the value of 'freeSwapSpaceSize'

Field Description

The amount of free swap space in bytes.

Specified by:

clearFreeSwapSpaceSize in interface ISrvMonSysMemoryStats

See Also:

ISrvMonSysMemoryStats.setFreeSwapSpaceSize(long)

getTotalPhysicalMemorySizeFieldId

public static final int getTotalPhysicalMemorySizeFieldId()

Get the field id for 'totalPhysicalMemorySize'

This method can be used to set field interests.

See Also:

getTotalPhysicalMemorySize()

setTotalPhysicalMemorySize

public final void setTotalPhysicalMemorySize(long val)

Description copied from interface: ISrvMonSysMemoryStats

Sets the value of 'totalPhysicalMemorySize'

Field Description

The total amount of physical memory in bytes.

Specified by:

setTotalPhysicalMemorySize in interface ISrvMonSysMemoryStats

Parameters:

val - The value to set.

getTotalPhysicalMemorySize

public final long getTotalPhysicalMemorySize()

Description copied from interface: ISrvMonSysMemoryStats

Gets the value of 'totalPhysicalMemorySize'

Field Description

The total amount of physical memory in bytes.

Specified by:

getTotalPhysicalMemorySize in interface ISrvMonSysMemoryStats

Returns:

The total amount of physical memory in bytes.

setTotalPhysicalMemorySizeFrom

public final void setTotalPhysicalMemorySizeFrom(com.neeve.xbuf.XbufVariableLongField val)

getTotalPhysicalMemorySizeField

public final com.neeve.xbuf.XbufVariableLongField getTotalPhysicalMemorySizeField()

hasTotalPhysicalMemorySize

public final boolean hasTotalPhysicalMemorySize()

Description copied from interface: ISrvMonSysMemoryStats

Checks for the presence of 'totalPhysicalMemorySize'

Field Description

The total amount of physical memory in bytes.

Specified by:

hasTotalPhysicalMemorySize in interface ISrvMonSysMemoryStats

See Also:

ISrvMonSysMemoryStats.getTotalPhysicalMemorySize()

clearTotalPhysicalMemorySize

public final void clearTotalPhysicalMemorySize()

Description copied from interface: ISrvMonSysMemoryStats

Clears the value of 'totalPhysicalMemorySize'

Field Description

The total amount of physical memory in bytes.

Specified by:

clearTotalPhysicalMemorySize in interface ISrvMonSysMemoryStats

See Also:

ISrvMonSysMemoryStats.setTotalPhysicalMemorySize(long)

getTotalSwapSpaceSizeFieldId

public static final int getTotalSwapSpaceSizeFieldId()

Get the field id for 'totalSwapSpaceSize'

This method can be used to set field interests.

See Also:

getTotalSwapSpaceSize()

setTotalSwapSpaceSize

public final void setTotalSwapSpaceSize(long val)

Description copied from interface: ISrvMonSysMemoryStats

Sets the value of 'totalSwapSpaceSize'

Field Description

The total amount of swap space in bytes.

Specified by:

setTotalSwapSpaceSize in interface ISrvMonSysMemoryStats

Parameters:

val - The value to set.

getTotalSwapSpaceSize

public final long getTotalSwapSpaceSize()

Description copied from interface: ISrvMonSysMemoryStats

Gets the value of 'totalSwapSpaceSize'

Field Description

The total amount of swap space in bytes.

Specified by:

getTotalSwapSpaceSize in interface ISrvMonSysMemoryStats

Returns:

The total amount of swap space in bytes.

setTotalSwapSpaceSizeFrom

public final void setTotalSwapSpaceSizeFrom(com.neeve.xbuf.XbufVariableLongField val)

getTotalSwapSpaceSizeField

public final com.neeve.xbuf.XbufVariableLongField getTotalSwapSpaceSizeField()

hasTotalSwapSpaceSize

public final boolean hasTotalSwapSpaceSize()

Description copied from interface: ISrvMonSysMemoryStats

Checks for the presence of 'totalSwapSpaceSize'

Field Description

The total amount of swap space in bytes.

Specified by:

hasTotalSwapSpaceSize in interface ISrvMonSysMemoryStats

See Also:

ISrvMonSysMemoryStats.getTotalSwapSpaceSize()

clearTotalSwapSpaceSize

public final void clearTotalSwapSpaceSize()

Description copied from interface: ISrvMonSysMemoryStats

Clears the value of 'totalSwapSpaceSize'

Field Description

The total amount of swap space in bytes.

Specified by:

clearTotalSwapSpaceSize in interface ISrvMonSysMemoryStats

See Also:

ISrvMonSysMemoryStats.setTotalSwapSpaceSize(long)

getHeapUsageFieldId

public static final int getHeapUsageFieldId()

Get the field id for 'heapUsage'

This method can be used to set field interests.

See Also:

getHeapUsage()

setHeapUsage

public final void setHeapUsage(SrvMonSysMemoryUsage val)

Description copied from interface: ISrvMonSysMemoryStats

Sets the value of 'heapUsage'

Field Description

Holds stats about heap memory usage.

Specified by:

setHeapUsage in interface ISrvMonSysMemoryStats

Parameters:

val - The value to set.

lendHeapUsage

public final void lendHeapUsage(SrvMonSysMemoryUsage val)

Description copied from interface: ISrvMonSysMemoryStats

'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.

Specified by:

lendHeapUsage in interface ISrvMonSysMemoryStats

Parameters:

val - the value to 'lend' to lend.

getHeapUsage

public final SrvMonSysMemoryUsage getHeapUsage()

Description copied from interface: ISrvMonSysMemoryStats

Gets the value of 'heapUsage'

Field Description

Holds stats about heap memory usage.

Specified by:

getHeapUsage in interface ISrvMonSysMemoryStats

Returns:

Holds stats about heap memory usage.

getHeapUsageTo

public final void getHeapUsageTo(SrvMonSysMemoryUsage to)

Description copied from interface: ISrvMonSysMemoryStats

Copies the value of SrvMonSysMemoryUsage into the provided value.

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

Specified by:

getHeapUsageTo in interface ISrvMonSysMemoryStats

Parameters:

to - the value to copy into

See Also:

SrvMonSysMemoryUsage.copyInto(SrvMonSysMemoryUsage)

takeHeapUsage

public final SrvMonSysMemoryUsage takeHeapUsage()

Description copied from interface: ISrvMonSysMemoryStats

'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.

Specified by:

takeHeapUsage in interface ISrvMonSysMemoryStats

Returns:

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

hasHeapUsage

public final boolean hasHeapUsage()

Description copied from interface: ISrvMonSysMemoryStats

Checks for the presence of 'heapUsage'

Field Description

Holds stats about heap memory usage.

Specified by:

hasHeapUsage in interface ISrvMonSysMemoryStats

See Also:

ISrvMonSysMemoryStats.getHeapUsage()

clearHeapUsage

public final void clearHeapUsage()

Description copied from interface: ISrvMonSysMemoryStats

Clears the value of 'heapUsage'

Field Description

Holds stats about heap memory usage.

Specified by:

clearHeapUsage in interface ISrvMonSysMemoryStats

See Also:

ISrvMonSysMemoryStats.setHeapUsage(SrvMonSysMemoryUsage)

getNonHeapUsageFieldId

public static final int getNonHeapUsageFieldId()

Get the field id for 'nonHeapUsage'

This method can be used to set field interests.

See Also:

getNonHeapUsage()

setNonHeapUsage

public final void setNonHeapUsage(SrvMonSysMemoryUsage val)

Description copied from interface: ISrvMonSysMemoryStats

Sets the value of 'nonHeapUsage'

Field Description

Holds stats about non heap memory usage.

Specified by:

setNonHeapUsage in interface ISrvMonSysMemoryStats

Parameters:

val - The value to set.

lendNonHeapUsage

public final void lendNonHeapUsage(SrvMonSysMemoryUsage val)

Description copied from interface: ISrvMonSysMemoryStats

'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.

Specified by:

lendNonHeapUsage in interface ISrvMonSysMemoryStats

Parameters:

val - the value to 'lend' to lend.

getNonHeapUsage

public final SrvMonSysMemoryUsage getNonHeapUsage()

Description copied from interface: ISrvMonSysMemoryStats

Gets the value of 'nonHeapUsage'

Field Description

Holds stats about non heap memory usage.

Specified by:

getNonHeapUsage in interface ISrvMonSysMemoryStats

Returns:

Holds stats about non heap memory usage.

getNonHeapUsageTo

public final void getNonHeapUsageTo(SrvMonSysMemoryUsage to)

Description copied from interface: ISrvMonSysMemoryStats

Copies the value of SrvMonSysMemoryUsage into the provided value.

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

Specified by:

getNonHeapUsageTo in interface ISrvMonSysMemoryStats

Parameters:

to - the value to copy into

See Also:

SrvMonSysMemoryUsage.copyInto(SrvMonSysMemoryUsage)

takeNonHeapUsage

public final SrvMonSysMemoryUsage takeNonHeapUsage()

Description copied from interface: ISrvMonSysMemoryStats

'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.

Specified by:

takeNonHeapUsage in interface ISrvMonSysMemoryStats

Returns:

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

hasNonHeapUsage

public final boolean hasNonHeapUsage()

Description copied from interface: ISrvMonSysMemoryStats

Checks for the presence of 'nonHeapUsage'

Field Description

Holds stats about non heap memory usage.

Specified by:

hasNonHeapUsage in interface ISrvMonSysMemoryStats

See Also:

ISrvMonSysMemoryStats.getNonHeapUsage()

clearNonHeapUsage

public final void clearNonHeapUsage()

Description copied from interface: ISrvMonSysMemoryStats

Clears the value of 'nonHeapUsage'

Field Description

Holds stats about non heap memory usage.

Specified by:

clearNonHeapUsage in interface ISrvMonSysMemoryStats

See Also:

ISrvMonSysMemoryStats.setNonHeapUsage(SrvMonSysMemoryUsage)

isDirty

public final boolean isDirty()

createSchema

public static final com.neeve.xbuf.XbufSchema createSchema()

serializeToByteArray

public final byte[] serializeToByteArray()

serializeToByteBuffer

public final ByteBuffer serializeToByteBuffer()

serializeToIOBuffer

public final com.neeve.io.IOBuffer serializeToIOBuffer(boolean useNative)

isBufferBacked

public final boolean isBufferBacked()

getSerializeToNativeLength

public final int getSerializeToNativeLength()

serializeToNative

public final int serializeToNative(long address,
                                   int addressOffset)

deserializeFromIOElasticBuffer

public final SrvMonSysMemoryStats deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
                                                                 int offset,
                                                                 int length,
                                                                 com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

deserializeFromIOElasticBuffer

public final SrvMonSysMemoryStats deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
                                                                 int offset,
                                                                 int length)

deserializeFromByteArray

public final SrvMonSysMemoryStats deserializeFromByteArray(byte[] array,
                                                           com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

deserializeFromByteArray

public final SrvMonSysMemoryStats deserializeFromByteArray(byte[] array)

deserializeFromByteBuffer

public final SrvMonSysMemoryStats deserializeFromByteBuffer(ByteBuffer buffer,
                                                            com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

deserializeFromByteBuffer

public final SrvMonSysMemoryStats deserializeFromByteBuffer(ByteBuffer buffer)

deserializeFromNative

public final SrvMonSysMemoryStats deserializeFromNative(long address,
                                                        int offset,
                                                        int length,
                                                        com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

deserializeFromNative

public final SrvMonSysMemoryStats deserializeFromNative(long address,
                                                        int offset,
                                                        int length)

sync

public final void sync()

desync

public final int desync(PktBuffer buffer,
                        int pos,
                        boolean frameOnly)

Specified by:

desync in interface com.neeve.xbuf.IXbufDesyncer

init

public final SrvMonSysMemoryStats init()

Description copied from interface: UtlPool.Item

Initialize an item.

This method is invoked by an item pool very time an item is put into the pool. The method should wipe the contents of the item so as to present a fresh instance of the item to the caller when retrieved from the pool.

Specified by:

init in interface UtlPool.Item<SrvMonSysMemoryStats>

Returns:

Return 'this' object for method invocation chaining.

setPool

public final SrvMonSysMemoryStats setPool(UtlPool<SrvMonSysMemoryStats> pool)

Description copied from interface: UtlPool.Item

Set a pool item's pool.

This method is invoked by an item pool at the time an item is added to the pool. The intent is to record the item's source pool in the item so it can be disposed back into the pool when the user is done working with it.

Specified by:

setPool in interface UtlPool.Item<SrvMonSysMemoryStats>

Returns:

Return 'this' object for method invocation chaining.

getPool

public final UtlPool<SrvMonSysMemoryStats> getPool()

Description copied from interface: UtlPool.Item

Get a pool item's pool.

This method should return the pool set using UtlPool.Item.setPool(com.neeve.util.UtlPool)

Specified by:

getPool in interface UtlPool.Item<SrvMonSysMemoryStats>

Returns:

the pool set using UtlPool.Item.setPool(com.neeve.util.UtlPool)

isReferenceCounted

public final boolean isReferenceCounted()

acquire

public final SrvMonSysMemoryStats acquire()

getOwnerCount

public final int getOwnerCount()

dispose

public final void dispose()

clone

public final Object clone()

Creates a clone of this object.

This method differs from the copy() method in that:

• For protobuf and xbuf generated objects pass-through fields are not preserved. Pass through fields are fields not defined by ADM model that generated this class, but may exist in the backing buffer or protobuf message for the object.
• The copy method may replace empty arrays with a null value whereas this method preserves empty array fields.

Overrides:

clone in class Object

copy

public final SrvMonSysMemoryStats copy()

Creates a copy of this SrvMonSysMemoryStats.

The copy copies primitive, enum and embedded entity fields into the returned copy. Each embedded entity field is cloned so that modifications made to the copy's embedded entity fields do not affect this SrvMonSysMemoryStats's embedded entity fields.

The returned copy will be writeable even if this SrvMonSysMemoryStats is read only.

Xbuf Pass-through Fields

When backed by a buffer, this operation copies the underlying buffer which means that if the message was deserialized from with unrecognized fields, such fields will be preserved in the copy as well.

Returns:

The copied entity.

copyInto

public final void copyInto(SrvMonSysMemoryStats copy)

Copies the contents of this SrvMonSysMemoryStats into the target.

The copy clears the target's contents and copies primitive, enum and embedded entity fields into the provided copy. Each embedded entity field is cloned so that modifications made to the copy's embedded entity fields do not affect this SrvMonSysMemoryStats's embedded entity fields.

The returned copy will be writeable even if this SrvMonSysMemoryStats is read only.

Xbuf Pass-through Fields

When backed by a buffer, this operation copies the underlying buffer which means that if the message was deserialized from with unrecognized fields, such fields will be preserved in the copy as well.

Parameters:

copy - The target into which to copy.

isValid

public final boolean isValid()

Description copied from interface: IRogValidatable

Tests if this object has any validation errors.

Specified by:

isValid in interface IRogValidatable

getValidationErrors

public final void getValidationErrors(List<XString> results,
                                      String errorPrefix)

Description copied from interface: IRogValidatable

Collects validation errors into the provided list. It is illegal for the caller to hold onto the List of XStrings beyond the lifespace of this object.

Specified by:

getValidationErrors in interface IRogValidatable

Parameters:

results - A results list into which validation errors will be collected.

errorPrefix - The bean path prefix to use when identifying invalid fields or null if validating a top level entity.

toString

public final String toString()

Overrides:

toString in class Object