com.neeve.server.mon
Class SrvMonAdminClientStats

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

All Implemented Interfaces:

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

Holds stats for a connected admin client

A Talon XVM maintains statistics for connected "admin" clients. The XVM prioritizes its integrity to the reliability of information that it sends to admin clients. In other words, if the XVM detects that its integrity could be compromised due to congestion in its communication with the admin client, it will start to drop messages that it sends to the client. These statistics primarily serve the purpose of understanding the health of the connection to the admin client.

Nested Class Summary

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

Field Summary

static SrvMonAdminClientStats[]

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

Constructor Summary

SrvMonAdminClientStats()

SrvMonAdminClientStats(int initialBackingBufferSize)

Method Summary

SrvMonAdminClientStats	acquire()
void	clearContent()
void	clearHeartbeatsDropped() Clears the value of 'heartbeatsDropped' Field Description The number of heartbeats dropped because of congestion.
void	clearHeartbeatsSent() Clears the value of 'heartbeatsSent' Field Description The number of heartbeats sent to the client.
void	clearLifecyclesSent() Clears the value of 'lifecyclesSent' Field Description The number of lifecycle events sent to the client.
void	clearName() Clears the value of 'name' Field Description The name of the admin client.
void	clearOutboundQueueCapacity() Clears the value of 'outboundQueueCapacity' Field Description The capacity, in bytes, of the client's outbound queue
void	clearOutboundQueueCount() Clears the value of 'outboundQueueCount' Field Description The number of elements in the client's outbound queue
void	clearOutboundQueueSize() Clears the value of 'outboundQueueSize' Field Description The size, in bytes, of the client's outbound queue Note that the size of a client's outbound queue can exceed the capacity.
void	clearTracesDropped() Clears the value of 'tracesDropped' Field Description The number of trace records dropped because of congestion.
void	clearTracesSent() Clears the value of 'tracesSent' Field Description The number of trace records sent to the client.
void	clearXRogType()
Object	clone() Creates a clone of this object.
SrvMonAdminClientStats	copy() Creates a copy of this SrvMonAdminClientStats.
void	copyInto(SrvMonAdminClientStats copy) Copies the contents of this SrvMonAdminClientStats into the target.
static SrvMonAdminClientStats	create()
static SrvMonAdminClientStats	createFrom(byte[] serializedContainer)
static SrvMonAdminClientStats	createFrom(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
static SrvMonAdminClientStats	createFromSerializedXbufContainer(byte[] serializedContainer)
static SrvMonAdminClientStats	createFromSerializedXbufContainer(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
static com.neeve.xbuf.XbufSchema	createSchema()
SrvMonAdminClientStats	deserializeFromByteArray(byte[] array)
SrvMonAdminClientStats	deserializeFromByteArray(byte[] array, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonAdminClientStats	deserializeFromByteBuffer(ByteBuffer buffer)
SrvMonAdminClientStats	deserializeFromByteBuffer(ByteBuffer buffer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonAdminClientStats	deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length)
SrvMonAdminClientStats	deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonAdminClientStats	deserializeFromNative(long address, int offset, int length)
SrvMonAdminClientStats	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()
static com.neeve.xbuf.XbufDesyncPolicy	getDesyncPolicy()
long	getHeartbeatsDropped() Gets the value of 'heartbeatsDropped' Field Description The number of heartbeats dropped because of congestion.
com.neeve.xbuf.XbufVariableLongField	getHeartbeatsDroppedField()
static int	getHeartbeatsDroppedFieldId() Get the field id for 'heartbeatsDropped' This method can be used to set field interests.
long	getHeartbeatsSent() Gets the value of 'heartbeatsSent' Field Description The number of heartbeats sent to the client.
com.neeve.xbuf.XbufVariableLongField	getHeartbeatsSentField()
static int	getHeartbeatsSentFieldId() Get the field id for 'heartbeatsSent' This method can be used to set field interests.
boolean	getIsReadOnly()
long	getLifecyclesSent() Gets the value of 'lifecyclesSent' Field Description The number of lifecycle events sent to the client.
com.neeve.xbuf.XbufVariableLongField	getLifecyclesSentField()
static int	getLifecyclesSentFieldId() Get the field id for 'lifecyclesSent' This method can be used to set field interests.
String	getName() Gets the value of 'name' Field Description The name of the admin client.
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	getOutboundQueueCapacity() Gets the value of 'outboundQueueCapacity' Field Description The capacity, in bytes, of the client's outbound queue
com.neeve.xbuf.XbufVariableIntField	getOutboundQueueCapacityField()
static int	getOutboundQueueCapacityFieldId() Get the field id for 'outboundQueueCapacity' This method can be used to set field interests.
int	getOutboundQueueCount() Gets the value of 'outboundQueueCount' Field Description The number of elements in the client's outbound queue
com.neeve.xbuf.XbufVariableIntField	getOutboundQueueCountField()
static int	getOutboundQueueCountFieldId() Get the field id for 'outboundQueueCount' This method can be used to set field interests.
int	getOutboundQueueSize() Gets the value of 'outboundQueueSize' Field Description The size, in bytes, of the client's outbound queue Note that the size of a client's outbound queue can exceed the capacity.
com.neeve.xbuf.XbufVariableIntField	getOutboundQueueSizeField()
static int	getOutboundQueueSizeFieldId() Get the field id for 'outboundQueueSize' This method can be used to set field interests.
int	getOwnerCount()
UtlPool<SrvMonAdminClientStats>	getPool() Get a pool item's pool.
int	getSerializeToNativeLength()
long	getTracesDropped() Gets the value of 'tracesDropped' Field Description The number of trace records dropped because of congestion.
com.neeve.xbuf.XbufVariableLongField	getTracesDroppedField()
static int	getTracesDroppedFieldId() Get the field id for 'tracesDropped' This method can be used to set field interests.
long	getTracesSent() Gets the value of 'tracesSent' Field Description The number of trace records sent to the client.
com.neeve.xbuf.XbufVariableLongField	getTracesSentField()
static int	getTracesSentFieldId() Get the field id for 'tracesSent' 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	hasHeartbeatsDropped() Checks for the presence of 'heartbeatsDropped' Field Description The number of heartbeats dropped because of congestion.
boolean	hasHeartbeatsSent() Checks for the presence of 'heartbeatsSent' Field Description The number of heartbeats sent to the client.
boolean	hasLifecyclesSent() Checks for the presence of 'lifecyclesSent' Field Description The number of lifecycle events sent to the client.
boolean	hasName() Checks for the presence of 'name' Field Description The name of the admin client.
boolean	hasOutboundQueueCapacity() Checks for the presence of 'outboundQueueCapacity' Field Description The capacity, in bytes, of the client's outbound queue
boolean	hasOutboundQueueCount() Checks for the presence of 'outboundQueueCount' Field Description The number of elements in the client's outbound queue
boolean	hasOutboundQueueSize() Checks for the presence of 'outboundQueueSize' Field Description The size, in bytes, of the client's outbound queue Note that the size of a client's outbound queue can exceed the capacity.
boolean	hasTracesDropped() Checks for the presence of 'tracesDropped' Field Description The number of trace records dropped because of congestion.
boolean	hasTracesSent() Checks for the presence of 'tracesSent' Field Description The number of trace records sent to the client.
boolean	hasXRogType()
SrvMonAdminClientStats	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 admin client.
static void	optimizeFor(int val)
byte[]	serializeToByteArray()
ByteBuffer	serializeToByteBuffer()
com.neeve.io.IOBuffer	serializeToIOBuffer(boolean useNative)
int	serializeToNative(long address, int addressOffset)
void	setAsReadOnly()
static void	setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
static void	setFieldInterest(List<Integer> fieldIds)
void	setHeartbeatsDropped(long val) Sets the value of 'heartbeatsDropped' Field Description The number of heartbeats dropped because of congestion.
void	setHeartbeatsDroppedFrom(com.neeve.xbuf.XbufVariableLongField val)
void	setHeartbeatsSent(long val) Sets the value of 'heartbeatsSent' Field Description The number of heartbeats sent to the client.
void	setHeartbeatsSentFrom(com.neeve.xbuf.XbufVariableLongField val)
void	setLifecyclesSent(long val) Sets the value of 'lifecyclesSent' Field Description The number of lifecycle events sent to the client.
void	setLifecyclesSentFrom(com.neeve.xbuf.XbufVariableLongField val)
void	setName(String val) Sets the value of 'name' Field Description The name of the admin client.
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'.
void	setOutboundQueueCapacity(int val) Sets the value of 'outboundQueueCapacity' Field Description The capacity, in bytes, of the client's outbound queue
void	setOutboundQueueCapacityFrom(com.neeve.xbuf.XbufVariableIntField val)
void	setOutboundQueueCount(int val) Sets the value of 'outboundQueueCount' Field Description The number of elements in the client's outbound queue
void	setOutboundQueueCountFrom(com.neeve.xbuf.XbufVariableIntField val)
void	setOutboundQueueSize(int val) Sets the value of 'outboundQueueSize' Field Description The size, in bytes, of the client's outbound queue Note that the size of a client's outbound queue can exceed the capacity.
void	setOutboundQueueSizeFrom(com.neeve.xbuf.XbufVariableIntField val)
SrvMonAdminClientStats	setPool(UtlPool<SrvMonAdminClientStats> pool) Set a pool item's pool.
void	setTracesDropped(long val) Sets the value of 'tracesDropped' Field Description The number of trace records dropped because of congestion.
void	setTracesDroppedFrom(com.neeve.xbuf.XbufVariableLongField val)
void	setTracesSent(long val) Sets the value of 'tracesSent' Field Description The number of trace records sent to the client.
void	setTracesSentFrom(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 SrvMonAdminClientStats[] EMPTY_ARRAY

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

Constructor Detail

SrvMonAdminClientStats

public SrvMonAdminClientStats()

SrvMonAdminClientStats

public SrvMonAdminClientStats(int initialBackingBufferSize)

Method Detail

create

public static SrvMonAdminClientStats create()

createFromSerializedXbufContainer

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

createFromSerializedXbufContainer

public static SrvMonAdminClientStats createFromSerializedXbufContainer(byte[] serializedContainer)

createFrom

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

createFrom

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

getLifecyclesSentFieldId

public static final int getLifecyclesSentFieldId()

Get the field id for 'lifecyclesSent'

This method can be used to set field interests.

See Also:

getLifecyclesSent()

setLifecyclesSent

public final void setLifecyclesSent(long val)

Description copied from interface: ISrvMonAdminClientStats

Sets the value of 'lifecyclesSent'

Field Description

The number of lifecycle events sent to the client.

Specified by:

setLifecyclesSent in interface ISrvMonAdminClientStats

Parameters:

val - The value to set.

getLifecyclesSent

public final long getLifecyclesSent()

Description copied from interface: ISrvMonAdminClientStats

Gets the value of 'lifecyclesSent'

Field Description

The number of lifecycle events sent to the client.

Specified by:

getLifecyclesSent in interface ISrvMonAdminClientStats

Returns:

The number of lifecycle events sent to the client.

setLifecyclesSentFrom

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

getLifecyclesSentField

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

hasLifecyclesSent

public final boolean hasLifecyclesSent()

Description copied from interface: ISrvMonAdminClientStats

Checks for the presence of 'lifecyclesSent'

Field Description

The number of lifecycle events sent to the client.

Specified by:

hasLifecyclesSent in interface ISrvMonAdminClientStats

See Also:

ISrvMonAdminClientStats.getLifecyclesSent()

clearLifecyclesSent

public final void clearLifecyclesSent()

Description copied from interface: ISrvMonAdminClientStats

Clears the value of 'lifecyclesSent'

Field Description

The number of lifecycle events sent to the client.

Specified by:

clearLifecyclesSent in interface ISrvMonAdminClientStats

See Also:

ISrvMonAdminClientStats.setLifecyclesSent(long)

getHeartbeatsSentFieldId

public static final int getHeartbeatsSentFieldId()

Get the field id for 'heartbeatsSent'

This method can be used to set field interests.

See Also:

getHeartbeatsSent()

setHeartbeatsSent

public final void setHeartbeatsSent(long val)

Description copied from interface: ISrvMonAdminClientStats

Sets the value of 'heartbeatsSent'

Field Description

The number of heartbeats sent to the client.

Specified by:

setHeartbeatsSent in interface ISrvMonAdminClientStats

Parameters:

val - The value to set.

getHeartbeatsSent

public final long getHeartbeatsSent()

Description copied from interface: ISrvMonAdminClientStats

Gets the value of 'heartbeatsSent'

Field Description

The number of heartbeats sent to the client.

Specified by:

getHeartbeatsSent in interface ISrvMonAdminClientStats

Returns:

The number of heartbeats sent to the client.

setHeartbeatsSentFrom

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

getHeartbeatsSentField

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

hasHeartbeatsSent

public final boolean hasHeartbeatsSent()

Description copied from interface: ISrvMonAdminClientStats

Checks for the presence of 'heartbeatsSent'

Field Description

The number of heartbeats sent to the client.

Specified by:

hasHeartbeatsSent in interface ISrvMonAdminClientStats

See Also:

ISrvMonAdminClientStats.getHeartbeatsSent()

clearHeartbeatsSent

public final void clearHeartbeatsSent()

Description copied from interface: ISrvMonAdminClientStats

Clears the value of 'heartbeatsSent'

Field Description

The number of heartbeats sent to the client.

Specified by:

clearHeartbeatsSent in interface ISrvMonAdminClientStats

See Also:

ISrvMonAdminClientStats.setHeartbeatsSent(long)

getHeartbeatsDroppedFieldId

public static final int getHeartbeatsDroppedFieldId()

Get the field id for 'heartbeatsDropped'

This method can be used to set field interests.

See Also:

getHeartbeatsDropped()

setHeartbeatsDropped

public final void setHeartbeatsDropped(long val)

Description copied from interface: ISrvMonAdminClientStats

Sets the value of 'heartbeatsDropped'

Field Description

The number of heartbeats dropped because of congestion.

Specified by:

setHeartbeatsDropped in interface ISrvMonAdminClientStats

Parameters:

val - The value to set.

getHeartbeatsDropped

public final long getHeartbeatsDropped()

Description copied from interface: ISrvMonAdminClientStats

Gets the value of 'heartbeatsDropped'

Field Description

The number of heartbeats dropped because of congestion.

Specified by:

getHeartbeatsDropped in interface ISrvMonAdminClientStats

Returns:

The number of heartbeats dropped because of congestion.

setHeartbeatsDroppedFrom

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

getHeartbeatsDroppedField

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

hasHeartbeatsDropped

public final boolean hasHeartbeatsDropped()

Description copied from interface: ISrvMonAdminClientStats

Checks for the presence of 'heartbeatsDropped'

Field Description

The number of heartbeats dropped because of congestion.

Specified by:

hasHeartbeatsDropped in interface ISrvMonAdminClientStats

See Also:

ISrvMonAdminClientStats.getHeartbeatsDropped()

clearHeartbeatsDropped

public final void clearHeartbeatsDropped()

Description copied from interface: ISrvMonAdminClientStats

Clears the value of 'heartbeatsDropped'

Field Description

The number of heartbeats dropped because of congestion.

Specified by:

clearHeartbeatsDropped in interface ISrvMonAdminClientStats

See Also:

ISrvMonAdminClientStats.setHeartbeatsDropped(long)

getTracesSentFieldId

public static final int getTracesSentFieldId()

Get the field id for 'tracesSent'

This method can be used to set field interests.

See Also:

getTracesSent()

setTracesSent

public final void setTracesSent(long val)

Description copied from interface: ISrvMonAdminClientStats

Sets the value of 'tracesSent'

Field Description

The number of trace records sent to the client.

Specified by:

setTracesSent in interface ISrvMonAdminClientStats

Parameters:

val - The value to set.

getTracesSent

public final long getTracesSent()

Description copied from interface: ISrvMonAdminClientStats

Gets the value of 'tracesSent'

Field Description

The number of trace records sent to the client.

Specified by:

getTracesSent in interface ISrvMonAdminClientStats

Returns:

The number of trace records sent to the client.

setTracesSentFrom

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

getTracesSentField

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

hasTracesSent

public final boolean hasTracesSent()

Description copied from interface: ISrvMonAdminClientStats

Checks for the presence of 'tracesSent'

Field Description

The number of trace records sent to the client.

Specified by:

hasTracesSent in interface ISrvMonAdminClientStats

See Also:

ISrvMonAdminClientStats.getTracesSent()

clearTracesSent

public final void clearTracesSent()

Description copied from interface: ISrvMonAdminClientStats

Clears the value of 'tracesSent'

Field Description

The number of trace records sent to the client.

Specified by:

clearTracesSent in interface ISrvMonAdminClientStats

See Also:

ISrvMonAdminClientStats.setTracesSent(long)

getTracesDroppedFieldId

public static final int getTracesDroppedFieldId()

Get the field id for 'tracesDropped'

This method can be used to set field interests.

See Also:

getTracesDropped()

setTracesDropped

public final void setTracesDropped(long val)

Description copied from interface: ISrvMonAdminClientStats

Sets the value of 'tracesDropped'

Field Description

The number of trace records dropped because of congestion.

Specified by:

setTracesDropped in interface ISrvMonAdminClientStats

Parameters:

val - The value to set.

getTracesDropped

public final long getTracesDropped()

Description copied from interface: ISrvMonAdminClientStats

Gets the value of 'tracesDropped'

Field Description

The number of trace records dropped because of congestion.

Specified by:

getTracesDropped in interface ISrvMonAdminClientStats

Returns:

The number of trace records dropped because of congestion.

setTracesDroppedFrom

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

getTracesDroppedField

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

hasTracesDropped

public final boolean hasTracesDropped()

Description copied from interface: ISrvMonAdminClientStats

Checks for the presence of 'tracesDropped'

Field Description

The number of trace records dropped because of congestion.

Specified by:

hasTracesDropped in interface ISrvMonAdminClientStats

See Also:

ISrvMonAdminClientStats.getTracesDropped()

clearTracesDropped

public final void clearTracesDropped()

Description copied from interface: ISrvMonAdminClientStats

Clears the value of 'tracesDropped'

Field Description

The number of trace records dropped because of congestion.

Specified by:

clearTracesDropped in interface ISrvMonAdminClientStats

See Also:

ISrvMonAdminClientStats.setTracesDropped(long)

getOutboundQueueCapacityFieldId

public static final int getOutboundQueueCapacityFieldId()

Get the field id for 'outboundQueueCapacity'

This method can be used to set field interests.

See Also:

getOutboundQueueCapacity()

setOutboundQueueCapacity

public final void setOutboundQueueCapacity(int val)

Description copied from interface: ISrvMonAdminClientStats

Sets the value of 'outboundQueueCapacity'

Field Description

The capacity, in bytes, of the client's outbound queue

Specified by:

setOutboundQueueCapacity in interface ISrvMonAdminClientStats

Parameters:

val - The value to set.

getOutboundQueueCapacity

public final int getOutboundQueueCapacity()

Description copied from interface: ISrvMonAdminClientStats

Gets the value of 'outboundQueueCapacity'

Field Description

The capacity, in bytes, of the client's outbound queue

Specified by:

getOutboundQueueCapacity in interface ISrvMonAdminClientStats

Returns:

The capacity, in bytes, of the client's outbound queue

setOutboundQueueCapacityFrom

public final void setOutboundQueueCapacityFrom(com.neeve.xbuf.XbufVariableIntField val)

getOutboundQueueCapacityField

public final com.neeve.xbuf.XbufVariableIntField getOutboundQueueCapacityField()

hasOutboundQueueCapacity

public final boolean hasOutboundQueueCapacity()

Description copied from interface: ISrvMonAdminClientStats

Checks for the presence of 'outboundQueueCapacity'

Field Description

The capacity, in bytes, of the client's outbound queue

Specified by:

hasOutboundQueueCapacity in interface ISrvMonAdminClientStats

See Also:

ISrvMonAdminClientStats.getOutboundQueueCapacity()

clearOutboundQueueCapacity

public final void clearOutboundQueueCapacity()

Description copied from interface: ISrvMonAdminClientStats

Clears the value of 'outboundQueueCapacity'

Field Description

The capacity, in bytes, of the client's outbound queue

Specified by:

clearOutboundQueueCapacity in interface ISrvMonAdminClientStats

See Also:

ISrvMonAdminClientStats.setOutboundQueueCapacity(int)

getOutboundQueueSizeFieldId

public static final int getOutboundQueueSizeFieldId()

Get the field id for 'outboundQueueSize'

This method can be used to set field interests.

See Also:

getOutboundQueueSize()

setOutboundQueueSize

public final void setOutboundQueueSize(int val)

Description copied from interface: ISrvMonAdminClientStats

Sets the value of 'outboundQueueSize'

Field Description

The size, in bytes, of the client's outbound queue

Note that the size of a client's outbound queue can exceed the capacity. This can be caused when lifecycle events need to be sent to the client but the client connection. is congested. Since lifecycle events are not ever dropped, it can cause the queue capacity to be exceeded

Specified by:

setOutboundQueueSize in interface ISrvMonAdminClientStats

Parameters:

val - The value to set.

getOutboundQueueSize

public final int getOutboundQueueSize()

Description copied from interface: ISrvMonAdminClientStats

Gets the value of 'outboundQueueSize'

Field Description

The size, in bytes, of the client's outbound queue

Note that the size of a client's outbound queue can exceed the capacity. This can be caused when lifecycle events need to be sent to the client but the client connection. is congested. Since lifecycle events are not ever dropped, it can cause the queue capacity to be exceeded

Specified by:

getOutboundQueueSize in interface ISrvMonAdminClientStats

Returns:

The size, in bytes, of the client's outbound queue

setOutboundQueueSizeFrom

public final void setOutboundQueueSizeFrom(com.neeve.xbuf.XbufVariableIntField val)

getOutboundQueueSizeField

public final com.neeve.xbuf.XbufVariableIntField getOutboundQueueSizeField()

hasOutboundQueueSize

public final boolean hasOutboundQueueSize()

Description copied from interface: ISrvMonAdminClientStats

Checks for the presence of 'outboundQueueSize'

Field Description

The size, in bytes, of the client's outbound queue

Note that the size of a client's outbound queue can exceed the capacity. This can be caused when lifecycle events need to be sent to the client but the client connection. is congested. Since lifecycle events are not ever dropped, it can cause the queue capacity to be exceeded

Specified by:

hasOutboundQueueSize in interface ISrvMonAdminClientStats

See Also:

ISrvMonAdminClientStats.getOutboundQueueSize()

clearOutboundQueueSize

public final void clearOutboundQueueSize()

Description copied from interface: ISrvMonAdminClientStats

Clears the value of 'outboundQueueSize'

Field Description

The size, in bytes, of the client's outbound queue

Note that the size of a client's outbound queue can exceed the capacity. This can be caused when lifecycle events need to be sent to the client but the client connection. is congested. Since lifecycle events are not ever dropped, it can cause the queue capacity to be exceeded

Specified by:

clearOutboundQueueSize in interface ISrvMonAdminClientStats

See Also:

ISrvMonAdminClientStats.setOutboundQueueSize(int)

getOutboundQueueCountFieldId

public static final int getOutboundQueueCountFieldId()

Get the field id for 'outboundQueueCount'

This method can be used to set field interests.

See Also:

getOutboundQueueCount()

setOutboundQueueCount

public final void setOutboundQueueCount(int val)

Description copied from interface: ISrvMonAdminClientStats

Sets the value of 'outboundQueueCount'

Field Description

The number of elements in the client's outbound queue

Specified by:

setOutboundQueueCount in interface ISrvMonAdminClientStats

Parameters:

val - The value to set.

getOutboundQueueCount

public final int getOutboundQueueCount()

Description copied from interface: ISrvMonAdminClientStats

Gets the value of 'outboundQueueCount'

Field Description

The number of elements in the client's outbound queue

Specified by:

getOutboundQueueCount in interface ISrvMonAdminClientStats

Returns:

The number of elements in the client's outbound queue

setOutboundQueueCountFrom

public final void setOutboundQueueCountFrom(com.neeve.xbuf.XbufVariableIntField val)

getOutboundQueueCountField

public final com.neeve.xbuf.XbufVariableIntField getOutboundQueueCountField()

hasOutboundQueueCount

public final boolean hasOutboundQueueCount()

Description copied from interface: ISrvMonAdminClientStats

Checks for the presence of 'outboundQueueCount'

Field Description

The number of elements in the client's outbound queue

Specified by:

hasOutboundQueueCount in interface ISrvMonAdminClientStats

See Also:

ISrvMonAdminClientStats.getOutboundQueueCount()

clearOutboundQueueCount

public final void clearOutboundQueueCount()

Description copied from interface: ISrvMonAdminClientStats

Clears the value of 'outboundQueueCount'

Field Description

The number of elements in the client's outbound queue

Specified by:

clearOutboundQueueCount in interface ISrvMonAdminClientStats

See Also:

ISrvMonAdminClientStats.setOutboundQueueCount(int)

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: ISrvMonAdminClientStats

Sets the value of 'name'

Field Description

The name of the admin client.

Specified by:

setName in interface ISrvMonAdminClientStats

Parameters:

val - The value to set.

getName

public final String getName()

Description copied from interface: ISrvMonAdminClientStats

Gets the value of 'name'

Field Description

The name of the admin client.

Specified by:

getName in interface ISrvMonAdminClientStats

Returns:

The name of the admin client.

lendName

public final void lendName(XString val)

Description copied from interface: ISrvMonAdminClientStats

Sets the value of 'name'

Field Description

The name of the admin client.

Specified by:

lendName in interface ISrvMonAdminClientStats

Parameters:

val - The value to set.

setNameFrom

public final void setNameFrom(long val)

Description copied from interface: ISrvMonAdminClientStats

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

Field Description

The name of the admin client.

NOTE:
This is the same as calling ISrvMonAdminClientStats.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 ISrvMonAdminClientStats

getNameTo

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

Description copied from interface: ISrvMonAdminClientStats

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

Field Description

The name of the admin client.

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 ISrvMonAdminClientStats

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: ISrvMonAdminClientStats

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

Field Description

The name of the admin client.

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

Specified by:

setNameFrom in interface ISrvMonAdminClientStats

getNameTo

public final void getNameTo(XString val)

Description copied from interface: ISrvMonAdminClientStats

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

Field Description

The name of the admin client.

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

Specified by:

getNameTo in interface ISrvMonAdminClientStats

See Also:

ISrvMonAdminClientStats.getName()

getNameUnsafe

public final XString getNameUnsafe()

Description copied from interface: ISrvMonAdminClientStats

Gets the raw value of 'name'.

Field Description

The name of the admin client.

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 ISrvMonAdminClientStats

Returns:

the field's raw value

See Also:

ISrvMonAdminClientStats.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: ISrvMonAdminClientStats

Checks for the presence of 'name'

Field Description

The name of the admin client.

Specified by:

hasName in interface ISrvMonAdminClientStats

See Also:

ISrvMonAdminClientStats.getName()

clearName

public final void clearName()

Description copied from interface: ISrvMonAdminClientStats

Clears the value of 'name'

Field Description

The name of the admin client.

Specified by:

clearName in interface ISrvMonAdminClientStats

See Also:

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

deserializeFromIOElasticBuffer

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

deserializeFromByteArray

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

deserializeFromByteArray

public final SrvMonAdminClientStats deserializeFromByteArray(byte[] array)

deserializeFromByteBuffer

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

deserializeFromByteBuffer

public final SrvMonAdminClientStats deserializeFromByteBuffer(ByteBuffer buffer)

deserializeFromNative

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

deserializeFromNative

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

Returns:

Return 'this' object for method invocation chaining.

setPool

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

Returns:

Return 'this' object for method invocation chaining.

getPool

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

Returns:

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

isReferenceCounted

public final boolean isReferenceCounted()

acquire

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

Creates a copy of this SrvMonAdminClientStats.

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

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

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

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