com.neeve.server.mon
Class SrvMonAppStats

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

All Implemented Interfaces:

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

Groups together stats for an application.

Nested Class Summary

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

Field Summary

static SrvMonAppStats[]

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

Constructor Summary

SrvMonAppStats()

SrvMonAppStats(int initialBackingBufferSize)

Method Summary

SrvMonAppStats	acquire()
void	addBusBindingStats(SrvMonAppBusBindingStats val) Adds the provided value to the list of 'busBindingStats' values.
void	clearAppName() Clears the value of 'appName' Field Description The application name
void	clearBusBindingStats() Clears the value of 'busBindingStats' Field Description The applications messaging stats for each configured bus
void	clearContent()
void	clearEngineStats() Clears the value of 'engineStats' Field Description The application's engine stats
void	clearEventMultiplexerStats() Clears the value of 'eventMultiplexerStats' Field Description The application's input event multiplexer stats
void	clearStoreBindingStats() Clears the value of 'storeBindingStats' Field Description The application's replication and persistent disk storage stats
void	clearUserStats() Clears the value of 'userStats' Field Description The application's user defined stats
void	clearXRogType()
Object	clone() Creates a clone of this object.
SrvMonAppStats	copy() Creates a copy of this SrvMonAppStats.
void	copyInto(SrvMonAppStats copy) Copies the contents of this SrvMonAppStats into the target.
static SrvMonAppStats	create()
static SrvMonAppStats	createFrom(byte[] serializedContainer)
static SrvMonAppStats	createFrom(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
static SrvMonAppStats	createFromSerializedXbufContainer(byte[] serializedContainer)
static SrvMonAppStats	createFromSerializedXbufContainer(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
static com.neeve.xbuf.XbufSchema	createSchema()
SrvMonAppStats	deserializeFromByteArray(byte[] array)
SrvMonAppStats	deserializeFromByteArray(byte[] array, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonAppStats	deserializeFromByteBuffer(ByteBuffer buffer)
SrvMonAppStats	deserializeFromByteBuffer(ByteBuffer buffer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonAppStats	deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length)
SrvMonAppStats	deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonAppStats	deserializeFromNative(long address, int offset, int length)
SrvMonAppStats	deserializeFromNative(long address, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
int	desync(PktBuffer buffer, int pos, boolean frameOnly)
void	desyncFieldBitmask()
void	dispose()
String	getAppName() Gets the value of 'appName' Field Description The application name
com.neeve.xbuf.XbufStringField	getAppNameField()
static int	getAppNameFieldId() Get the field id for 'appName' This method can be used to set field interests.
<T extends XString> T	getAppNameTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getAppNameTo(XString val) Copies the value of 'appName' into the provided XString.
XString	getAppNameUnsafe() Gets the raw value of 'appName'.
PktBuffer	getBackingBuffer()
SrvMonAppBusBindingStats[]	getBusBindingStats() Gets the value of 'busBindingStats' If the field is not set this method will return null.
SrvMonAppBusBindingStats[]	getBusBindingStatsEmptyIfNull() Gets the value of 'busBindingStats' or an empty array if the value is null or not set.
static int	getBusBindingStatsFieldId() Get the field id for 'busBindingStats' This method can be used to set field interests.
XIterator<SrvMonAppBusBindingStats>	getBusBindingStatsIterator() Gets the value of 'busBindingStats' as iterator of values.
static com.neeve.xbuf.XbufDesyncPolicy	getDesyncPolicy()
SrvMonAppEngineStats	getEngineStats() Gets the value of 'engineStats' Field Description The application's engine stats
static int	getEngineStatsFieldId() Get the field id for 'engineStats' This method can be used to set field interests.
void	getEngineStatsTo(SrvMonAppEngineStats to) Copies the value of SrvMonAppEngineStats into the provided value.
SrvMonAppEventMultiplexerStats	getEventMultiplexerStats() Gets the value of 'eventMultiplexerStats' Field Description The application's input event multiplexer stats
static int	getEventMultiplexerStatsFieldId() Get the field id for 'eventMultiplexerStats' This method can be used to set field interests.
void	getEventMultiplexerStatsTo(SrvMonAppEventMultiplexerStats to) Copies the value of SrvMonAppEventMultiplexerStats into the provided value.
boolean	getIsReadOnly()
int	getOwnerCount()
UtlPool<SrvMonAppStats>	getPool() Get a pool item's pool.
int	getSerializeToNativeLength()
SrvMonAppStoreBindingStats	getStoreBindingStats() Gets the value of 'storeBindingStats' Field Description The application's replication and persistent disk storage stats
static int	getStoreBindingStatsFieldId() Get the field id for 'storeBindingStats' This method can be used to set field interests.
void	getStoreBindingStatsTo(SrvMonAppStoreBindingStats to) Copies the value of SrvMonAppStoreBindingStats into the provided value.
SrvMonUserStats	getUserStats() Gets the value of 'userStats' Field Description The application's user defined stats
static int	getUserStatsFieldId() Get the field id for 'userStats' This method can be used to set field interests.
void	getUserStatsTo(SrvMonUserStats to) Copies the value of SrvMonUserStats into the provided value.
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	hasAppName() Checks for the presence of 'appName' Field Description The application name
boolean	hasEngineStats() Checks for the presence of 'engineStats' Field Description The application's engine stats
boolean	hasEventMultiplexerStats() Checks for the presence of 'eventMultiplexerStats' Field Description The application's input event multiplexer stats
boolean	hasStoreBindingStats() Checks for the presence of 'storeBindingStats' Field Description The application's replication and persistent disk storage stats
boolean	hasUserStats() Checks for the presence of 'userStats' Field Description The application's user defined stats
boolean	hasXRogType()
SrvMonAppStats	init() Initialize an item.
boolean	isBufferBacked()
boolean	isDirty()
boolean	isReferenceCounted()
boolean	isValid() Tests if this object has any validation errors.
void	lendAppName(XString val) Sets the value of 'appName' Field Description The application name
void	lendBusBindingStats(SrvMonAppBusBindingStats val) Adds the provided value to the list of 'busBindingStats' values and acquires a reference to it.
void	lendBusBindingStats(SrvMonAppBusBindingStats[] val) Lends the value of 'busBindingStats' Field Description The applications messaging stats for each configured bus NOTE: It is illegal to hold onto an entity 'set' on a message post the disposal of the container message.
void	lendBusBindingStatsFrom(XIterator<SrvMonAppBusBindingStats> val) Sets the value of 'busBindingStats' by lending the values from the provided iterator.
void	lendEngineStats(SrvMonAppEngineStats val) 'Lends' a reference of the SrvMonAppEngineStats to the message for this field.
void	lendEventMultiplexerStats(SrvMonAppEventMultiplexerStats val) 'Lends' a reference of the SrvMonAppEventMultiplexerStats to the message for this field.
void	lendStoreBindingStats(SrvMonAppStoreBindingStats val) 'Lends' a reference of the SrvMonAppStoreBindingStats to the message for this field.
void	lendUserStats(SrvMonUserStats val) 'Lends' a reference of the SrvMonUserStats to the message for this field.
static void	optimizeFor(int val)
byte[]	serializeToByteArray()
ByteBuffer	serializeToByteBuffer()
com.neeve.io.IOBuffer	serializeToIOBuffer(boolean useNative)
int	serializeToNative(long address, int addressOffset)
void	setAppName(String val) Sets the value of 'appName' Field Description The application name
void	setAppNameFrom(long val) Sets the value of this String field to the given numeric value.
void	setAppNameFrom(com.neeve.xbuf.XbufStringField val)
void	setAppNameFrom(XString val) Copies the provided XString value into this object's 'appName'.
void	setAsReadOnly()
void	setBusBindingStats(SrvMonAppBusBindingStats[] val) Sets the value of 'busBindingStats' Field Description The applications messaging stats for each configured bus
void	setBusBindingStatsFrom(XIterator<SrvMonAppBusBindingStats> val) Sets the value of 'busBindingStats' using the values from the provided iterator.
static void	setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
void	setEngineStats(SrvMonAppEngineStats val) Sets the value of 'engineStats' Field Description The application's engine stats
void	setEventMultiplexerStats(SrvMonAppEventMultiplexerStats val) Sets the value of 'eventMultiplexerStats' Field Description The application's input event multiplexer stats
static void	setFieldInterest(List<Integer> fieldIds)
SrvMonAppStats	setPool(UtlPool<SrvMonAppStats> pool) Set a pool item's pool.
void	setStoreBindingStats(SrvMonAppStoreBindingStats val) Sets the value of 'storeBindingStats' Field Description The application's replication and persistent disk storage stats
void	setUserStats(SrvMonUserStats val) Sets the value of 'userStats' Field Description The application's user defined stats
void	setXRogType(short val)
void	setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)
void	sync()
void	syncFieldBitmask()
SrvMonAppBusBindingStats[]	takeBusBindingStats() Takes the value of 'busBindingStats' Field Description The applications messaging stats for each configured bus NOTE: A nested entity reference returned by ISrvMonAppStats.getBusBindingStats() 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.
SrvMonAppEngineStats	takeEngineStats() 'Takes' a reference to the engineStats field from the message.
SrvMonAppEventMultiplexerStats	takeEventMultiplexerStats() 'Takes' a reference to the eventMultiplexerStats field from the message.
SrvMonAppStoreBindingStats	takeStoreBindingStats() 'Takes' a reference to the storeBindingStats field from the message.
SrvMonUserStats	takeUserStats() 'Takes' a reference to the userStats field from the message.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_ARRAY

public static final SrvMonAppStats[] EMPTY_ARRAY

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

Constructor Detail

SrvMonAppStats

public SrvMonAppStats()

SrvMonAppStats

public SrvMonAppStats(int initialBackingBufferSize)

Method Detail

create

public static SrvMonAppStats create()

createFromSerializedXbufContainer

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

createFromSerializedXbufContainer

public static SrvMonAppStats createFromSerializedXbufContainer(byte[] serializedContainer)

createFrom

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

createFrom

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

getAppNameFieldId

public static final int getAppNameFieldId()

Get the field id for 'appName'

This method can be used to set field interests.

See Also:

getAppName()

setAppName

public final void setAppName(String val)

Description copied from interface: ISrvMonAppStats

Sets the value of 'appName'

Field Description

The application name

Specified by:

setAppName in interface ISrvMonAppStats

Parameters:

val - The value to set.

getAppName

public final String getAppName()

Description copied from interface: ISrvMonAppStats

Gets the value of 'appName'

Field Description

The application name

Specified by:

getAppName in interface ISrvMonAppStats

Returns:

The application name

lendAppName

public final void lendAppName(XString val)

Description copied from interface: ISrvMonAppStats

Sets the value of 'appName'

Field Description

The application name

Specified by:

lendAppName in interface ISrvMonAppStats

Parameters:

val - The value to set.

setAppNameFrom

public final void setAppNameFrom(long val)

Description copied from interface: ISrvMonAppStats

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

Field Description

The application name

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

Specified by:

setAppNameFrom in interface ISrvMonAppStats

getAppNameTo

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

Description copied from interface: ISrvMonAppStats

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

Field Description

The application name

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:

getAppNameTo in interface ISrvMonAppStats

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.

setAppNameFrom

public final void setAppNameFrom(XString val)

Description copied from interface: ISrvMonAppStats

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

Field Description

The application name

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

Specified by:

setAppNameFrom in interface ISrvMonAppStats

getAppNameTo

public final void getAppNameTo(XString val)

Description copied from interface: ISrvMonAppStats

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

Field Description

The application name

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

Specified by:

getAppNameTo in interface ISrvMonAppStats

See Also:

ISrvMonAppStats.getAppName()

getAppNameUnsafe

public final XString getAppNameUnsafe()

Description copied from interface: ISrvMonAppStats

Gets the raw value of 'appName'.

Field Description

The application name

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:

getAppNameUnsafe in interface ISrvMonAppStats

Returns:

the field's raw value

See Also:

ISrvMonAppStats.getAppName()

setAppNameFrom

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

getAppNameField

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

hasAppName

public final boolean hasAppName()

Description copied from interface: ISrvMonAppStats

Checks for the presence of 'appName'

Field Description

The application name

Specified by:

hasAppName in interface ISrvMonAppStats

See Also:

ISrvMonAppStats.getAppName()

clearAppName

public final void clearAppName()

Description copied from interface: ISrvMonAppStats

Clears the value of 'appName'

Field Description

The application name

Specified by:

clearAppName in interface ISrvMonAppStats

See Also:

ISrvMonAppStats.setAppName(String)

getEngineStatsFieldId

public static final int getEngineStatsFieldId()

Get the field id for 'engineStats'

This method can be used to set field interests.

See Also:

getEngineStats()

setEngineStats

public final void setEngineStats(SrvMonAppEngineStats val)

Description copied from interface: ISrvMonAppStats

Sets the value of 'engineStats'

Field Description

The application's engine stats

Specified by:

setEngineStats in interface ISrvMonAppStats

Parameters:

val - The value to set.

lendEngineStats

public final void lendEngineStats(SrvMonAppEngineStats val)

Description copied from interface: ISrvMonAppStats

'Lends' a reference of the SrvMonAppEngineStats to the message for this field.

Field Description

The application's engine 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:

lendEngineStats in interface ISrvMonAppStats

Parameters:

val - the value to 'lend' to lend.

getEngineStats

public final SrvMonAppEngineStats getEngineStats()

Description copied from interface: ISrvMonAppStats

Gets the value of 'engineStats'

Field Description

The application's engine stats

Specified by:

getEngineStats in interface ISrvMonAppStats

Returns:

The application's engine stats

getEngineStatsTo

public final void getEngineStatsTo(SrvMonAppEngineStats to)

Description copied from interface: ISrvMonAppStats

Copies the value of SrvMonAppEngineStats into the provided value.

IF the value is not set, then the contents of the provided SrvMonAppEngineStats are cleared.

Specified by:

getEngineStatsTo in interface ISrvMonAppStats

Parameters:

to - the value to copy into

See Also:

SrvMonAppEngineStats.copyInto(SrvMonAppEngineStats)

takeEngineStats

public final SrvMonAppEngineStats takeEngineStats()

Description copied from interface: ISrvMonAppStats

'Takes' a reference to the engineStats field from the message.

Field Description

The application's engine stats

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

takeEngineStats in interface ISrvMonAppStats

Returns:

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

hasEngineStats

public final boolean hasEngineStats()

Description copied from interface: ISrvMonAppStats

Checks for the presence of 'engineStats'

Field Description

The application's engine stats

Specified by:

hasEngineStats in interface ISrvMonAppStats

See Also:

ISrvMonAppStats.getEngineStats()

clearEngineStats

public final void clearEngineStats()

Description copied from interface: ISrvMonAppStats

Clears the value of 'engineStats'

Field Description

The application's engine stats

Specified by:

clearEngineStats in interface ISrvMonAppStats

See Also:

ISrvMonAppStats.setEngineStats(SrvMonAppEngineStats)

getEventMultiplexerStatsFieldId

public static final int getEventMultiplexerStatsFieldId()

Get the field id for 'eventMultiplexerStats'

This method can be used to set field interests.

See Also:

getEventMultiplexerStats()

setEventMultiplexerStats

public final void setEventMultiplexerStats(SrvMonAppEventMultiplexerStats val)

Description copied from interface: ISrvMonAppStats

Sets the value of 'eventMultiplexerStats'

Field Description

The application's input event multiplexer stats

Specified by:

setEventMultiplexerStats in interface ISrvMonAppStats

Parameters:

val - The value to set.

lendEventMultiplexerStats

public final void lendEventMultiplexerStats(SrvMonAppEventMultiplexerStats val)

Description copied from interface: ISrvMonAppStats

'Lends' a reference of the SrvMonAppEventMultiplexerStats to the message for this field.

Field Description

The application's input event multiplexer 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:

lendEventMultiplexerStats in interface ISrvMonAppStats

Parameters:

val - the value to 'lend' to lend.

getEventMultiplexerStats

public final SrvMonAppEventMultiplexerStats getEventMultiplexerStats()

Description copied from interface: ISrvMonAppStats

Gets the value of 'eventMultiplexerStats'

Field Description

The application's input event multiplexer stats

Specified by:

getEventMultiplexerStats in interface ISrvMonAppStats

Returns:

The application's input event multiplexer stats

getEventMultiplexerStatsTo

public final void getEventMultiplexerStatsTo(SrvMonAppEventMultiplexerStats to)

Description copied from interface: ISrvMonAppStats

Copies the value of SrvMonAppEventMultiplexerStats into the provided value.

IF the value is not set, then the contents of the provided SrvMonAppEventMultiplexerStats are cleared.

Specified by:

getEventMultiplexerStatsTo in interface ISrvMonAppStats

Parameters:

to - the value to copy into

See Also:

SrvMonAppEventMultiplexerStats.copyInto(SrvMonAppEventMultiplexerStats)

takeEventMultiplexerStats

public final SrvMonAppEventMultiplexerStats takeEventMultiplexerStats()

Description copied from interface: ISrvMonAppStats

'Takes' a reference to the eventMultiplexerStats field from the message.

Field Description

The application's input event multiplexer stats

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

takeEventMultiplexerStats in interface ISrvMonAppStats

Returns:

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

hasEventMultiplexerStats

public final boolean hasEventMultiplexerStats()

Description copied from interface: ISrvMonAppStats

Checks for the presence of 'eventMultiplexerStats'

Field Description

The application's input event multiplexer stats

Specified by:

hasEventMultiplexerStats in interface ISrvMonAppStats

See Also:

ISrvMonAppStats.getEventMultiplexerStats()

clearEventMultiplexerStats

public final void clearEventMultiplexerStats()

Description copied from interface: ISrvMonAppStats

Clears the value of 'eventMultiplexerStats'

Field Description

The application's input event multiplexer stats

Specified by:

clearEventMultiplexerStats in interface ISrvMonAppStats

See Also:

ISrvMonAppStats.setEventMultiplexerStats(SrvMonAppEventMultiplexerStats)

getStoreBindingStatsFieldId

public static final int getStoreBindingStatsFieldId()

Get the field id for 'storeBindingStats'

This method can be used to set field interests.

See Also:

getStoreBindingStats()

setStoreBindingStats

public final void setStoreBindingStats(SrvMonAppStoreBindingStats val)

Description copied from interface: ISrvMonAppStats

Sets the value of 'storeBindingStats'

Field Description

The application's replication and persistent disk storage stats

Specified by:

setStoreBindingStats in interface ISrvMonAppStats

Parameters:

val - The value to set.

lendStoreBindingStats

public final void lendStoreBindingStats(SrvMonAppStoreBindingStats val)

Description copied from interface: ISrvMonAppStats

'Lends' a reference of the SrvMonAppStoreBindingStats to the message for this field.

Field Description

The application's replication and persistent disk storage 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:

lendStoreBindingStats in interface ISrvMonAppStats

Parameters:

val - the value to 'lend' to lend.

getStoreBindingStats

public final SrvMonAppStoreBindingStats getStoreBindingStats()

Description copied from interface: ISrvMonAppStats

Gets the value of 'storeBindingStats'

Field Description

The application's replication and persistent disk storage stats

Specified by:

getStoreBindingStats in interface ISrvMonAppStats

Returns:

The application's replication and persistent disk storage stats

getStoreBindingStatsTo

public final void getStoreBindingStatsTo(SrvMonAppStoreBindingStats to)

Description copied from interface: ISrvMonAppStats

Copies the value of SrvMonAppStoreBindingStats into the provided value.

IF the value is not set, then the contents of the provided SrvMonAppStoreBindingStats are cleared.

Specified by:

getStoreBindingStatsTo in interface ISrvMonAppStats

Parameters:

to - the value to copy into

See Also:

SrvMonAppStoreBindingStats.copyInto(SrvMonAppStoreBindingStats)

takeStoreBindingStats

public final SrvMonAppStoreBindingStats takeStoreBindingStats()

Description copied from interface: ISrvMonAppStats

'Takes' a reference to the storeBindingStats field from the message.

Field Description

The application's replication and persistent disk storage stats

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

takeStoreBindingStats in interface ISrvMonAppStats

Returns:

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

hasStoreBindingStats

public final boolean hasStoreBindingStats()

Description copied from interface: ISrvMonAppStats

Checks for the presence of 'storeBindingStats'

Field Description

The application's replication and persistent disk storage stats

Specified by:

hasStoreBindingStats in interface ISrvMonAppStats

See Also:

ISrvMonAppStats.getStoreBindingStats()

clearStoreBindingStats

public final void clearStoreBindingStats()

Description copied from interface: ISrvMonAppStats

Clears the value of 'storeBindingStats'

Field Description

The application's replication and persistent disk storage stats

Specified by:

clearStoreBindingStats in interface ISrvMonAppStats

See Also:

ISrvMonAppStats.setStoreBindingStats(SrvMonAppStoreBindingStats)

getBusBindingStatsFieldId

public static final int getBusBindingStatsFieldId()

Get the field id for 'busBindingStats'

This method can be used to set field interests.

See Also:

getBusBindingStats()

setBusBindingStats

public final void setBusBindingStats(SrvMonAppBusBindingStats[] val)

Description copied from interface: ISrvMonAppStats

Sets the value of 'busBindingStats'

Field Description

The applications messaging stats for each configured bus

Specified by:

setBusBindingStats in interface ISrvMonAppStats

Parameters:

val - The value to set.

setBusBindingStatsFrom

public final void setBusBindingStatsFrom(XIterator<SrvMonAppBusBindingStats> val)

Description copied from interface: ISrvMonAppStats

Sets the value of 'busBindingStats' 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 'busBindingStats' accessor can copy the values without iteration.

Field Description

The applications messaging stats for each configured bus

NOTE:
Passing a null or empty list has the same affect as calling ISrvMonAppStats.setBusBindingStats(SrvMonAppBusBindingStats[]) with a value of null.

Specified by:

setBusBindingStatsFrom in interface ISrvMonAppStats

Parameters:

val - the values to set.

lendBusBindingStatsFrom

public final void lendBusBindingStatsFrom(XIterator<SrvMonAppBusBindingStats> val)

Description copied from interface: ISrvMonAppStats

Sets the value of 'busBindingStats' 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 'busBindingStats' accessor can copy the values without iteration.

Field Description

The applications messaging stats for each configured bus

NOTE:
Passing a null or empty list has the same affect as calling ISrvMonAppStats.setBusBindingStats(SrvMonAppBusBindingStats[]) with a value of null.

Specified by:

lendBusBindingStatsFrom in interface ISrvMonAppStats

Parameters:

val - the values to set.

lendBusBindingStats

public final void lendBusBindingStats(SrvMonAppBusBindingStats[] val)

Description copied from interface: ISrvMonAppStats

Lends the value of 'busBindingStats'

Field Description

The applications messaging stats for each configured bus

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:

lendBusBindingStats in interface ISrvMonAppStats

Parameters:

val - the value to 'lend' to lend.

addBusBindingStats

public final void addBusBindingStats(SrvMonAppBusBindingStats val)

Description copied from interface: ISrvMonAppStats

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

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

The applications messaging stats for each configured bus

Specified by:

addBusBindingStats in interface ISrvMonAppStats

Parameters:

val - the value to add.

lendBusBindingStats

public final void lendBusBindingStats(SrvMonAppBusBindingStats val)

Description copied from interface: ISrvMonAppStats

Adds the provided value to the list of 'busBindingStats' 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 'busBindingStats' 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

The applications messaging stats for each configured bus

Specified by:

lendBusBindingStats in interface ISrvMonAppStats

Parameters:

val - the value to add.

getBusBindingStats

public final SrvMonAppBusBindingStats[] getBusBindingStats()

Description copied from interface: ISrvMonAppStats

Gets the value of 'busBindingStats'

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

Field Description

The applications messaging stats for each configured bus

Specified by:

getBusBindingStats in interface ISrvMonAppStats

Returns:

The applications messaging stats for each configured bus If the field is not set this method will return null.

getBusBindingStatsEmptyIfNull

public final SrvMonAppBusBindingStats[] getBusBindingStatsEmptyIfNull()

Description copied from interface: ISrvMonAppStats

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

Field Description

The applications messaging stats for each configured bus

Specified by:

getBusBindingStatsEmptyIfNull in interface ISrvMonAppStats

Returns:

The applications messaging stats for each configured bus or an empty array if null if not set.

See Also:

ISrvMonAppStats.getBusBindingStats()

getBusBindingStatsIterator

public final XIterator<SrvMonAppBusBindingStats> getBusBindingStatsIterator()

Description copied from interface: ISrvMonAppStats

Gets the value of 'busBindingStats' 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

The applications messaging stats for each configured bus

Specified by:

getBusBindingStatsIterator in interface ISrvMonAppStats

Returns:

An iterator containing this field values.

takeBusBindingStats

public final SrvMonAppBusBindingStats[] takeBusBindingStats()

Description copied from interface: ISrvMonAppStats

Takes the value of 'busBindingStats'

Field Description

The applications messaging stats for each configured bus

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

takeBusBindingStats in interface ISrvMonAppStats

Returns:

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

clearBusBindingStats

public final void clearBusBindingStats()

Description copied from interface: ISrvMonAppStats

Clears the value of 'busBindingStats'

Field Description

The applications messaging stats for each configured bus

Specified by:

clearBusBindingStats in interface ISrvMonAppStats

See Also:

ISrvMonAppStats.setBusBindingStats(SrvMonAppBusBindingStats[])

getUserStatsFieldId

public static final int getUserStatsFieldId()

Get the field id for 'userStats'

This method can be used to set field interests.

See Also:

getUserStats()

setUserStats

public final void setUserStats(SrvMonUserStats val)

Description copied from interface: ISrvMonAppStats

Sets the value of 'userStats'

Field Description

The application's user defined stats

Specified by:

setUserStats in interface ISrvMonAppStats

Parameters:

val - The value to set.

lendUserStats

public final void lendUserStats(SrvMonUserStats val)

Description copied from interface: ISrvMonAppStats

'Lends' a reference of the SrvMonUserStats to the message for this field.

Field Description

The application's user defined 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:

lendUserStats in interface ISrvMonAppStats

Parameters:

val - the value to 'lend' to lend.

getUserStats

public final SrvMonUserStats getUserStats()

Description copied from interface: ISrvMonAppStats

Gets the value of 'userStats'

Field Description

The application's user defined stats

Specified by:

getUserStats in interface ISrvMonAppStats

Returns:

The application's user defined stats

getUserStatsTo

public final void getUserStatsTo(SrvMonUserStats to)

Description copied from interface: ISrvMonAppStats

Copies the value of SrvMonUserStats into the provided value.

IF the value is not set, then the contents of the provided SrvMonUserStats are cleared.

Specified by:

getUserStatsTo in interface ISrvMonAppStats

Parameters:

to - the value to copy into

See Also:

SrvMonUserStats.copyInto(SrvMonUserStats)

takeUserStats

public final SrvMonUserStats takeUserStats()

Description copied from interface: ISrvMonAppStats

'Takes' a reference to the userStats field from the message.

Field Description

The application's user defined stats

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

takeUserStats in interface ISrvMonAppStats

Returns:

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

hasUserStats

public final boolean hasUserStats()

Description copied from interface: ISrvMonAppStats

Checks for the presence of 'userStats'

Field Description

The application's user defined stats

Specified by:

hasUserStats in interface ISrvMonAppStats

See Also:

ISrvMonAppStats.getUserStats()

clearUserStats

public final void clearUserStats()

Description copied from interface: ISrvMonAppStats

Clears the value of 'userStats'

Field Description

The application's user defined stats

Specified by:

clearUserStats in interface ISrvMonAppStats

See Also:

ISrvMonAppStats.setUserStats(SrvMonUserStats)

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

deserializeFromIOElasticBuffer

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

deserializeFromByteArray

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

deserializeFromByteArray

public final SrvMonAppStats deserializeFromByteArray(byte[] array)

deserializeFromByteBuffer

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

deserializeFromByteBuffer

public final SrvMonAppStats deserializeFromByteBuffer(ByteBuffer buffer)

deserializeFromNative

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

deserializeFromNative

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

Returns:

Return 'this' object for method invocation chaining.

setPool

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

Returns:

Return 'this' object for method invocation chaining.

getPool

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

Returns:

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

isReferenceCounted

public final boolean isReferenceCounted()

acquire

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

Creates a copy of this SrvMonAppStats.

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

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

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

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