com.neeve.server.mon
Class SrvMonAppEventMultiplexerFeederQueueStats

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

All Implemented Interfaces:

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

Holds stats related to an Aep Engine's input multiplexer feeder queue.

An input multiplexer maintains several feeder queues one for each thread to allow efficient enqueue and schdeduling of events by multiple input threads. These stats provide insight into the depth of such feeder queues.

Nested Class Summary

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

Field Summary

static SrvMonAppEventMultiplexerFeederQueueStats[]

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

Constructor Summary

SrvMonAppEventMultiplexerFeederQueueStats()

SrvMonAppEventMultiplexerFeederQueueStats(int initialBackingBufferSize)

Method Summary

SrvMonAppEventMultiplexerFeederQueueStats	acquire()
void	clearContent()
void	clearDecongestCount() Clears the value of 'decongestCount' Field Description The number of times the draining thread has woken up to drain the feeder queue.
void	clearOfferToPollLatencies() Clears the value of 'offerToPollLatencies' Field Description Latency information for the amount of time that elements spend in the feeder queue.
void	clearOwner() Clears the value of 'owner' Field Description The owner thread for the feeder queue (the source of events)
void	clearSize() Clears the value of 'size' Field Description The current number of events in the queue
void	clearXRogType()
Object	clone() Creates a clone of this object.
SrvMonAppEventMultiplexerFeederQueueStats	copy() Creates a copy of this SrvMonAppEventMultiplexerFeederQueueStats.
void	copyInto(SrvMonAppEventMultiplexerFeederQueueStats copy) Copies the contents of this SrvMonAppEventMultiplexerFeederQueueStats into the target.
static SrvMonAppEventMultiplexerFeederQueueStats	create()
static SrvMonAppEventMultiplexerFeederQueueStats	createFrom(byte[] serializedContainer)
static SrvMonAppEventMultiplexerFeederQueueStats	createFrom(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
static SrvMonAppEventMultiplexerFeederQueueStats	createFromSerializedXbufContainer(byte[] serializedContainer)
static SrvMonAppEventMultiplexerFeederQueueStats	createFromSerializedXbufContainer(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
static com.neeve.xbuf.XbufSchema	createSchema()
SrvMonAppEventMultiplexerFeederQueueStats	deserializeFromByteArray(byte[] array)
SrvMonAppEventMultiplexerFeederQueueStats	deserializeFromByteArray(byte[] array, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonAppEventMultiplexerFeederQueueStats	deserializeFromByteBuffer(ByteBuffer buffer)
SrvMonAppEventMultiplexerFeederQueueStats	deserializeFromByteBuffer(ByteBuffer buffer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonAppEventMultiplexerFeederQueueStats	deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length)
SrvMonAppEventMultiplexerFeederQueueStats	deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonAppEventMultiplexerFeederQueueStats	deserializeFromNative(long address, int offset, int length)
SrvMonAppEventMultiplexerFeederQueueStats	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()
int	getDecongestCount() Gets the value of 'decongestCount' Field Description The number of times the draining thread has woken up to drain the feeder queue.
com.neeve.xbuf.XbufVariableIntField	getDecongestCountField()
static int	getDecongestCountFieldId() Get the field id for 'decongestCount' This method can be used to set field interests.
static com.neeve.xbuf.XbufDesyncPolicy	getDesyncPolicy()
boolean	getIsReadOnly()
SrvMonIntSeries	getOfferToPollLatencies() Gets the value of 'offerToPollLatencies' Field Description Latency information for the amount of time that elements spend in the feeder queue.
static int	getOfferToPollLatenciesFieldId() Get the field id for 'offerToPollLatencies' This method can be used to set field interests.
void	getOfferToPollLatenciesTo(SrvMonIntSeries to) Copies the value of SrvMonIntSeries into the provided value.
String	getOwner() Gets the value of 'owner' Field Description The owner thread for the feeder queue (the source of events)
int	getOwnerCount()
com.neeve.xbuf.XbufStringField	getOwnerField()
static int	getOwnerFieldId() Get the field id for 'owner' This method can be used to set field interests.
<T extends XString> T	getOwnerTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getOwnerTo(XString val) Copies the value of 'owner' into the provided XString.
XString	getOwnerUnsafe() Gets the raw value of 'owner'.
UtlPool<SrvMonAppEventMultiplexerFeederQueueStats>	getPool() Get a pool item's pool.
int	getSerializeToNativeLength()
int	getSize() Gets the value of 'size' Field Description The current number of events in the queue
com.neeve.xbuf.XbufVariableIntField	getSizeField()
static int	getSizeFieldId() Get the field id for 'size' This method can be used to set field interests.
void	getValidationErrors(List<XString> results, String errorPrefix) Collects validation errors into the provided list.
short	getXRogType()
com.neeve.xbuf.XbufVariableShortField	getXRogTypeField()
static int	getXRogTypeFieldId() Get the field id for 'xRogType' This method can be used to set field interests.
boolean	hasDecongestCount() Checks for the presence of 'decongestCount' Field Description The number of times the draining thread has woken up to drain the feeder queue.
boolean	hasOfferToPollLatencies() Checks for the presence of 'offerToPollLatencies' Field Description Latency information for the amount of time that elements spend in the feeder queue.
boolean	hasOwner() Checks for the presence of 'owner' Field Description The owner thread for the feeder queue (the source of events)
boolean	hasSize() Checks for the presence of 'size' Field Description The current number of events in the queue
boolean	hasXRogType()
SrvMonAppEventMultiplexerFeederQueueStats	init() Initialize an item.
boolean	isBufferBacked()
boolean	isDirty()
boolean	isReferenceCounted()
boolean	isValid() Tests if this object has any validation errors.
void	lendOfferToPollLatencies(SrvMonIntSeries val) 'Lends' a reference of the SrvMonIntSeries to the message for this field.
void	lendOwner(XString val) Sets the value of 'owner' Field Description The owner thread for the feeder queue (the source of events)
static void	optimizeFor(int val)
byte[]	serializeToByteArray()
ByteBuffer	serializeToByteBuffer()
com.neeve.io.IOBuffer	serializeToIOBuffer(boolean useNative)
int	serializeToNative(long address, int addressOffset)
void	setAsReadOnly()
void	setDecongestCount(int val) Sets the value of 'decongestCount' Field Description The number of times the draining thread has woken up to drain the feeder queue.
void	setDecongestCountFrom(com.neeve.xbuf.XbufVariableIntField val)
static void	setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
static void	setFieldInterest(List<Integer> fieldIds)
void	setOfferToPollLatencies(SrvMonIntSeries val) Sets the value of 'offerToPollLatencies' Field Description Latency information for the amount of time that elements spend in the feeder queue.
void	setOwner(String val) Sets the value of 'owner' Field Description The owner thread for the feeder queue (the source of events)
void	setOwnerFrom(long val) Sets the value of this String field to the given numeric value.
void	setOwnerFrom(com.neeve.xbuf.XbufStringField val)
void	setOwnerFrom(XString val) Copies the provided XString value into this object's 'owner'.
SrvMonAppEventMultiplexerFeederQueueStats	setPool(UtlPool<SrvMonAppEventMultiplexerFeederQueueStats> pool) Set a pool item's pool.
void	setSize(int val) Sets the value of 'size' Field Description The current number of events in the queue
void	setSizeFrom(com.neeve.xbuf.XbufVariableIntField val)
void	setXRogType(short val)
void	setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)
void	sync()
void	syncFieldBitmask()
SrvMonIntSeries	takeOfferToPollLatencies() 'Takes' a reference to the offerToPollLatencies 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 SrvMonAppEventMultiplexerFeederQueueStats[] EMPTY_ARRAY

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

Constructor Detail

SrvMonAppEventMultiplexerFeederQueueStats

public SrvMonAppEventMultiplexerFeederQueueStats()

SrvMonAppEventMultiplexerFeederQueueStats

public SrvMonAppEventMultiplexerFeederQueueStats(int initialBackingBufferSize)

Method Detail

create

public static SrvMonAppEventMultiplexerFeederQueueStats create()

createFromSerializedXbufContainer

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

createFromSerializedXbufContainer

public static SrvMonAppEventMultiplexerFeederQueueStats createFromSerializedXbufContainer(byte[] serializedContainer)

createFrom

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

createFrom

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

getSizeFieldId

public static final int getSizeFieldId()

Get the field id for 'size'

This method can be used to set field interests.

See Also:

getSize()

setSize

public final void setSize(int val)

Description copied from interface: ISrvMonAppEventMultiplexerFeederQueueStats

Sets the value of 'size'

Field Description

The current number of events in the queue

Specified by:

setSize in interface ISrvMonAppEventMultiplexerFeederQueueStats

Parameters:

val - The value to set.

getSize

public final int getSize()

Description copied from interface: ISrvMonAppEventMultiplexerFeederQueueStats

Gets the value of 'size'

Field Description

The current number of events in the queue

Specified by:

getSize in interface ISrvMonAppEventMultiplexerFeederQueueStats

Returns:

The current number of events in the queue

setSizeFrom

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

getSizeField

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

hasSize

public final boolean hasSize()

Description copied from interface: ISrvMonAppEventMultiplexerFeederQueueStats

Checks for the presence of 'size'

Field Description

The current number of events in the queue

Specified by:

hasSize in interface ISrvMonAppEventMultiplexerFeederQueueStats

See Also:

ISrvMonAppEventMultiplexerFeederQueueStats.getSize()

clearSize

public final void clearSize()

Description copied from interface: ISrvMonAppEventMultiplexerFeederQueueStats

Clears the value of 'size'

Field Description

The current number of events in the queue

Specified by:

clearSize in interface ISrvMonAppEventMultiplexerFeederQueueStats

See Also:

ISrvMonAppEventMultiplexerFeederQueueStats.setSize(int)

getDecongestCountFieldId

public static final int getDecongestCountFieldId()

Get the field id for 'decongestCount'

This method can be used to set field interests.

See Also:

getDecongestCount()

setDecongestCount

public final void setDecongestCount(int val)

Description copied from interface: ISrvMonAppEventMultiplexerFeederQueueStats

Sets the value of 'decongestCount'

Field Description

The number of times the draining thread has woken up to drain the feeder queue.

Specified by:

setDecongestCount in interface ISrvMonAppEventMultiplexerFeederQueueStats

Parameters:

val - The value to set.

getDecongestCount

public final int getDecongestCount()

Description copied from interface: ISrvMonAppEventMultiplexerFeederQueueStats

Gets the value of 'decongestCount'

Field Description

The number of times the draining thread has woken up to drain the feeder queue.

Specified by:

getDecongestCount in interface ISrvMonAppEventMultiplexerFeederQueueStats

Returns:

The number of times the draining thread has woken up to drain the feeder queue.

setDecongestCountFrom

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

getDecongestCountField

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

hasDecongestCount

public final boolean hasDecongestCount()

Description copied from interface: ISrvMonAppEventMultiplexerFeederQueueStats

Checks for the presence of 'decongestCount'

Field Description

The number of times the draining thread has woken up to drain the feeder queue.

Specified by:

hasDecongestCount in interface ISrvMonAppEventMultiplexerFeederQueueStats

See Also:

ISrvMonAppEventMultiplexerFeederQueueStats.getDecongestCount()

clearDecongestCount

public final void clearDecongestCount()

Description copied from interface: ISrvMonAppEventMultiplexerFeederQueueStats

Clears the value of 'decongestCount'

Field Description

The number of times the draining thread has woken up to drain the feeder queue.

Specified by:

clearDecongestCount in interface ISrvMonAppEventMultiplexerFeederQueueStats

See Also:

ISrvMonAppEventMultiplexerFeederQueueStats.setDecongestCount(int)

getOwnerFieldId

public static final int getOwnerFieldId()

Get the field id for 'owner'

This method can be used to set field interests.

See Also:

getOwner()

setOwner

public final void setOwner(String val)

Description copied from interface: ISrvMonAppEventMultiplexerFeederQueueStats

Sets the value of 'owner'

Field Description

The owner thread for the feeder queue (the source of events)

Specified by:

setOwner in interface ISrvMonAppEventMultiplexerFeederQueueStats

Parameters:

val - The value to set.

getOwner

public final String getOwner()

Description copied from interface: ISrvMonAppEventMultiplexerFeederQueueStats

Gets the value of 'owner'

Field Description

The owner thread for the feeder queue (the source of events)

Specified by:

getOwner in interface ISrvMonAppEventMultiplexerFeederQueueStats

Returns:

The owner thread for the feeder queue (the source of events)

lendOwner

public final void lendOwner(XString val)

Description copied from interface: ISrvMonAppEventMultiplexerFeederQueueStats

Sets the value of 'owner'

Field Description

The owner thread for the feeder queue (the source of events)

Specified by:

lendOwner in interface ISrvMonAppEventMultiplexerFeederQueueStats

Parameters:

val - The value to set.

setOwnerFrom

public final void setOwnerFrom(long val)

Description copied from interface: ISrvMonAppEventMultiplexerFeederQueueStats

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

Field Description

The owner thread for the feeder queue (the source of events)

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

Specified by:

setOwnerFrom in interface ISrvMonAppEventMultiplexerFeederQueueStats

getOwnerTo

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

Description copied from interface: ISrvMonAppEventMultiplexerFeederQueueStats

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

Field Description

The owner thread for the feeder queue (the source of events)

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:

getOwnerTo in interface ISrvMonAppEventMultiplexerFeederQueueStats

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.

setOwnerFrom

public final void setOwnerFrom(XString val)

Description copied from interface: ISrvMonAppEventMultiplexerFeederQueueStats

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

Field Description

The owner thread for the feeder queue (the source of events)

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

Specified by:

setOwnerFrom in interface ISrvMonAppEventMultiplexerFeederQueueStats

getOwnerTo

public final void getOwnerTo(XString val)

Description copied from interface: ISrvMonAppEventMultiplexerFeederQueueStats

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

Field Description

The owner thread for the feeder queue (the source of events)

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

Specified by:

getOwnerTo in interface ISrvMonAppEventMultiplexerFeederQueueStats

See Also:

ISrvMonAppEventMultiplexerFeederQueueStats.getOwner()

getOwnerUnsafe

public final XString getOwnerUnsafe()

Description copied from interface: ISrvMonAppEventMultiplexerFeederQueueStats

Gets the raw value of 'owner'.

Field Description

The owner thread for the feeder queue (the source of events)

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:

getOwnerUnsafe in interface ISrvMonAppEventMultiplexerFeederQueueStats

Returns:

the field's raw value

See Also:

ISrvMonAppEventMultiplexerFeederQueueStats.getOwner()

setOwnerFrom

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

getOwnerField

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

hasOwner

public final boolean hasOwner()

Description copied from interface: ISrvMonAppEventMultiplexerFeederQueueStats

Checks for the presence of 'owner'

Field Description

The owner thread for the feeder queue (the source of events)

Specified by:

hasOwner in interface ISrvMonAppEventMultiplexerFeederQueueStats

See Also:

ISrvMonAppEventMultiplexerFeederQueueStats.getOwner()

clearOwner

public final void clearOwner()

Description copied from interface: ISrvMonAppEventMultiplexerFeederQueueStats

Clears the value of 'owner'

Field Description

The owner thread for the feeder queue (the source of events)

Specified by:

clearOwner in interface ISrvMonAppEventMultiplexerFeederQueueStats

See Also:

ISrvMonAppEventMultiplexerFeederQueueStats.setOwner(String)

getOfferToPollLatenciesFieldId

public static final int getOfferToPollLatenciesFieldId()

Get the field id for 'offerToPollLatencies'

This method can be used to set field interests.

See Also:

getOfferToPollLatencies()

setOfferToPollLatencies

public final void setOfferToPollLatencies(SrvMonIntSeries val)

Description copied from interface: ISrvMonAppEventMultiplexerFeederQueueStats

Sets the value of 'offerToPollLatencies'

Field Description

Latency information for the amount of time that elements spend in the feeder queue.

Specified by:

setOfferToPollLatencies in interface ISrvMonAppEventMultiplexerFeederQueueStats

Parameters:

val - The value to set.

lendOfferToPollLatencies

public final void lendOfferToPollLatencies(SrvMonIntSeries val)

Description copied from interface: ISrvMonAppEventMultiplexerFeederQueueStats

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

Field Description

Latency information for the amount of time that elements spend in the feeder queue.

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:

lendOfferToPollLatencies in interface ISrvMonAppEventMultiplexerFeederQueueStats

Parameters:

val - the value to 'lend' to lend.

getOfferToPollLatencies

public final SrvMonIntSeries getOfferToPollLatencies()

Description copied from interface: ISrvMonAppEventMultiplexerFeederQueueStats

Gets the value of 'offerToPollLatencies'

Field Description

Latency information for the amount of time that elements spend in the feeder queue.

Specified by:

getOfferToPollLatencies in interface ISrvMonAppEventMultiplexerFeederQueueStats

Returns:

Latency information for the amount of time that elements spend in the feeder queue.

getOfferToPollLatenciesTo

public final void getOfferToPollLatenciesTo(SrvMonIntSeries to)

Description copied from interface: ISrvMonAppEventMultiplexerFeederQueueStats

Copies the value of SrvMonIntSeries into the provided value.

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

Specified by:

getOfferToPollLatenciesTo in interface ISrvMonAppEventMultiplexerFeederQueueStats

Parameters:

to - the value to copy into

See Also:

SrvMonIntSeries.copyInto(SrvMonIntSeries)

takeOfferToPollLatencies

public final SrvMonIntSeries takeOfferToPollLatencies()

Description copied from interface: ISrvMonAppEventMultiplexerFeederQueueStats

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

Field Description

Latency information for the amount of time that elements spend in the feeder queue.

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:

takeOfferToPollLatencies in interface ISrvMonAppEventMultiplexerFeederQueueStats

Returns:

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

hasOfferToPollLatencies

public final boolean hasOfferToPollLatencies()

Description copied from interface: ISrvMonAppEventMultiplexerFeederQueueStats

Checks for the presence of 'offerToPollLatencies'

Field Description

Latency information for the amount of time that elements spend in the feeder queue.

Specified by:

hasOfferToPollLatencies in interface ISrvMonAppEventMultiplexerFeederQueueStats

See Also:

ISrvMonAppEventMultiplexerFeederQueueStats.getOfferToPollLatencies()

clearOfferToPollLatencies

public final void clearOfferToPollLatencies()

Description copied from interface: ISrvMonAppEventMultiplexerFeederQueueStats

Clears the value of 'offerToPollLatencies'

Field Description

Latency information for the amount of time that elements spend in the feeder queue.

Specified by:

clearOfferToPollLatencies in interface ISrvMonAppEventMultiplexerFeederQueueStats

See Also:

ISrvMonAppEventMultiplexerFeederQueueStats.setOfferToPollLatencies(SrvMonIntSeries)

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

deserializeFromIOElasticBuffer

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

deserializeFromByteArray

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

deserializeFromByteArray

public final SrvMonAppEventMultiplexerFeederQueueStats deserializeFromByteArray(byte[] array)

deserializeFromByteBuffer

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

deserializeFromByteBuffer

public final SrvMonAppEventMultiplexerFeederQueueStats deserializeFromByteBuffer(ByteBuffer buffer)

deserializeFromNative

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

deserializeFromNative

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

Returns:

Return 'this' object for method invocation chaining.

setPool

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

Returns:

Return 'this' object for method invocation chaining.

getPool

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

Returns:

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

isReferenceCounted

public final boolean isReferenceCounted()

acquire

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

Creates a copy of this SrvMonAppEventMultiplexerFeederQueueStats.

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

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

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

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