com.neeve.server.mon
Class SrvMonAppEventMultiplexerStats

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

All Implemented Interfaces:

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

Stats relating to an application's Aep Engine input queue.

The engine input queue holds stats that relate to how long events such as messages or acks are enqueued waiting for processing by the application's Aep Engine. Events enqueued for an engine go through two levels of queue to promote fairness and facilitate event scheduled. An event is first enqueued in a feeder queue private to the thread enqueueing it and then is promoted into the the engine's input disruptor.

Nested Class Summary

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

Field Summary

static SrvMonAppEventMultiplexerStats[]

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

Constructor Summary

SrvMonAppEventMultiplexerStats()

SrvMonAppEventMultiplexerStats(int initialBackingBufferSize)

Method Summary

SrvMonAppEventMultiplexerStats	acquire()
void	addFeederQueueStats(SrvMonAppEventMultiplexerFeederQueueStats val) Adds the provided value to the list of 'feederQueueStats' values.
void	clearContent()
void	clearDisruptorStats() Clears the value of 'disruptorStats' Field Description Stats relating to events' passage through the engine's input disruptor
void	clearFeederQueueStats() Clears the value of 'feederQueueStats' Field Description Stats relating to events' passage through the engine's input multiplexer feeder queues.
void	clearLastDecongested() Clears the value of 'lastDecongested' Field Description The last feeder queue decongested.
void	clearMaxConcurrency() Clears the value of 'maxConcurrency' Field Description The maximum number of feeder queue supported by the multiplexer.
void	clearScheduleQueueSize() Clears the value of 'scheduleQueueSize' Field Description The number of scheduled events awaiting dispatch.
void	clearXRogType()
Object	clone() Creates a clone of this object.
SrvMonAppEventMultiplexerStats	copy() Creates a copy of this SrvMonAppEventMultiplexerStats.
void	copyInto(SrvMonAppEventMultiplexerStats copy) Copies the contents of this SrvMonAppEventMultiplexerStats into the target.
static SrvMonAppEventMultiplexerStats	create()
static SrvMonAppEventMultiplexerStats	createFrom(byte[] serializedContainer)
static SrvMonAppEventMultiplexerStats	createFrom(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
static SrvMonAppEventMultiplexerStats	createFromSerializedXbufContainer(byte[] serializedContainer)
static SrvMonAppEventMultiplexerStats	createFromSerializedXbufContainer(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
static com.neeve.xbuf.XbufSchema	createSchema()
SrvMonAppEventMultiplexerStats	deserializeFromByteArray(byte[] array)
SrvMonAppEventMultiplexerStats	deserializeFromByteArray(byte[] array, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonAppEventMultiplexerStats	deserializeFromByteBuffer(ByteBuffer buffer)
SrvMonAppEventMultiplexerStats	deserializeFromByteBuffer(ByteBuffer buffer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonAppEventMultiplexerStats	deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length)
SrvMonAppEventMultiplexerStats	deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonAppEventMultiplexerStats	deserializeFromNative(long address, int offset, int length)
SrvMonAppEventMultiplexerStats	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()
SrvMonDisruptorStats	getDisruptorStats() Gets the value of 'disruptorStats' Field Description Stats relating to events' passage through the engine's input disruptor
static int	getDisruptorStatsFieldId() Get the field id for 'disruptorStats' This method can be used to set field interests.
void	getDisruptorStatsTo(SrvMonDisruptorStats to) Copies the value of SrvMonDisruptorStats into the provided value.
SrvMonAppEventMultiplexerFeederQueueStats[]	getFeederQueueStats() Gets the value of 'feederQueueStats' If the field is not set this method will return null.
SrvMonAppEventMultiplexerFeederQueueStats[]	getFeederQueueStatsEmptyIfNull() Gets the value of 'feederQueueStats' or an empty array if the value is null or not set.
static int	getFeederQueueStatsFieldId() Get the field id for 'feederQueueStats' This method can be used to set field interests.
XIterator<SrvMonAppEventMultiplexerFeederQueueStats>	getFeederQueueStatsIterator() Gets the value of 'feederQueueStats' as iterator of values.
boolean	getIsReadOnly()
int	getLastDecongested() Gets the value of 'lastDecongested' Field Description The last feeder queue decongested.
com.neeve.xbuf.XbufVariableIntField	getLastDecongestedField()
static int	getLastDecongestedFieldId() Get the field id for 'lastDecongested' This method can be used to set field interests.
int	getMaxConcurrency() Gets the value of 'maxConcurrency' Field Description The maximum number of feeder queue supported by the multiplexer.
com.neeve.xbuf.XbufVariableIntField	getMaxConcurrencyField()
static int	getMaxConcurrencyFieldId() Get the field id for 'maxConcurrency' This method can be used to set field interests.
int	getOwnerCount()
UtlPool<SrvMonAppEventMultiplexerStats>	getPool() Get a pool item's pool.
int	getScheduleQueueSize() Gets the value of 'scheduleQueueSize' Field Description The number of scheduled events awaiting dispatch.
com.neeve.xbuf.XbufVariableIntField	getScheduleQueueSizeField()
static int	getScheduleQueueSizeFieldId() Get the field id for 'scheduleQueueSize' This method can be used to set field interests.
int	getSerializeToNativeLength()
void	getValidationErrors(List<XString> results, String errorPrefix) Collects validation errors into the provided list.
short	getXRogType()
com.neeve.xbuf.XbufVariableShortField	getXRogTypeField()
static int	getXRogTypeFieldId() Get the field id for 'xRogType' This method can be used to set field interests.
boolean	hasDisruptorStats() Checks for the presence of 'disruptorStats' Field Description Stats relating to events' passage through the engine's input disruptor
boolean	hasLastDecongested() Checks for the presence of 'lastDecongested' Field Description The last feeder queue decongested.
boolean	hasMaxConcurrency() Checks for the presence of 'maxConcurrency' Field Description The maximum number of feeder queue supported by the multiplexer.
boolean	hasScheduleQueueSize() Checks for the presence of 'scheduleQueueSize' Field Description The number of scheduled events awaiting dispatch.
boolean	hasXRogType()
SrvMonAppEventMultiplexerStats	init() Initialize an item.
boolean	isBufferBacked()
boolean	isDirty()
boolean	isReferenceCounted()
boolean	isValid() Tests if this object has any validation errors.
void	lendDisruptorStats(SrvMonDisruptorStats val) 'Lends' a reference of the SrvMonDisruptorStats to the message for this field.
void	lendFeederQueueStats(SrvMonAppEventMultiplexerFeederQueueStats val) Adds the provided value to the list of 'feederQueueStats' values and acquires a reference to it.
void	lendFeederQueueStats(SrvMonAppEventMultiplexerFeederQueueStats[] val) Lends the value of 'feederQueueStats' Field Description Stats relating to events' passage through the engine's input multiplexer feeder queues.
void	lendFeederQueueStatsFrom(XIterator<SrvMonAppEventMultiplexerFeederQueueStats> val) Sets the value of 'feederQueueStats' by lending the values from the provided iterator.
static void	optimizeFor(int val)
byte[]	serializeToByteArray()
ByteBuffer	serializeToByteBuffer()
com.neeve.io.IOBuffer	serializeToIOBuffer(boolean useNative)
int	serializeToNative(long address, int addressOffset)
void	setAsReadOnly()
static void	setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
void	setDisruptorStats(SrvMonDisruptorStats val) Sets the value of 'disruptorStats' Field Description Stats relating to events' passage through the engine's input disruptor
void	setFeederQueueStats(SrvMonAppEventMultiplexerFeederQueueStats[] val) Sets the value of 'feederQueueStats' Field Description Stats relating to events' passage through the engine's input multiplexer feeder queues.
void	setFeederQueueStatsFrom(XIterator<SrvMonAppEventMultiplexerFeederQueueStats> val) Sets the value of 'feederQueueStats' using the values from the provided iterator.
static void	setFieldInterest(List<Integer> fieldIds)
void	setLastDecongested(int val) Sets the value of 'lastDecongested' Field Description The last feeder queue decongested.
void	setLastDecongestedFrom(com.neeve.xbuf.XbufVariableIntField val)
void	setMaxConcurrency(int val) Sets the value of 'maxConcurrency' Field Description The maximum number of feeder queue supported by the multiplexer.
void	setMaxConcurrencyFrom(com.neeve.xbuf.XbufVariableIntField val)
SrvMonAppEventMultiplexerStats	setPool(UtlPool<SrvMonAppEventMultiplexerStats> pool) Set a pool item's pool.
void	setScheduleQueueSize(int val) Sets the value of 'scheduleQueueSize' Field Description The number of scheduled events awaiting dispatch.
void	setScheduleQueueSizeFrom(com.neeve.xbuf.XbufVariableIntField val)
void	setXRogType(short val)
void	setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)
void	sync()
void	syncFieldBitmask()
SrvMonDisruptorStats	takeDisruptorStats() 'Takes' a reference to the disruptorStats field from the message.
SrvMonAppEventMultiplexerFeederQueueStats[]	takeFeederQueueStats() Takes the value of 'feederQueueStats' Field Description Stats relating to events' passage through the engine's input multiplexer feeder queues.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_ARRAY

public static final SrvMonAppEventMultiplexerStats[] EMPTY_ARRAY

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

Constructor Detail

SrvMonAppEventMultiplexerStats

public SrvMonAppEventMultiplexerStats()

SrvMonAppEventMultiplexerStats

public SrvMonAppEventMultiplexerStats(int initialBackingBufferSize)

Method Detail

create

public static SrvMonAppEventMultiplexerStats create()

createFromSerializedXbufContainer

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

createFromSerializedXbufContainer

public static SrvMonAppEventMultiplexerStats createFromSerializedXbufContainer(byte[] serializedContainer)

createFrom

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

createFrom

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

getLastDecongestedFieldId

public static final int getLastDecongestedFieldId()

Get the field id for 'lastDecongested'

This method can be used to set field interests.

See Also:

getLastDecongested()

setLastDecongested

public final void setLastDecongested(int val)

Description copied from interface: ISrvMonAppEventMultiplexerStats

Sets the value of 'lastDecongested'

Field Description

The last feeder queue decongested.

Specified by:

setLastDecongested in interface ISrvMonAppEventMultiplexerStats

Parameters:

val - The value to set.

getLastDecongested

public final int getLastDecongested()

Description copied from interface: ISrvMonAppEventMultiplexerStats

Gets the value of 'lastDecongested'

Field Description

The last feeder queue decongested.

Specified by:

getLastDecongested in interface ISrvMonAppEventMultiplexerStats

Returns:

The last feeder queue decongested.

setLastDecongestedFrom

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

getLastDecongestedField

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

hasLastDecongested

public final boolean hasLastDecongested()

Description copied from interface: ISrvMonAppEventMultiplexerStats

Checks for the presence of 'lastDecongested'

Field Description

The last feeder queue decongested.

Specified by:

hasLastDecongested in interface ISrvMonAppEventMultiplexerStats

See Also:

ISrvMonAppEventMultiplexerStats.getLastDecongested()

clearLastDecongested

public final void clearLastDecongested()

Description copied from interface: ISrvMonAppEventMultiplexerStats

Clears the value of 'lastDecongested'

Field Description

The last feeder queue decongested.

Specified by:

clearLastDecongested in interface ISrvMonAppEventMultiplexerStats

See Also:

ISrvMonAppEventMultiplexerStats.setLastDecongested(int)

getMaxConcurrencyFieldId

public static final int getMaxConcurrencyFieldId()

Get the field id for 'maxConcurrency'

This method can be used to set field interests.

See Also:

getMaxConcurrency()

setMaxConcurrency

public final void setMaxConcurrency(int val)

Description copied from interface: ISrvMonAppEventMultiplexerStats

Sets the value of 'maxConcurrency'

Field Description

The maximum number of feeder queue supported by the multiplexer.

Specified by:

setMaxConcurrency in interface ISrvMonAppEventMultiplexerStats

Parameters:

val - The value to set.

getMaxConcurrency

public final int getMaxConcurrency()

Description copied from interface: ISrvMonAppEventMultiplexerStats

Gets the value of 'maxConcurrency'

Field Description

The maximum number of feeder queue supported by the multiplexer.

Specified by:

getMaxConcurrency in interface ISrvMonAppEventMultiplexerStats

Returns:

The maximum number of feeder queue supported by the multiplexer.

setMaxConcurrencyFrom

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

getMaxConcurrencyField

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

hasMaxConcurrency

public final boolean hasMaxConcurrency()

Description copied from interface: ISrvMonAppEventMultiplexerStats

Checks for the presence of 'maxConcurrency'

Field Description

The maximum number of feeder queue supported by the multiplexer.

Specified by:

hasMaxConcurrency in interface ISrvMonAppEventMultiplexerStats

See Also:

ISrvMonAppEventMultiplexerStats.getMaxConcurrency()

clearMaxConcurrency

public final void clearMaxConcurrency()

Description copied from interface: ISrvMonAppEventMultiplexerStats

Clears the value of 'maxConcurrency'

Field Description

The maximum number of feeder queue supported by the multiplexer.

Specified by:

clearMaxConcurrency in interface ISrvMonAppEventMultiplexerStats

See Also:

ISrvMonAppEventMultiplexerStats.setMaxConcurrency(int)

getScheduleQueueSizeFieldId

public static final int getScheduleQueueSizeFieldId()

Get the field id for 'scheduleQueueSize'

This method can be used to set field interests.

See Also:

getScheduleQueueSize()

setScheduleQueueSize

public final void setScheduleQueueSize(int val)

Description copied from interface: ISrvMonAppEventMultiplexerStats

Sets the value of 'scheduleQueueSize'

Field Description

The number of scheduled events awaiting dispatch.

Specified by:

setScheduleQueueSize in interface ISrvMonAppEventMultiplexerStats

Parameters:

val - The value to set.

getScheduleQueueSize

public final int getScheduleQueueSize()

Description copied from interface: ISrvMonAppEventMultiplexerStats

Gets the value of 'scheduleQueueSize'

Field Description

The number of scheduled events awaiting dispatch.

Specified by:

getScheduleQueueSize in interface ISrvMonAppEventMultiplexerStats

Returns:

The number of scheduled events awaiting dispatch.

setScheduleQueueSizeFrom

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

getScheduleQueueSizeField

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

hasScheduleQueueSize

public final boolean hasScheduleQueueSize()

Description copied from interface: ISrvMonAppEventMultiplexerStats

Checks for the presence of 'scheduleQueueSize'

Field Description

The number of scheduled events awaiting dispatch.

Specified by:

hasScheduleQueueSize in interface ISrvMonAppEventMultiplexerStats

See Also:

ISrvMonAppEventMultiplexerStats.getScheduleQueueSize()

clearScheduleQueueSize

public final void clearScheduleQueueSize()

Description copied from interface: ISrvMonAppEventMultiplexerStats

Clears the value of 'scheduleQueueSize'

Field Description

The number of scheduled events awaiting dispatch.

Specified by:

clearScheduleQueueSize in interface ISrvMonAppEventMultiplexerStats

See Also:

ISrvMonAppEventMultiplexerStats.setScheduleQueueSize(int)

getDisruptorStatsFieldId

public static final int getDisruptorStatsFieldId()

Get the field id for 'disruptorStats'

This method can be used to set field interests.

See Also:

getDisruptorStats()

setDisruptorStats

public final void setDisruptorStats(SrvMonDisruptorStats val)

Description copied from interface: ISrvMonAppEventMultiplexerStats

Sets the value of 'disruptorStats'

Field Description

Stats relating to events' passage through the engine's input disruptor

Specified by:

setDisruptorStats in interface ISrvMonAppEventMultiplexerStats

Parameters:

val - The value to set.

lendDisruptorStats

public final void lendDisruptorStats(SrvMonDisruptorStats val)

Description copied from interface: ISrvMonAppEventMultiplexerStats

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

Field Description

Stats relating to events' passage through the engine's input disruptor

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:

lendDisruptorStats in interface ISrvMonAppEventMultiplexerStats

Parameters:

val - the value to 'lend' to lend.

getDisruptorStats

public final SrvMonDisruptorStats getDisruptorStats()

Description copied from interface: ISrvMonAppEventMultiplexerStats

Gets the value of 'disruptorStats'

Field Description

Stats relating to events' passage through the engine's input disruptor

Specified by:

getDisruptorStats in interface ISrvMonAppEventMultiplexerStats

Returns:

Stats relating to events' passage through the engine's input disruptor

getDisruptorStatsTo

public final void getDisruptorStatsTo(SrvMonDisruptorStats to)

Description copied from interface: ISrvMonAppEventMultiplexerStats

Copies the value of SrvMonDisruptorStats into the provided value.

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

Specified by:

getDisruptorStatsTo in interface ISrvMonAppEventMultiplexerStats

Parameters:

to - the value to copy into

See Also:

SrvMonDisruptorStats.copyInto(SrvMonDisruptorStats)

takeDisruptorStats

public final SrvMonDisruptorStats takeDisruptorStats()

Description copied from interface: ISrvMonAppEventMultiplexerStats

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

Field Description

Stats relating to events' passage through the engine's input disruptor

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:

takeDisruptorStats in interface ISrvMonAppEventMultiplexerStats

Returns:

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

hasDisruptorStats

public final boolean hasDisruptorStats()

Description copied from interface: ISrvMonAppEventMultiplexerStats

Checks for the presence of 'disruptorStats'

Field Description

Stats relating to events' passage through the engine's input disruptor

Specified by:

hasDisruptorStats in interface ISrvMonAppEventMultiplexerStats

See Also:

ISrvMonAppEventMultiplexerStats.getDisruptorStats()

clearDisruptorStats

public final void clearDisruptorStats()

Description copied from interface: ISrvMonAppEventMultiplexerStats

Clears the value of 'disruptorStats'

Field Description

Stats relating to events' passage through the engine's input disruptor

Specified by:

clearDisruptorStats in interface ISrvMonAppEventMultiplexerStats

See Also:

ISrvMonAppEventMultiplexerStats.setDisruptorStats(SrvMonDisruptorStats)

getFeederQueueStatsFieldId

public static final int getFeederQueueStatsFieldId()

Get the field id for 'feederQueueStats'

This method can be used to set field interests.

See Also:

getFeederQueueStats()

setFeederQueueStats

public final void setFeederQueueStats(SrvMonAppEventMultiplexerFeederQueueStats[] val)

Description copied from interface: ISrvMonAppEventMultiplexerStats

Sets the value of 'feederQueueStats'

Field Description

Stats relating to events' passage through the engine's input multiplexer feeder queues.

Specified by:

setFeederQueueStats in interface ISrvMonAppEventMultiplexerStats

Parameters:

val - The value to set.

setFeederQueueStatsFrom

public final void setFeederQueueStatsFrom(XIterator<SrvMonAppEventMultiplexerFeederQueueStats> val)

Description copied from interface: ISrvMonAppEventMultiplexerStats

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

Field Description

Stats relating to events' passage through the engine's input multiplexer feeder queues.

NOTE:
Passing a null or empty list has the same affect as calling ISrvMonAppEventMultiplexerStats.setFeederQueueStats(SrvMonAppEventMultiplexerFeederQueueStats[]) with a value of null.

Specified by:

setFeederQueueStatsFrom in interface ISrvMonAppEventMultiplexerStats

Parameters:

val - the values to set.

lendFeederQueueStatsFrom

public final void lendFeederQueueStatsFrom(XIterator<SrvMonAppEventMultiplexerFeederQueueStats> val)

Description copied from interface: ISrvMonAppEventMultiplexerStats

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

Field Description

Stats relating to events' passage through the engine's input multiplexer feeder queues.

NOTE:
Passing a null or empty list has the same affect as calling ISrvMonAppEventMultiplexerStats.setFeederQueueStats(SrvMonAppEventMultiplexerFeederQueueStats[]) with a value of null.

Specified by:

lendFeederQueueStatsFrom in interface ISrvMonAppEventMultiplexerStats

Parameters:

val - the values to set.

lendFeederQueueStats

public final void lendFeederQueueStats(SrvMonAppEventMultiplexerFeederQueueStats[] val)

Description copied from interface: ISrvMonAppEventMultiplexerStats

Lends the value of 'feederQueueStats'

Field Description

Stats relating to events' passage through the engine's input multiplexer feeder queues.

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:

lendFeederQueueStats in interface ISrvMonAppEventMultiplexerStats

Parameters:

val - the value to 'lend' to lend.

addFeederQueueStats

public final void addFeederQueueStats(SrvMonAppEventMultiplexerFeederQueueStats val)

Description copied from interface: ISrvMonAppEventMultiplexerStats

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

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

Stats relating to events' passage through the engine's input multiplexer feeder queues.

Specified by:

addFeederQueueStats in interface ISrvMonAppEventMultiplexerStats

Parameters:

val - the value to add.

lendFeederQueueStats

public final void lendFeederQueueStats(SrvMonAppEventMultiplexerFeederQueueStats val)

Description copied from interface: ISrvMonAppEventMultiplexerStats

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

Stats relating to events' passage through the engine's input multiplexer feeder queues.

Specified by:

lendFeederQueueStats in interface ISrvMonAppEventMultiplexerStats

Parameters:

val - the value to add.

getFeederQueueStats

public final SrvMonAppEventMultiplexerFeederQueueStats[] getFeederQueueStats()

Description copied from interface: ISrvMonAppEventMultiplexerStats

Gets the value of 'feederQueueStats'

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

Field Description

Stats relating to events' passage through the engine's input multiplexer feeder queues.

Specified by:

getFeederQueueStats in interface ISrvMonAppEventMultiplexerStats

Returns:

Stats relating to events' passage through the engine's input multiplexer feeder queues. If the field is not set this method will return null.

getFeederQueueStatsEmptyIfNull

public final SrvMonAppEventMultiplexerFeederQueueStats[] getFeederQueueStatsEmptyIfNull()

Description copied from interface: ISrvMonAppEventMultiplexerStats

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

Field Description

Stats relating to events' passage through the engine's input multiplexer feeder queues.

Specified by:

getFeederQueueStatsEmptyIfNull in interface ISrvMonAppEventMultiplexerStats

Returns:

Stats relating to events' passage through the engine's input multiplexer feeder queues. or an empty array if null if not set.

See Also:

ISrvMonAppEventMultiplexerStats.getFeederQueueStats()

getFeederQueueStatsIterator

public final XIterator<SrvMonAppEventMultiplexerFeederQueueStats> getFeederQueueStatsIterator()

Description copied from interface: ISrvMonAppEventMultiplexerStats

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

Stats relating to events' passage through the engine's input multiplexer feeder queues.

Specified by:

getFeederQueueStatsIterator in interface ISrvMonAppEventMultiplexerStats

Returns:

An iterator containing this field values.

takeFeederQueueStats

public final SrvMonAppEventMultiplexerFeederQueueStats[] takeFeederQueueStats()

Description copied from interface: ISrvMonAppEventMultiplexerStats

Takes the value of 'feederQueueStats'

Field Description

Stats relating to events' passage through the engine's input multiplexer feeder queues.

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

takeFeederQueueStats in interface ISrvMonAppEventMultiplexerStats

Returns:

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

clearFeederQueueStats

public final void clearFeederQueueStats()

Description copied from interface: ISrvMonAppEventMultiplexerStats

Clears the value of 'feederQueueStats'

Field Description

Stats relating to events' passage through the engine's input multiplexer feeder queues.

Specified by:

clearFeederQueueStats in interface ISrvMonAppEventMultiplexerStats

See Also:

ISrvMonAppEventMultiplexerStats.setFeederQueueStats(SrvMonAppEventMultiplexerFeederQueueStats[])

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

deserializeFromIOElasticBuffer

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

deserializeFromByteArray

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

deserializeFromByteArray

public final SrvMonAppEventMultiplexerStats deserializeFromByteArray(byte[] array)

deserializeFromByteBuffer

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

deserializeFromByteBuffer

public final SrvMonAppEventMultiplexerStats deserializeFromByteBuffer(ByteBuffer buffer)

deserializeFromNative

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

deserializeFromNative

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

Returns:

Return 'this' object for method invocation chaining.

setPool

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

Returns:

Return 'this' object for method invocation chaining.

getPool

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

Returns:

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

isReferenceCounted

public final boolean isReferenceCounted()

acquire

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

Creates a copy of this SrvMonAppEventMultiplexerStats.

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

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

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

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