com.neeve.server.mon
Class SrvMonSysMemoryUsage

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

All Implemented Interfaces:

IRogValidatable, ISrvMonSysMemoryUsage, UtlPool.Item<SrvMonSysMemoryUsage>, 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=213)
public final class SrvMonSysMemoryUsage
extends Object
implements com.neeve.xbuf.IXbufDesyncer, UtlPool.Item<SrvMonSysMemoryUsage>, ISrvMonSysMemoryUsage

Holds stats for a portion a JVM memory region.

Nested Class Summary

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

Field Summary

static SrvMonSysMemoryUsage[]

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

Constructor Summary

SrvMonSysMemoryUsage()

SrvMonSysMemoryUsage(int initialBackingBufferSize)

Method Summary

SrvMonSysMemoryUsage	acquire()
void	clearCommitted() Clears the value of 'committed' Field Description The amount of memory in bytes that is committed for the Java virtual machine to use.
void	clearContent()
void	clearInit() Clears the value of 'init' Field Description The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.
void	clearMax() Clears the value of 'max' Field Description The max amount of memory used in bytes.
void	clearUsed() Clears the value of 'used' Field Description The amount of used memory in bytes.
void	clearXRogType()
Object	clone() Creates a clone of this object.
SrvMonSysMemoryUsage	copy() Creates a copy of this SrvMonSysMemoryUsage.
void	copyInto(SrvMonSysMemoryUsage copy) Copies the contents of this SrvMonSysMemoryUsage into the target.
static SrvMonSysMemoryUsage	create()
static SrvMonSysMemoryUsage	createFrom(byte[] serializedContainer)
static SrvMonSysMemoryUsage	createFrom(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
static SrvMonSysMemoryUsage	createFromSerializedXbufContainer(byte[] serializedContainer)
static SrvMonSysMemoryUsage	createFromSerializedXbufContainer(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
static com.neeve.xbuf.XbufSchema	createSchema()
SrvMonSysMemoryUsage	deserializeFromByteArray(byte[] array)
SrvMonSysMemoryUsage	deserializeFromByteArray(byte[] array, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonSysMemoryUsage	deserializeFromByteBuffer(ByteBuffer buffer)
SrvMonSysMemoryUsage	deserializeFromByteBuffer(ByteBuffer buffer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonSysMemoryUsage	deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length)
SrvMonSysMemoryUsage	deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonSysMemoryUsage	deserializeFromNative(long address, int offset, int length)
SrvMonSysMemoryUsage	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	getCommitted() Gets the value of 'committed' Field Description The amount of memory in bytes that is committed for the Java virtual machine to use.
com.neeve.xbuf.XbufVariableLongField	getCommittedField()
static int	getCommittedFieldId() Get the field id for 'committed' This method can be used to set field interests.
static com.neeve.xbuf.XbufDesyncPolicy	getDesyncPolicy()
long	getInit() Gets the value of 'init' Field Description The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.
com.neeve.xbuf.XbufVariableLongField	getInitField()
static int	getInitFieldId() Get the field id for 'init' This method can be used to set field interests.
boolean	getIsReadOnly()
long	getMax() Gets the value of 'max' Field Description The max amount of memory used in bytes.
com.neeve.xbuf.XbufVariableLongField	getMaxField()
static int	getMaxFieldId() Get the field id for 'max' This method can be used to set field interests.
int	getOwnerCount()
UtlPool<SrvMonSysMemoryUsage>	getPool() Get a pool item's pool.
int	getSerializeToNativeLength()
long	getUsed() Gets the value of 'used' Field Description The amount of used memory in bytes.
com.neeve.xbuf.XbufVariableLongField	getUsedField()
static int	getUsedFieldId() Get the field id for 'used' 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	hasCommitted() Checks for the presence of 'committed' Field Description The amount of memory in bytes that is committed for the Java virtual machine to use.
boolean	hasInit() Checks for the presence of 'init' Field Description The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.
boolean	hasMax() Checks for the presence of 'max' Field Description The max amount of memory used in bytes.
boolean	hasUsed() Checks for the presence of 'used' Field Description The amount of used memory in bytes.
boolean	hasXRogType()
SrvMonSysMemoryUsage	init() Initialize an item.
boolean	isBufferBacked()
boolean	isDirty()
boolean	isReferenceCounted()
boolean	isValid() Tests if this object has any validation errors.
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	setCommitted(long val) Sets the value of 'committed' Field Description The amount of memory in bytes that is committed for the Java virtual machine to use.
void	setCommittedFrom(com.neeve.xbuf.XbufVariableLongField val)
static void	setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
static void	setFieldInterest(List<Integer> fieldIds)
void	setInit(long val) Sets the value of 'init' Field Description The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.
void	setInitFrom(com.neeve.xbuf.XbufVariableLongField val)
void	setMax(long val) Sets the value of 'max' Field Description The max amount of memory used in bytes.
void	setMaxFrom(com.neeve.xbuf.XbufVariableLongField val)
SrvMonSysMemoryUsage	setPool(UtlPool<SrvMonSysMemoryUsage> pool) Set a pool item's pool.
void	setUsed(long val) Sets the value of 'used' Field Description The amount of used memory in bytes.
void	setUsedFrom(com.neeve.xbuf.XbufVariableLongField val)
void	setXRogType(short val)
void	setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)
void	sync()
void	syncFieldBitmask()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_ARRAY

public static final SrvMonSysMemoryUsage[] EMPTY_ARRAY

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

Constructor Detail

SrvMonSysMemoryUsage

public SrvMonSysMemoryUsage()

SrvMonSysMemoryUsage

public SrvMonSysMemoryUsage(int initialBackingBufferSize)

Method Detail

create

public static SrvMonSysMemoryUsage create()

createFromSerializedXbufContainer

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

createFromSerializedXbufContainer

public static SrvMonSysMemoryUsage createFromSerializedXbufContainer(byte[] serializedContainer)

createFrom

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

createFrom

public static SrvMonSysMemoryUsage 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()

getInitFieldId

public static final int getInitFieldId()

Get the field id for 'init'

This method can be used to set field interests.

See Also:

getInit()

setInit

public final void setInit(long val)

Description copied from interface: ISrvMonSysMemoryUsage

Sets the value of 'init'

Field Description

The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.

A value of -1 indicates that the initial memory size is undefined.

Specified by:

setInit in interface ISrvMonSysMemoryUsage

Parameters:

val - The value to set.

getInit

public final long getInit()

Description copied from interface: ISrvMonSysMemoryUsage

Gets the value of 'init'

Field Description

The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.

A value of -1 indicates that the initial memory size is undefined.

Specified by:

getInit in interface ISrvMonSysMemoryUsage

Returns:

The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.

setInitFrom

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

getInitField

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

hasInit

public final boolean hasInit()

Description copied from interface: ISrvMonSysMemoryUsage

Checks for the presence of 'init'

Field Description

The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.

A value of -1 indicates that the initial memory size is undefined.

Specified by:

hasInit in interface ISrvMonSysMemoryUsage

See Also:

ISrvMonSysMemoryUsage.getInit()

clearInit

public final void clearInit()

Description copied from interface: ISrvMonSysMemoryUsage

Clears the value of 'init'

Field Description

The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.

A value of -1 indicates that the initial memory size is undefined.

Specified by:

clearInit in interface ISrvMonSysMemoryUsage

See Also:

ISrvMonSysMemoryUsage.setInit(long)

getUsedFieldId

public static final int getUsedFieldId()

Get the field id for 'used'

This method can be used to set field interests.

See Also:

getUsed()

setUsed

public final void setUsed(long val)

Description copied from interface: ISrvMonSysMemoryUsage

Sets the value of 'used'

Field Description

The amount of used memory in bytes.

Specified by:

setUsed in interface ISrvMonSysMemoryUsage

Parameters:

val - The value to set.

getUsed

public final long getUsed()

Description copied from interface: ISrvMonSysMemoryUsage

Gets the value of 'used'

Field Description

The amount of used memory in bytes.

Specified by:

getUsed in interface ISrvMonSysMemoryUsage

Returns:

The amount of used memory in bytes.

setUsedFrom

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

getUsedField

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

hasUsed

public final boolean hasUsed()

Description copied from interface: ISrvMonSysMemoryUsage

Checks for the presence of 'used'

Field Description

The amount of used memory in bytes.

Specified by:

hasUsed in interface ISrvMonSysMemoryUsage

See Also:

ISrvMonSysMemoryUsage.getUsed()

clearUsed

public final void clearUsed()

Description copied from interface: ISrvMonSysMemoryUsage

Clears the value of 'used'

Field Description

The amount of used memory in bytes.

Specified by:

clearUsed in interface ISrvMonSysMemoryUsage

See Also:

ISrvMonSysMemoryUsage.setUsed(long)

getCommittedFieldId

public static final int getCommittedFieldId()

Get the field id for 'committed'

This method can be used to set field interests.

See Also:

getCommitted()

setCommitted

public final void setCommitted(long val)

Description copied from interface: ISrvMonSysMemoryUsage

Sets the value of 'committed'

Field Description

The amount of memory in bytes that is committed for the Java virtual machine to use.

This amount of memory is guaranteed for the Java virtual machine to use.

Specified by:

setCommitted in interface ISrvMonSysMemoryUsage

Parameters:

val - The value to set.

getCommitted

public final long getCommitted()

Description copied from interface: ISrvMonSysMemoryUsage

Gets the value of 'committed'

Field Description

The amount of memory in bytes that is committed for the Java virtual machine to use.

This amount of memory is guaranteed for the Java virtual machine to use.

Specified by:

getCommitted in interface ISrvMonSysMemoryUsage

Returns:

the amount of memory in bytes that is committed for the Java virtual machine to use.

setCommittedFrom

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

getCommittedField

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

hasCommitted

public final boolean hasCommitted()

Description copied from interface: ISrvMonSysMemoryUsage

Checks for the presence of 'committed'

Field Description

The amount of memory in bytes that is committed for the Java virtual machine to use.

This amount of memory is guaranteed for the Java virtual machine to use.

Specified by:

hasCommitted in interface ISrvMonSysMemoryUsage

See Also:

ISrvMonSysMemoryUsage.getCommitted()

clearCommitted

public final void clearCommitted()

Description copied from interface: ISrvMonSysMemoryUsage

Clears the value of 'committed'

Field Description

The amount of memory in bytes that is committed for the Java virtual machine to use.

This amount of memory is guaranteed for the Java virtual machine to use.

Specified by:

clearCommitted in interface ISrvMonSysMemoryUsage

See Also:

ISrvMonSysMemoryUsage.setCommitted(long)

getMaxFieldId

public static final int getMaxFieldId()

Get the field id for 'max'

This method can be used to set field interests.

See Also:

getMax()

setMax

public final void setMax(long val)

Description copied from interface: ISrvMonSysMemoryUsage

Sets the value of 'max'

Field Description

The max amount of memory used in bytes.

Specified by:

setMax in interface ISrvMonSysMemoryUsage

Parameters:

val - The value to set.

getMax

public final long getMax()

Description copied from interface: ISrvMonSysMemoryUsage

Gets the value of 'max'

Field Description

The max amount of memory used in bytes.

Specified by:

getMax in interface ISrvMonSysMemoryUsage

Returns:

The max amount of memory used in bytes.

setMaxFrom

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

getMaxField

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

hasMax

public final boolean hasMax()

Description copied from interface: ISrvMonSysMemoryUsage

Checks for the presence of 'max'

Field Description

The max amount of memory used in bytes.

Specified by:

hasMax in interface ISrvMonSysMemoryUsage

See Also:

ISrvMonSysMemoryUsage.getMax()

clearMax

public final void clearMax()

Description copied from interface: ISrvMonSysMemoryUsage

Clears the value of 'max'

Field Description

The max amount of memory used in bytes.

Specified by:

clearMax in interface ISrvMonSysMemoryUsage

See Also:

ISrvMonSysMemoryUsage.setMax(long)

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 SrvMonSysMemoryUsage deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
                                                                 int offset,
                                                                 int length,
                                                                 com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

deserializeFromIOElasticBuffer

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

deserializeFromByteArray

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

deserializeFromByteArray

public final SrvMonSysMemoryUsage deserializeFromByteArray(byte[] array)

deserializeFromByteBuffer

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

deserializeFromByteBuffer

public final SrvMonSysMemoryUsage deserializeFromByteBuffer(ByteBuffer buffer)

deserializeFromNative

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

deserializeFromNative

public final SrvMonSysMemoryUsage 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 SrvMonSysMemoryUsage 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<SrvMonSysMemoryUsage>

Returns:

Return 'this' object for method invocation chaining.

setPool

public final SrvMonSysMemoryUsage setPool(UtlPool<SrvMonSysMemoryUsage> 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<SrvMonSysMemoryUsage>

Returns:

Return 'this' object for method invocation chaining.

getPool

public final UtlPool<SrvMonSysMemoryUsage> 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<SrvMonSysMemoryUsage>

Returns:

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

isReferenceCounted

public final boolean isReferenceCounted()

acquire

public final SrvMonSysMemoryUsage 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 SrvMonSysMemoryUsage copy()

Creates a copy of this SrvMonSysMemoryUsage.

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 SrvMonSysMemoryUsage's embedded entity fields.

The returned copy will be writeable even if this SrvMonSysMemoryUsage 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(SrvMonSysMemoryUsage copy)

Copies the contents of this SrvMonSysMemoryUsage 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 SrvMonSysMemoryUsage's embedded entity fields.

The returned copy will be writeable even if this SrvMonSysMemoryUsage 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