com.neeve.server.mon
Class SrvMonUserCounterStat

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

All Implemented Interfaces:

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

An application defined counter statistic. A counter stat represents a monotonically increasing counter.

A Counter is useful for recording an increasing value over time. Sampled periodically it can be used to derive a rate. For example a counter could be used to record a number of message received. By sampling it over time it can be used to create a received message rate.

Nested Class Summary

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

Field Summary

static SrvMonUserCounterStat[]

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

Constructor Summary

SrvMonUserCounterStat()

SrvMonUserCounterStat(int initialBackingBufferSize)

Method Summary

SrvMonUserCounterStat	acquire()
void	clearContent()
void	clearCount() Clears the value of 'count' Field Description The counter value
void	clearName() Clears the value of 'name' Field Description The name of the statistic
void	clearXRogType()
Object	clone() Creates a clone of this object.
SrvMonUserCounterStat	copy() Creates a copy of this SrvMonUserCounterStat.
void	copyInto(SrvMonUserCounterStat copy) Copies the contents of this SrvMonUserCounterStat into the target.
static SrvMonUserCounterStat	create()
static SrvMonUserCounterStat	createFrom(byte[] serializedContainer)
static SrvMonUserCounterStat	createFrom(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
static SrvMonUserCounterStat	createFromSerializedXbufContainer(byte[] serializedContainer)
static SrvMonUserCounterStat	createFromSerializedXbufContainer(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
static com.neeve.xbuf.XbufSchema	createSchema()
SrvMonUserCounterStat	deserializeFromByteArray(byte[] array)
SrvMonUserCounterStat	deserializeFromByteArray(byte[] array, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonUserCounterStat	deserializeFromByteBuffer(ByteBuffer buffer)
SrvMonUserCounterStat	deserializeFromByteBuffer(ByteBuffer buffer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonUserCounterStat	deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length)
SrvMonUserCounterStat	deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonUserCounterStat	deserializeFromNative(long address, int offset, int length)
SrvMonUserCounterStat	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	getCount() Gets the value of 'count' Field Description The counter value
com.neeve.xbuf.XbufVariableLongField	getCountField()
static int	getCountFieldId() Get the field id for 'count' This method can be used to set field interests.
static com.neeve.xbuf.XbufDesyncPolicy	getDesyncPolicy()
boolean	getIsReadOnly()
String	getName() Gets the value of 'name' Field Description The name of the statistic
com.neeve.xbuf.XbufStringField	getNameField()
static int	getNameFieldId() Get the field id for 'name' This method can be used to set field interests.
<T extends XString> T	getNameTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getNameTo(XString val) Copies the value of 'name' into the provided XString.
XString	getNameUnsafe() Gets the raw value of 'name'.
int	getOwnerCount()
UtlPool<SrvMonUserCounterStat>	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	hasCount() Checks for the presence of 'count' Field Description The counter value
boolean	hasName() Checks for the presence of 'name' Field Description The name of the statistic
boolean	hasXRogType()
SrvMonUserCounterStat	init() Initialize an item.
boolean	isBufferBacked()
boolean	isDirty()
boolean	isReferenceCounted()
boolean	isValid() Tests if this object has any validation errors.
void	lendName(XString val) Sets the value of 'name' Field Description The name of the statistic
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	setCount(long val) Sets the value of 'count' Field Description The counter value
void	setCountFrom(com.neeve.xbuf.XbufVariableLongField val)
static void	setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
static void	setFieldInterest(List<Integer> fieldIds)
void	setName(String val) Sets the value of 'name' Field Description The name of the statistic
void	setNameFrom(long val) Sets the value of this String field to the given numeric value.
void	setNameFrom(com.neeve.xbuf.XbufStringField val)
void	setNameFrom(XString val) Copies the provided XString value into this object's 'name'.
SrvMonUserCounterStat	setPool(UtlPool<SrvMonUserCounterStat> pool) Set a pool item's pool.
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 SrvMonUserCounterStat[] EMPTY_ARRAY

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

Constructor Detail

SrvMonUserCounterStat

public SrvMonUserCounterStat()

SrvMonUserCounterStat

public SrvMonUserCounterStat(int initialBackingBufferSize)

Method Detail

create

public static SrvMonUserCounterStat create()

createFromSerializedXbufContainer

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

createFromSerializedXbufContainer

public static SrvMonUserCounterStat createFromSerializedXbufContainer(byte[] serializedContainer)

createFrom

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

createFrom

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

getCountFieldId

public static final int getCountFieldId()

Get the field id for 'count'

This method can be used to set field interests.

See Also:

getCount()

setCount

public final void setCount(long val)

Description copied from interface: ISrvMonUserCounterStat

Sets the value of 'count'

Field Description

The counter value

Specified by:

setCount in interface ISrvMonUserCounterStat

Parameters:

val - The value to set.

getCount

public final long getCount()

Description copied from interface: ISrvMonUserCounterStat

Gets the value of 'count'

Field Description

The counter value

Specified by:

getCount in interface ISrvMonUserCounterStat

Returns:

The counter value

setCountFrom

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

getCountField

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

hasCount

public final boolean hasCount()

Description copied from interface: ISrvMonUserCounterStat

Checks for the presence of 'count'

Field Description

The counter value

Specified by:

hasCount in interface ISrvMonUserCounterStat

See Also:

ISrvMonUserCounterStat.getCount()

clearCount

public final void clearCount()

Description copied from interface: ISrvMonUserCounterStat

Clears the value of 'count'

Field Description

The counter value

Specified by:

clearCount in interface ISrvMonUserCounterStat

See Also:

ISrvMonUserCounterStat.setCount(long)

getNameFieldId

public static final int getNameFieldId()

Get the field id for 'name'

This method can be used to set field interests.

See Also:

getName()

setName

public final void setName(String val)

Description copied from interface: ISrvMonUserCounterStat

Sets the value of 'name'

Field Description

The name of the statistic

Specified by:

setName in interface ISrvMonUserCounterStat

Parameters:

val - The value to set.

getName

public final String getName()

Description copied from interface: ISrvMonUserCounterStat

Gets the value of 'name'

Field Description

The name of the statistic

Specified by:

getName in interface ISrvMonUserCounterStat

Returns:

The name of the statistic

lendName

public final void lendName(XString val)

Description copied from interface: ISrvMonUserCounterStat

Sets the value of 'name'

Field Description

The name of the statistic

Specified by:

lendName in interface ISrvMonUserCounterStat

Parameters:

val - The value to set.

setNameFrom

public final void setNameFrom(long val)

Description copied from interface: ISrvMonUserCounterStat

Sets the value of this String field to the given numeric value.

Field Description

The name of the statistic

NOTE:
This is the same as calling ISrvMonUserCounterStat.setName(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

Specified by:

setNameFrom in interface ISrvMonUserCounterStat

getNameTo

public final <T extends XString> T getNameTo(XString.Factory<T> factory)

Description copied from interface: ISrvMonUserCounterStat

Copies the value of this String field into a new XString from the given factory.

Field Description

The name of the statistic

If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);

This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;

Specified by:

getNameTo in interface ISrvMonUserCounterStat

Parameters:

factory - The factory from which to get the XString to copy into and return

Returns:

a new XString from the provided factory if this field is set or null.

setNameFrom

public final void setNameFrom(XString val)

Description copied from interface: ISrvMonUserCounterStat

Copies the provided XString value into this object's 'name'.

Field Description

The name of the statistic

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than ISrvMonUserCounterStat.setName(String) because it avoids encoding the value into a String if the given XString is already encoded.

Specified by:

setNameFrom in interface ISrvMonUserCounterStat

getNameTo

public final void getNameTo(XString val)

Description copied from interface: ISrvMonUserCounterStat

Copies the value of 'name' into the provided XString.

Field Description

The name of the statistic

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than ISrvMonUserCounterStat.getName() bec because it can avoid decoding the value into an String.

Specified by:

getNameTo in interface ISrvMonUserCounterStat

See Also:

ISrvMonUserCounterStat.getName()

getNameUnsafe

public final XString getNameUnsafe()

Description copied from interface: ISrvMonUserCounterStat

Gets the raw value of 'name'.

Field Description

The name of the statistic

NOTE:
This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.

However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.

Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.

Specified by:

getNameUnsafe in interface ISrvMonUserCounterStat

Returns:

the field's raw value

See Also:

ISrvMonUserCounterStat.getName()

setNameFrom

public final void setNameFrom(com.neeve.xbuf.XbufStringField val)

getNameField

public final com.neeve.xbuf.XbufStringField getNameField()

hasName

public final boolean hasName()

Description copied from interface: ISrvMonUserCounterStat

Checks for the presence of 'name'

Field Description

The name of the statistic

Specified by:

hasName in interface ISrvMonUserCounterStat

See Also:

ISrvMonUserCounterStat.getName()

clearName

public final void clearName()

Description copied from interface: ISrvMonUserCounterStat

Clears the value of 'name'

Field Description

The name of the statistic

Specified by:

clearName in interface ISrvMonUserCounterStat

See Also:

ISrvMonUserCounterStat.setName(String)

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

deserializeFromIOElasticBuffer

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

deserializeFromByteArray

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

deserializeFromByteArray

public final SrvMonUserCounterStat deserializeFromByteArray(byte[] array)

deserializeFromByteBuffer

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

deserializeFromByteBuffer

public final SrvMonUserCounterStat deserializeFromByteBuffer(ByteBuffer buffer)

deserializeFromNative

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

deserializeFromNative

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

Returns:

Return 'this' object for method invocation chaining.

setPool

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

Returns:

Return 'this' object for method invocation chaining.

getPool

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

Returns:

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

isReferenceCounted

public final boolean isReferenceCounted()

acquire

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

Creates a copy of this SrvMonUserCounterStat.

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

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

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

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