|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.neeve.server.mon.SrvMonSysGCStats
@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=214) public final class SrvMonSysGCStats
Groups together stats related to the JVM garbage collections.
Nested Class Summary | |
---|---|
static class |
SrvMonSysGCStats.Field
The SrvMonSysGCStats xbuf field (used internally when this entity is used as a field of another entity). |
static class |
SrvMonSysGCStats.ListField
The SrvMonSysGCStats list field (used internally when this entity is used as an array field of another entity). |
Field Summary | |
---|---|
static SrvMonSysGCStats[] |
EMPTY_ARRAY
A preallocated empty array used to avoid garbage when returning empty arrays of this type. |
Constructor Summary | |
---|---|
SrvMonSysGCStats()
|
|
SrvMonSysGCStats(int initialBackingBufferSize)
|
Method Summary | |
---|---|
SrvMonSysGCStats |
acquire()
|
void |
addCollectorsStats(SrvMonSysGCCollectorStats val)
Adds the provided value to the list of 'collectorsStats' values. |
void |
clearCollectorsStats()
Clears the value of 'collectorsStats' Field Description The list of garbage collections that have occurred. |
void |
clearContent()
|
void |
clearXRogType()
|
Object |
clone()
Creates a clone of this object. |
SrvMonSysGCStats |
copy()
Creates a copy of this SrvMonSysGCStats. |
void |
copyInto(SrvMonSysGCStats copy)
Copies the contents of this SrvMonSysGCStats into the target. |
static SrvMonSysGCStats |
create()
|
static SrvMonSysGCStats |
createFrom(byte[] serializedContainer)
|
static SrvMonSysGCStats |
createFrom(byte[] serializedContainer,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
|
static SrvMonSysGCStats |
createFromSerializedXbufContainer(byte[] serializedContainer)
|
static SrvMonSysGCStats |
createFromSerializedXbufContainer(byte[] serializedContainer,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
|
static com.neeve.xbuf.XbufSchema |
createSchema()
|
SrvMonSysGCStats |
deserializeFromByteArray(byte[] array)
|
SrvMonSysGCStats |
deserializeFromByteArray(byte[] array,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
|
SrvMonSysGCStats |
deserializeFromByteBuffer(ByteBuffer buffer)
|
SrvMonSysGCStats |
deserializeFromByteBuffer(ByteBuffer buffer,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
|
SrvMonSysGCStats |
deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
int offset,
int length)
|
SrvMonSysGCStats |
deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
int offset,
int length,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
|
SrvMonSysGCStats |
deserializeFromNative(long address,
int offset,
int length)
|
SrvMonSysGCStats |
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()
|
SrvMonSysGCCollectorStats[] |
getCollectorsStats()
Gets the value of 'collectorsStats' If the field is not set this method will return null . |
SrvMonSysGCCollectorStats[] |
getCollectorsStatsEmptyIfNull()
Gets the value of 'collectorsStats' or an empty array if the value is null or not set. |
static int |
getCollectorsStatsFieldId()
Get the field id for 'collectorsStats' This method can be used to set field interests. |
XIterator<SrvMonSysGCCollectorStats> |
getCollectorsStatsIterator()
Gets the value of 'collectorsStats' as iterator of values. |
static com.neeve.xbuf.XbufDesyncPolicy |
getDesyncPolicy()
|
boolean |
getIsReadOnly()
|
int |
getOwnerCount()
|
UtlPool<SrvMonSysGCStats> |
getPool()
Get a pool item's pool. |
int |
getSerializeToNativeLength()
|
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 |
hasXRogType()
|
SrvMonSysGCStats |
init()
Initialize an item. |
boolean |
isBufferBacked()
|
boolean |
isDirty()
|
boolean |
isReferenceCounted()
|
boolean |
isValid()
Tests if this object has any validation errors. |
void |
lendCollectorsStats(SrvMonSysGCCollectorStats val)
Adds the provided value to the list of 'collectorsStats' values and acquires a reference to it. |
void |
lendCollectorsStats(SrvMonSysGCCollectorStats[] val)
Lends the value of 'collectorsStats' Field Description The list of garbage collections that have occurred. |
void |
lendCollectorsStatsFrom(XIterator<SrvMonSysGCCollectorStats> val)
Sets the value of 'collectorsStats' by lending the values from the provided iterator. |
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 |
setCollectorsStats(SrvMonSysGCCollectorStats[] val)
Sets the value of 'collectorsStats' Field Description The list of garbage collections that have occurred. |
void |
setCollectorsStatsFrom(XIterator<SrvMonSysGCCollectorStats> val)
Sets the value of 'collectorsStats' using the values from the provided iterator. |
static void |
setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
|
static void |
setFieldInterest(List<Integer> fieldIds)
|
SrvMonSysGCStats |
setPool(UtlPool<SrvMonSysGCStats> pool)
Set a pool item's pool. |
void |
setXRogType(short val)
|
void |
setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)
|
void |
sync()
|
void |
syncFieldBitmask()
|
SrvMonSysGCCollectorStats[] |
takeCollectorsStats()
Takes the value of 'collectorsStats' Field Description The list of garbage collections that have occurred. |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final SrvMonSysGCStats[] EMPTY_ARRAY
Constructor Detail |
---|
public SrvMonSysGCStats()
public SrvMonSysGCStats(int initialBackingBufferSize)
Method Detail |
---|
public static SrvMonSysGCStats create()
public static SrvMonSysGCStats createFromSerializedXbufContainer(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public static SrvMonSysGCStats createFromSerializedXbufContainer(byte[] serializedContainer)
public static SrvMonSysGCStats createFrom(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public static SrvMonSysGCStats createFrom(byte[] serializedContainer)
public static final void setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
public static final com.neeve.xbuf.XbufDesyncPolicy getDesyncPolicy()
public static final void setFieldInterest(List<Integer> fieldIds)
public final void clearContent()
public final void syncFieldBitmask()
public final void desyncFieldBitmask()
public final PktBuffer getBackingBuffer()
public static final void optimizeFor(int val)
public final void setAsReadOnly()
public final boolean getIsReadOnly()
public static final int getXRogTypeFieldId()
This method can be used to set field interests.
getXRogType()
public final void setXRogType(short val)
public final short getXRogType()
public final void setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)
public final com.neeve.xbuf.XbufVariableShortField getXRogTypeField()
public final boolean hasXRogType()
public final void clearXRogType()
public static final int getCollectorsStatsFieldId()
This method can be used to set field interests.
getCollectorsStats()
public final void setCollectorsStats(SrvMonSysGCCollectorStats[] val)
ISrvMonSysGCStats
This list will include the most recent collections that have occurred since the last heartbeat, but may also include historical garbage collections as well. The collection count field of each collection can be used to determine if two heartbeats duplicate information about garbage collections.
setCollectorsStats
in interface ISrvMonSysGCStats
val
- The value to set.public final void setCollectorsStatsFrom(XIterator<SrvMonSysGCCollectorStats> val)
ISrvMonSysGCStats
This method will call XIterator.toFirst()
before and after setting the values, meaning
that all values from the iterator will be set and the iterator will be reset on return.
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'collectorsStats' accessor can copy the values without iteration.
This list will include the most recent collections that have occurred since the last heartbeat, but may also include historical garbage collections as well. The collection count field of each collection can be used to determine if two heartbeats duplicate information about garbage collections.
NOTE:
Passing a null
or empty list has the same affect as calling ISrvMonSysGCStats.setCollectorsStats(SrvMonSysGCCollectorStats[])
with
a value of null
.
setCollectorsStatsFrom
in interface ISrvMonSysGCStats
val
- the values to set.public final void lendCollectorsStatsFrom(XIterator<SrvMonSysGCCollectorStats> val)
ISrvMonSysGCStats
This method will call XIterator.toFirst()
before and after setting the values, meaning
that all values from the iterator will be set and the iterator will be reset on return.
This method will acquire references to each non null value in the provided iterator making it suitable for cases where the values come from another message that may be disposed.
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'collectorsStats' accessor can copy the values without iteration.
This list will include the most recent collections that have occurred since the last heartbeat, but may also include historical garbage collections as well. The collection count field of each collection can be used to determine if two heartbeats duplicate information about garbage collections.
NOTE:
Passing a null
or empty list has the same affect as calling ISrvMonSysGCStats.setCollectorsStats(SrvMonSysGCCollectorStats[])
with
a value of null
.
lendCollectorsStatsFrom
in interface ISrvMonSysGCStats
val
- the values to set.public final void lendCollectorsStats(SrvMonSysGCCollectorStats[] val)
ISrvMonSysGCStats
This list will include the most recent collections that have occurred since the last heartbeat, but may also include historical garbage collections as well. The collection count field of each collection can be used to determine if two heartbeats duplicate information about garbage collections.
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.
lendCollectorsStats
in interface ISrvMonSysGCStats
val
- the value to 'lend' to lend.public final void addCollectorsStats(SrvMonSysGCCollectorStats val)
ISrvMonSysGCStats
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'collectorsStats' accessor can copy the values without iteration.
For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.
This list will include the most recent collections that have occurred since the last heartbeat, but may also include historical garbage collections as well. The collection count field of each collection can be used to determine if two heartbeats duplicate information about garbage collections.
addCollectorsStats
in interface ISrvMonSysGCStats
val
- the value to add.public final void lendCollectorsStats(SrvMonSysGCCollectorStats val)
ISrvMonSysGCStats
Lending of an added value is useful in cases where a field is being added from a source message to provide dispose of the source value when the source message is disposed.
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'collectorsStats' accessor can copy the values without iteration.
For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.
This list will include the most recent collections that have occurred since the last heartbeat, but may also include historical garbage collections as well. The collection count field of each collection can be used to determine if two heartbeats duplicate information about garbage collections.
lendCollectorsStats
in interface ISrvMonSysGCStats
val
- the value to add.public final SrvMonSysGCCollectorStats[] getCollectorsStats()
ISrvMonSysGCStats
If the field is not set this method will return null
.
This list will include the most recent collections that have occurred since the last heartbeat, but may also include historical garbage collections as well. The collection count field of each collection can be used to determine if two heartbeats duplicate information about garbage collections.
getCollectorsStats
in interface ISrvMonSysGCStats
null
.public final SrvMonSysGCCollectorStats[] getCollectorsStatsEmptyIfNull()
ISrvMonSysGCStats
null
or not set.
This list will include the most recent collections that have occurred since the last heartbeat, but may also include historical garbage collections as well. The collection count field of each collection can be used to determine if two heartbeats duplicate information about garbage collections.
getCollectorsStatsEmptyIfNull
in interface ISrvMonSysGCStats
null
if not set.ISrvMonSysGCStats.getCollectorsStats()
public final XIterator<SrvMonSysGCCollectorStats> getCollectorsStatsIterator()
ISrvMonSysGCStats
This method will always return a non null iterator value. The returned iterator is not threadsafe, and the caller may not hold on to it beyond the pooling lifespan of this object. Depending on the implementation, the same iterator instance may be returned by this object on each call to avoid garbage. Each time this method is called the iterator is reset by calling its toFirst() method. Callers should therefore be especially careful about calling this method while iterating on the iterator returned by this method.
The elements returned by this iterator are owned by and pooled along with this object. The caller. must call acquire() on each returned object that this object intends to keep beyond the lifespan. of this object (unless the element is lent to another object in which that object will acquire it then).
This method is zero garbage for Xbuf generated classes, and this method is optimized such that
passing the returned iterator to another object's setXXX(XIterator
This list will include the most recent collections that have occurred since the last heartbeat, but may also include historical garbage collections as well. The collection count field of each collection can be used to determine if two heartbeats duplicate information about garbage collections.
getCollectorsStatsIterator
in interface ISrvMonSysGCStats
public final SrvMonSysGCCollectorStats[] takeCollectorsStats()
ISrvMonSysGCStats
This list will include the most recent collections that have occurred since the last heartbeat, but may also include historical garbage collections as well. The collection count field of each collection can be used to determine if two heartbeats duplicate information about garbage collections.
NOTE:
A nested entity reference returned by ISrvMonSysGCStats.getCollectorsStats()
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.
takeCollectorsStats
in interface ISrvMonSysGCStats
null
if the field is not set.public final void clearCollectorsStats()
ISrvMonSysGCStats
This list will include the most recent collections that have occurred since the last heartbeat, but may also include historical garbage collections as well. The collection count field of each collection can be used to determine if two heartbeats duplicate information about garbage collections.
clearCollectorsStats
in interface ISrvMonSysGCStats
ISrvMonSysGCStats.setCollectorsStats(SrvMonSysGCCollectorStats[])
public final boolean isDirty()
public static final com.neeve.xbuf.XbufSchema createSchema()
public final byte[] serializeToByteArray()
public final ByteBuffer serializeToByteBuffer()
public final com.neeve.io.IOBuffer serializeToIOBuffer(boolean useNative)
public final boolean isBufferBacked()
public final int getSerializeToNativeLength()
public final int serializeToNative(long address, int addressOffset)
public final SrvMonSysGCStats deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public final SrvMonSysGCStats deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length)
public final SrvMonSysGCStats deserializeFromByteArray(byte[] array, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public final SrvMonSysGCStats deserializeFromByteArray(byte[] array)
public final SrvMonSysGCStats deserializeFromByteBuffer(ByteBuffer buffer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public final SrvMonSysGCStats deserializeFromByteBuffer(ByteBuffer buffer)
public final SrvMonSysGCStats deserializeFromNative(long address, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public final SrvMonSysGCStats deserializeFromNative(long address, int offset, int length)
public final void sync()
public final int desync(PktBuffer buffer, int pos, boolean frameOnly)
desync
in interface com.neeve.xbuf.IXbufDesyncer
public final SrvMonSysGCStats init()
UtlPool.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.
init
in interface UtlPool.Item<SrvMonSysGCStats>
public final SrvMonSysGCStats setPool(UtlPool<SrvMonSysGCStats> pool)
UtlPool.Item
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.
setPool
in interface UtlPool.Item<SrvMonSysGCStats>
public final UtlPool<SrvMonSysGCStats> getPool()
UtlPool.Item
This method should return the pool set using UtlPool.Item.setPool(com.neeve.util.UtlPool
getPool
in interface UtlPool.Item<SrvMonSysGCStats>
UtlPool.Item.setPool(com.neeve.util.UtlPool)
public final boolean isReferenceCounted()
public final SrvMonSysGCStats acquire()
public final int getOwnerCount()
public final void dispose()
public final Object clone()
This method differs from the copy()
method in that:
clone
in class Object
public final SrvMonSysGCStats copy()
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 SrvMonSysGCStats's embedded entity fields.
The returned copy will be writeable even if this SrvMonSysGCStats is read only.
public final void copyInto(SrvMonSysGCStats copy)
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 SrvMonSysGCStats's embedded entity fields.
The returned copy will be writeable even if this SrvMonSysGCStats is read only.
copy
- The target into which to copy.public final boolean isValid()
IRogValidatable
isValid
in interface IRogValidatable
public final void getValidationErrors(List<XString> results, String errorPrefix)
IRogValidatable
getValidationErrors
in interface IRogValidatable
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.public final String toString()
toString
in class Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |