com.neeve.server.mon
Class SrvMonUserStats

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

All Implemented Interfaces:

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

Groups together the collections of application (User) defined counter and latencies statistics.

Nested Class Summary

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

Field Summary

static SrvMonUserStats[]

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

Constructor Summary

SrvMonUserStats()

SrvMonUserStats(int initialBackingBufferSize)

Method Summary

SrvMonUserStats	acquire()
void	addCounters(SrvMonUserCounterStat val) Adds the provided value to the list of 'counters' values.
void	addGauges(SrvMonUserGaugeStat val) Adds the provided value to the list of 'gauges' values.
void	addSeries(SrvMonUserSeriesStat val) Adds the provided value to the list of 'series' values.
void	clearContent()
void	clearCounters() Clears the value of 'counters' Field Description Application Counter Stats
void	clearGauges() Clears the value of 'gauges' Field Description Application Gauge Stats
void	clearSeries() Clears the value of 'series' Field Description Application Series Stats
void	clearXRogType()
Object	clone() Creates a clone of this object.
SrvMonUserStats	copy() Creates a copy of this SrvMonUserStats.
void	copyInto(SrvMonUserStats copy) Copies the contents of this SrvMonUserStats into the target.
static SrvMonUserStats	create()
static SrvMonUserStats	createFrom(byte[] serializedContainer)
static SrvMonUserStats	createFrom(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
static SrvMonUserStats	createFromSerializedXbufContainer(byte[] serializedContainer)
static SrvMonUserStats	createFromSerializedXbufContainer(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
static com.neeve.xbuf.XbufSchema	createSchema()
SrvMonUserStats	deserializeFromByteArray(byte[] array)
SrvMonUserStats	deserializeFromByteArray(byte[] array, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonUserStats	deserializeFromByteBuffer(ByteBuffer buffer)
SrvMonUserStats	deserializeFromByteBuffer(ByteBuffer buffer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonUserStats	deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length)
SrvMonUserStats	deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonUserStats	deserializeFromNative(long address, int offset, int length)
SrvMonUserStats	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()
SrvMonUserCounterStat[]	getCounters() Gets the value of 'counters' If the field is not set this method will return null.
SrvMonUserCounterStat[]	getCountersEmptyIfNull() Gets the value of 'counters' or an empty array if the value is null or not set.
static int	getCountersFieldId() Get the field id for 'counters' This method can be used to set field interests.
XIterator<SrvMonUserCounterStat>	getCountersIterator() Gets the value of 'counters' as iterator of values.
static com.neeve.xbuf.XbufDesyncPolicy	getDesyncPolicy()
SrvMonUserGaugeStat[]	getGauges() Gets the value of 'gauges' If the field is not set this method will return null.
SrvMonUserGaugeStat[]	getGaugesEmptyIfNull() Gets the value of 'gauges' or an empty array if the value is null or not set.
static int	getGaugesFieldId() Get the field id for 'gauges' This method can be used to set field interests.
XIterator<SrvMonUserGaugeStat>	getGaugesIterator() Gets the value of 'gauges' as iterator of values.
boolean	getIsReadOnly()
int	getOwnerCount()
UtlPool<SrvMonUserStats>	getPool() Get a pool item's pool.
int	getSerializeToNativeLength()
SrvMonUserSeriesStat[]	getSeries() Gets the value of 'series' If the field is not set this method will return null.
SrvMonUserSeriesStat[]	getSeriesEmptyIfNull() Gets the value of 'series' or an empty array if the value is null or not set.
static int	getSeriesFieldId() Get the field id for 'series' This method can be used to set field interests.
XIterator<SrvMonUserSeriesStat>	getSeriesIterator() Gets the value of 'series' as iterator of values.
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()
SrvMonUserStats	init() Initialize an item.
boolean	isBufferBacked()
boolean	isDirty()
boolean	isReferenceCounted()
boolean	isValid() Tests if this object has any validation errors.
void	lendCounters(SrvMonUserCounterStat val) Adds the provided value to the list of 'counters' values and acquires a reference to it.
void	lendCounters(SrvMonUserCounterStat[] val) Lends the value of 'counters' Field Description Application Counter Stats NOTE: It is illegal to hold onto an entity 'set' on a message post the disposal of the container message.
void	lendCountersFrom(XIterator<SrvMonUserCounterStat> val) Sets the value of 'counters' by lending the values from the provided iterator.
void	lendGauges(SrvMonUserGaugeStat val) Adds the provided value to the list of 'gauges' values and acquires a reference to it.
void	lendGauges(SrvMonUserGaugeStat[] val) Lends the value of 'gauges' Field Description Application Gauge Stats NOTE: It is illegal to hold onto an entity 'set' on a message post the disposal of the container message.
void	lendGaugesFrom(XIterator<SrvMonUserGaugeStat> val) Sets the value of 'gauges' by lending the values from the provided iterator.
void	lendSeries(SrvMonUserSeriesStat val) Adds the provided value to the list of 'series' values and acquires a reference to it.
void	lendSeries(SrvMonUserSeriesStat[] val) Lends the value of 'series' Field Description Application Series Stats NOTE: It is illegal to hold onto an entity 'set' on a message post the disposal of the container message.
void	lendSeriesFrom(XIterator<SrvMonUserSeriesStat> val) Sets the value of 'series' 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	setCounters(SrvMonUserCounterStat[] val) Sets the value of 'counters' Field Description Application Counter Stats
void	setCountersFrom(XIterator<SrvMonUserCounterStat> val) Sets the value of 'counters' using the values from the provided iterator.
static void	setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
static void	setFieldInterest(List<Integer> fieldIds)
void	setGauges(SrvMonUserGaugeStat[] val) Sets the value of 'gauges' Field Description Application Gauge Stats
void	setGaugesFrom(XIterator<SrvMonUserGaugeStat> val) Sets the value of 'gauges' using the values from the provided iterator.
SrvMonUserStats	setPool(UtlPool<SrvMonUserStats> pool) Set a pool item's pool.
void	setSeries(SrvMonUserSeriesStat[] val) Sets the value of 'series' Field Description Application Series Stats
void	setSeriesFrom(XIterator<SrvMonUserSeriesStat> val) Sets the value of 'series' using the values from the provided iterator.
void	setXRogType(short val)
void	setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)
void	sync()
void	syncFieldBitmask()
SrvMonUserCounterStat[]	takeCounters() Takes the value of 'counters' Field Description Application Counter Stats NOTE: A nested entity reference returned by ISrvMonUserStats.getCounters() 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.
SrvMonUserGaugeStat[]	takeGauges() Takes the value of 'gauges' Field Description Application Gauge Stats NOTE: A nested entity reference returned by ISrvMonUserStats.getGauges() 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.
SrvMonUserSeriesStat[]	takeSeries() Takes the value of 'series' Field Description Application Series Stats NOTE: A nested entity reference returned by ISrvMonUserStats.getSeries() 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.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_ARRAY

public static final SrvMonUserStats[] EMPTY_ARRAY

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

Constructor Detail

SrvMonUserStats

public SrvMonUserStats()

SrvMonUserStats

public SrvMonUserStats(int initialBackingBufferSize)

Method Detail

create

public static SrvMonUserStats create()

createFromSerializedXbufContainer

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

createFromSerializedXbufContainer

public static SrvMonUserStats createFromSerializedXbufContainer(byte[] serializedContainer)

createFrom

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

createFrom

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

getCountersFieldId

public static final int getCountersFieldId()

Get the field id for 'counters'

This method can be used to set field interests.

See Also:

getCounters()

setCounters

public final void setCounters(SrvMonUserCounterStat[] val)

Description copied from interface: ISrvMonUserStats

Sets the value of 'counters'

Field Description

Application Counter Stats

Specified by:

setCounters in interface ISrvMonUserStats

Parameters:

val - The value to set.

setCountersFrom

public final void setCountersFrom(XIterator<SrvMonUserCounterStat> val)

Description copied from interface: ISrvMonUserStats

Sets the value of 'counters' using the values from the provided iterator.

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 'counters' accessor can copy the values without iteration.

Field Description

Application Counter Stats

NOTE:
Passing a null or empty list has the same affect as calling ISrvMonUserStats.setCounters(SrvMonUserCounterStat[]) with a value of null.

Specified by:

setCountersFrom in interface ISrvMonUserStats

Parameters:

val - the values to set.

lendCountersFrom

public final void lendCountersFrom(XIterator<SrvMonUserCounterStat> val)

Description copied from interface: ISrvMonUserStats

Sets the value of 'counters' by lending the values from the provided iterator.

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 'counters' accessor can copy the values without iteration.

Field Description

Application Counter Stats

NOTE:
Passing a null or empty list has the same affect as calling ISrvMonUserStats.setCounters(SrvMonUserCounterStat[]) with a value of null.

Specified by:

lendCountersFrom in interface ISrvMonUserStats

Parameters:

val - the values to set.

lendCounters

public final void lendCounters(SrvMonUserCounterStat[] val)

Description copied from interface: ISrvMonUserStats

Lends the value of 'counters'

Field Description

Application Counter Stats

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:

lendCounters in interface ISrvMonUserStats

Parameters:

val - the value to 'lend' to lend.

addCounters

public final void addCounters(SrvMonUserCounterStat val)

Description copied from interface: ISrvMonUserStats

Adds the provided value to the list of 'counters' values.

This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'counters' 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.

Field Description

Application Counter Stats

Specified by:

addCounters in interface ISrvMonUserStats

Parameters:

val - the value to add.

lendCounters

public final void lendCounters(SrvMonUserCounterStat val)

Description copied from interface: ISrvMonUserStats

Adds the provided value to the list of 'counters' values and acquires a reference to it.

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

Field Description

Application Counter Stats

Specified by:

lendCounters in interface ISrvMonUserStats

Parameters:

val - the value to add.

getCounters

public final SrvMonUserCounterStat[] getCounters()

Description copied from interface: ISrvMonUserStats

Gets the value of 'counters'

If the field is not set this method will return null.

Field Description

Application Counter Stats

Specified by:

getCounters in interface ISrvMonUserStats

Returns:

Application Counter Stats If the field is not set this method will return null.

getCountersEmptyIfNull

public final SrvMonUserCounterStat[] getCountersEmptyIfNull()

Description copied from interface: ISrvMonUserStats

Gets the value of 'counters' or an empty array if the value is null or not set.

Field Description

Application Counter Stats

Specified by:

getCountersEmptyIfNull in interface ISrvMonUserStats

Returns:

Application Counter Stats or an empty array if null if not set.

See Also:

ISrvMonUserStats.getCounters()

getCountersIterator

public final XIterator<SrvMonUserCounterStat> getCountersIterator()

Description copied from interface: ISrvMonUserStats

Gets the value of 'counters' as iterator of values.

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 method can perform a direct copy of the underlying values without iteration.

Field Description

Application Counter Stats

Specified by:

getCountersIterator in interface ISrvMonUserStats

Returns:

An iterator containing this field values.

takeCounters

public final SrvMonUserCounterStat[] takeCounters()

Description copied from interface: ISrvMonUserStats

Takes the value of 'counters'

Field Description

Application Counter Stats

NOTE:
A nested entity reference returned by ISrvMonUserStats.getCounters() 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:

takeCounters in interface ISrvMonUserStats

Returns:

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

clearCounters

public final void clearCounters()

Description copied from interface: ISrvMonUserStats

Clears the value of 'counters'

Field Description

Application Counter Stats

Specified by:

clearCounters in interface ISrvMonUserStats

See Also:

ISrvMonUserStats.setCounters(SrvMonUserCounterStat[])

getSeriesFieldId

public static final int getSeriesFieldId()

Get the field id for 'series'

This method can be used to set field interests.

See Also:

getSeries()

setSeries

public final void setSeries(SrvMonUserSeriesStat[] val)

Description copied from interface: ISrvMonUserStats

Sets the value of 'series'

Field Description

Application Series Stats

Specified by:

setSeries in interface ISrvMonUserStats

Parameters:

val - The value to set.

setSeriesFrom

public final void setSeriesFrom(XIterator<SrvMonUserSeriesStat> val)

Description copied from interface: ISrvMonUserStats

Sets the value of 'series' using the values from the provided iterator.

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 'series' accessor can copy the values without iteration.

Field Description

Application Series Stats

NOTE:
Passing a null or empty list has the same affect as calling ISrvMonUserStats.setSeries(SrvMonUserSeriesStat[]) with a value of null.

Specified by:

setSeriesFrom in interface ISrvMonUserStats

Parameters:

val - the values to set.

lendSeriesFrom

public final void lendSeriesFrom(XIterator<SrvMonUserSeriesStat> val)

Description copied from interface: ISrvMonUserStats

Sets the value of 'series' by lending the values from the provided iterator.

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 'series' accessor can copy the values without iteration.

Field Description

Application Series Stats

NOTE:
Passing a null or empty list has the same affect as calling ISrvMonUserStats.setSeries(SrvMonUserSeriesStat[]) with a value of null.

Specified by:

lendSeriesFrom in interface ISrvMonUserStats

Parameters:

val - the values to set.

lendSeries

public final void lendSeries(SrvMonUserSeriesStat[] val)

Description copied from interface: ISrvMonUserStats

Lends the value of 'series'

Field Description

Application Series Stats

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:

lendSeries in interface ISrvMonUserStats

Parameters:

val - the value to 'lend' to lend.

addSeries

public final void addSeries(SrvMonUserSeriesStat val)

Description copied from interface: ISrvMonUserStats

Adds the provided value to the list of 'series' values.

This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'series' 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.

Field Description

Application Series Stats

Specified by:

addSeries in interface ISrvMonUserStats

Parameters:

val - the value to add.

lendSeries

public final void lendSeries(SrvMonUserSeriesStat val)

Description copied from interface: ISrvMonUserStats

Adds the provided value to the list of 'series' values and acquires a reference to it.

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

Field Description

Application Series Stats

Specified by:

lendSeries in interface ISrvMonUserStats

Parameters:

val - the value to add.

getSeries

public final SrvMonUserSeriesStat[] getSeries()

Description copied from interface: ISrvMonUserStats

Gets the value of 'series'

If the field is not set this method will return null.

Field Description

Application Series Stats

Specified by:

getSeries in interface ISrvMonUserStats

Returns:

Application Series Stats If the field is not set this method will return null.

getSeriesEmptyIfNull

public final SrvMonUserSeriesStat[] getSeriesEmptyIfNull()

Description copied from interface: ISrvMonUserStats

Gets the value of 'series' or an empty array if the value is null or not set.

Field Description

Application Series Stats

Specified by:

getSeriesEmptyIfNull in interface ISrvMonUserStats

Returns:

Application Series Stats or an empty array if null if not set.

See Also:

ISrvMonUserStats.getSeries()

getSeriesIterator

public final XIterator<SrvMonUserSeriesStat> getSeriesIterator()

Description copied from interface: ISrvMonUserStats

Gets the value of 'series' as iterator of values.

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 method can perform a direct copy of the underlying values without iteration.

Field Description

Application Series Stats

Specified by:

getSeriesIterator in interface ISrvMonUserStats

Returns:

An iterator containing this field values.

takeSeries

public final SrvMonUserSeriesStat[] takeSeries()

Description copied from interface: ISrvMonUserStats

Takes the value of 'series'

Field Description

Application Series Stats

NOTE:
A nested entity reference returned by ISrvMonUserStats.getSeries() 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:

takeSeries in interface ISrvMonUserStats

Returns:

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

clearSeries

public final void clearSeries()

Description copied from interface: ISrvMonUserStats

Clears the value of 'series'

Field Description

Application Series Stats

Specified by:

clearSeries in interface ISrvMonUserStats

See Also:

ISrvMonUserStats.setSeries(SrvMonUserSeriesStat[])

getGaugesFieldId

public static final int getGaugesFieldId()

Get the field id for 'gauges'

This method can be used to set field interests.

See Also:

getGauges()

setGauges

public final void setGauges(SrvMonUserGaugeStat[] val)

Description copied from interface: ISrvMonUserStats

Sets the value of 'gauges'

Field Description

Application Gauge Stats

Specified by:

setGauges in interface ISrvMonUserStats

Parameters:

val - The value to set.

setGaugesFrom

public final void setGaugesFrom(XIterator<SrvMonUserGaugeStat> val)

Description copied from interface: ISrvMonUserStats

Sets the value of 'gauges' using the values from the provided iterator.

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 'gauges' accessor can copy the values without iteration.

Field Description

Application Gauge Stats

NOTE:
Passing a null or empty list has the same affect as calling ISrvMonUserStats.setGauges(SrvMonUserGaugeStat[]) with a value of null.

Specified by:

setGaugesFrom in interface ISrvMonUserStats

Parameters:

val - the values to set.

lendGaugesFrom

public final void lendGaugesFrom(XIterator<SrvMonUserGaugeStat> val)

Description copied from interface: ISrvMonUserStats

Sets the value of 'gauges' by lending the values from the provided iterator.

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 'gauges' accessor can copy the values without iteration.

Field Description

Application Gauge Stats

NOTE:
Passing a null or empty list has the same affect as calling ISrvMonUserStats.setGauges(SrvMonUserGaugeStat[]) with a value of null.

Specified by:

lendGaugesFrom in interface ISrvMonUserStats

Parameters:

val - the values to set.

lendGauges

public final void lendGauges(SrvMonUserGaugeStat[] val)

Description copied from interface: ISrvMonUserStats

Lends the value of 'gauges'

Field Description

Application Gauge Stats

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:

lendGauges in interface ISrvMonUserStats

Parameters:

val - the value to 'lend' to lend.

addGauges

public final void addGauges(SrvMonUserGaugeStat val)

Description copied from interface: ISrvMonUserStats

Adds the provided value to the list of 'gauges' values.

This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'gauges' 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.

Field Description

Application Gauge Stats

Specified by:

addGauges in interface ISrvMonUserStats

Parameters:

val - the value to add.

lendGauges

public final void lendGauges(SrvMonUserGaugeStat val)

Description copied from interface: ISrvMonUserStats

Adds the provided value to the list of 'gauges' values and acquires a reference to it.

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

Field Description

Application Gauge Stats

Specified by:

lendGauges in interface ISrvMonUserStats

Parameters:

val - the value to add.

getGauges

public final SrvMonUserGaugeStat[] getGauges()

Description copied from interface: ISrvMonUserStats

Gets the value of 'gauges'

If the field is not set this method will return null.

Field Description

Application Gauge Stats

Specified by:

getGauges in interface ISrvMonUserStats

Returns:

Application Gauge Stats If the field is not set this method will return null.

getGaugesEmptyIfNull

public final SrvMonUserGaugeStat[] getGaugesEmptyIfNull()

Description copied from interface: ISrvMonUserStats

Gets the value of 'gauges' or an empty array if the value is null or not set.

Field Description

Application Gauge Stats

Specified by:

getGaugesEmptyIfNull in interface ISrvMonUserStats

Returns:

Application Gauge Stats or an empty array if null if not set.

See Also:

ISrvMonUserStats.getGauges()

getGaugesIterator

public final XIterator<SrvMonUserGaugeStat> getGaugesIterator()

Description copied from interface: ISrvMonUserStats

Gets the value of 'gauges' as iterator of values.

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 method can perform a direct copy of the underlying values without iteration.

Field Description

Application Gauge Stats

Specified by:

getGaugesIterator in interface ISrvMonUserStats

Returns:

An iterator containing this field values.

takeGauges

public final SrvMonUserGaugeStat[] takeGauges()

Description copied from interface: ISrvMonUserStats

Takes the value of 'gauges'

Field Description

Application Gauge Stats

NOTE:
A nested entity reference returned by ISrvMonUserStats.getGauges() 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:

takeGauges in interface ISrvMonUserStats

Returns:

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

clearGauges

public final void clearGauges()

Description copied from interface: ISrvMonUserStats

Clears the value of 'gauges'

Field Description

Application Gauge Stats

Specified by:

clearGauges in interface ISrvMonUserStats

See Also:

ISrvMonUserStats.setGauges(SrvMonUserGaugeStat[])

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

deserializeFromIOElasticBuffer

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

deserializeFromByteArray

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

deserializeFromByteArray

public final SrvMonUserStats deserializeFromByteArray(byte[] array)

deserializeFromByteBuffer

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

deserializeFromByteBuffer

public final SrvMonUserStats deserializeFromByteBuffer(ByteBuffer buffer)

deserializeFromNative

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

deserializeFromNative

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

Returns:

Return 'this' object for method invocation chaining.

setPool

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

Returns:

Return 'this' object for method invocation chaining.

getPool

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

Returns:

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

isReferenceCounted

public final boolean isReferenceCounted()

acquire

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

Creates a copy of this SrvMonUserStats.

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

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

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

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