com.neeve.server.mon
Class SrvMonIntSeries

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

All Implemented Interfaces:

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

Holds raw and histographical data on a series of integer data points.

SrvMonIntSeries reports interval and running histogram data for a series of integer data points. It may also be used to report the captured datapoints, but ecause reporting the raw data is costly both in terms of collection and size/bandwith the captured values are typically not reported. SrvMonIntSeries is frequently used to capture measured latency timings, but can also be used to capture any integer data series.

Nested Class Summary

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

Field Summary

static SrvMonIntSeries[]

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

Constructor Summary

SrvMonIntSeries()

SrvMonIntSeries(int initialBackingBufferSize)

Method Summary

SrvMonIntSeries	acquire()
void	addDataPoints(int val) Adds the provided value to the list of 'dataPoints' values.
void	clearContent()
void	clearDataPoints() Clears the value of 'dataPoints' Field Description Holds the collected raw data points (when reported).
void	clearIntervalStats() Clears the value of 'intervalStats' Field Description Computed latency statistics for the collection period corresponding to this heartbeat.
void	clearLastSequenceNumber() Clears the value of 'lastSequenceNumber' Field Description The sequence number of the last data point collected or 0 if no data points have been collected.
void	clearNumDataPoints() Clears the value of 'numDataPoints' Field Description The number of data points collected in this interval.
void	clearRunningStats() Clears the value of 'runningStats' Field Description Computed latency statistics over the lifetime of the metric being collected.
void	clearSkippedDatapoints() Clears the value of 'skippedDatapoints' Field Description The number of data points skipped due to undersampling The runtime only holds on to a fixed number of data points for any particular statistic.
void	clearXRogType()
Object	clone() Creates a clone of this object.
SrvMonIntSeries	copy() Creates a copy of this SrvMonIntSeries.
void	copyInto(SrvMonIntSeries copy) Copies the contents of this SrvMonIntSeries into the target.
static SrvMonIntSeries	create()
static com.neeve.xbuf.XbufRepeatedIntFieldBuffer	createDataPointsFieldBuffer(int initialBufferLength, boolean isNative) Returns a wrapped buffer that can be used for doing an efficient bulk copy from an XIterator returned for this field.
static SrvMonIntSeries	createFrom(byte[] serializedContainer)
static SrvMonIntSeries	createFrom(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
static SrvMonIntSeries	createFromSerializedXbufContainer(byte[] serializedContainer)
static SrvMonIntSeries	createFromSerializedXbufContainer(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
static com.neeve.xbuf.XbufSchema	createSchema()
SrvMonIntSeries	deserializeFromByteArray(byte[] array)
SrvMonIntSeries	deserializeFromByteArray(byte[] array, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonIntSeries	deserializeFromByteBuffer(ByteBuffer buffer)
SrvMonIntSeries	deserializeFromByteBuffer(ByteBuffer buffer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonIntSeries	deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length)
SrvMonIntSeries	deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonIntSeries	deserializeFromNative(long address, int offset, int length)
SrvMonIntSeries	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[]	getDataPoints() Gets the value of 'dataPoints' If the field is not set this method will return null.
int[]	getDataPointsEmptyIfNull() Gets the value of 'dataPoints' or an empty array if the value is null or not set.
static int	getDataPointsFieldId() Get the field id for 'dataPoints' This method can be used to set field interests.
XIntIterator	getDataPointsIterator() Gets the value of 'dataPoints' as iterator of values.
static com.neeve.xbuf.XbufDesyncPolicy	getDesyncPolicy()
SrvMonIntHistogram	getIntervalStats() Gets the value of 'intervalStats' Field Description Computed latency statistics for the collection period corresponding to this heartbeat.
static int	getIntervalStatsFieldId() Get the field id for 'intervalStats' This method can be used to set field interests.
void	getIntervalStatsTo(SrvMonIntHistogram to) Copies the value of SrvMonIntHistogram into the provided value.
boolean	getIsReadOnly()
long	getLastSequenceNumber() Gets the value of 'lastSequenceNumber' Field Description The sequence number of the last data point collected or 0 if no data points have been collected.
com.neeve.xbuf.XbufVariableLongField	getLastSequenceNumberField()
static int	getLastSequenceNumberFieldId() Get the field id for 'lastSequenceNumber' This method can be used to set field interests.
int	getNumDataPoints() Gets the value of 'numDataPoints' Field Description The number of data points collected in this interval.
com.neeve.xbuf.XbufVariableIntField	getNumDataPointsField()
static int	getNumDataPointsFieldId() Get the field id for 'numDataPoints' This method can be used to set field interests.
int	getOwnerCount()
UtlPool<SrvMonIntSeries>	getPool() Get a pool item's pool.
SrvMonIntHistogram	getRunningStats() Gets the value of 'runningStats' Field Description Computed latency statistics over the lifetime of the metric being collected.
static int	getRunningStatsFieldId() Get the field id for 'runningStats' This method can be used to set field interests.
void	getRunningStatsTo(SrvMonIntHistogram to) Copies the value of SrvMonIntHistogram into the provided value.
int	getSerializeToNativeLength()
long	getSkippedDatapoints() Gets the value of 'skippedDatapoints' Field Description The number of data points skipped due to undersampling The runtime only holds on to a fixed number of data points for any particular statistic.
com.neeve.xbuf.XbufVariableLongField	getSkippedDatapointsField()
static int	getSkippedDatapointsFieldId() Get the field id for 'skippedDatapoints' 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	hasIntervalStats() Checks for the presence of 'intervalStats' Field Description Computed latency statistics for the collection period corresponding to this heartbeat.
boolean	hasLastSequenceNumber() Checks for the presence of 'lastSequenceNumber' Field Description The sequence number of the last data point collected or 0 if no data points have been collected.
boolean	hasNumDataPoints() Checks for the presence of 'numDataPoints' Field Description The number of data points collected in this interval.
boolean	hasRunningStats() Checks for the presence of 'runningStats' Field Description Computed latency statistics over the lifetime of the metric being collected.
boolean	hasSkippedDatapoints() Checks for the presence of 'skippedDatapoints' Field Description The number of data points skipped due to undersampling The runtime only holds on to a fixed number of data points for any particular statistic.
boolean	hasXRogType()
SrvMonIntSeries	init() Initialize an item.
boolean	isBufferBacked()
boolean	isDirty()
boolean	isReferenceCounted()
boolean	isValid() Tests if this object has any validation errors.
void	lendIntervalStats(SrvMonIntHistogram val) 'Lends' a reference of the SrvMonIntHistogram to the message for this field.
void	lendRunningStats(SrvMonIntHistogram val) 'Lends' a reference of the SrvMonIntHistogram 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	setAsReadOnly()
void	setDataPoints(int[] val) Sets the value of 'dataPoints' Field Description Holds the collected raw data points (when reported).
void	setDataPointsFrom(XIntIterator val) Sets the value of 'dataPoints' using the values from the provided iterator.
static void	setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
static void	setFieldInterest(List<Integer> fieldIds)
void	setIntervalStats(SrvMonIntHistogram val) Sets the value of 'intervalStats' Field Description Computed latency statistics for the collection period corresponding to this heartbeat.
void	setLastSequenceNumber(long val) Sets the value of 'lastSequenceNumber' Field Description The sequence number of the last data point collected or 0 if no data points have been collected.
void	setLastSequenceNumberFrom(com.neeve.xbuf.XbufVariableLongField val)
void	setNumDataPoints(int val) Sets the value of 'numDataPoints' Field Description The number of data points collected in this interval.
void	setNumDataPointsFrom(com.neeve.xbuf.XbufVariableIntField val)
SrvMonIntSeries	setPool(UtlPool<SrvMonIntSeries> pool) Set a pool item's pool.
void	setRunningStats(SrvMonIntHistogram val) Sets the value of 'runningStats' Field Description Computed latency statistics over the lifetime of the metric being collected.
void	setSkippedDatapoints(long val) Sets the value of 'skippedDatapoints' Field Description The number of data points skipped due to undersampling The runtime only holds on to a fixed number of data points for any particular statistic.
void	setSkippedDatapointsFrom(com.neeve.xbuf.XbufVariableLongField val)
void	setXRogType(short val)
void	setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)
void	sync()
void	syncFieldBitmask()
SrvMonIntHistogram	takeIntervalStats() 'Takes' a reference to the intervalStats field from the message.
SrvMonIntHistogram	takeRunningStats() 'Takes' a reference to the runningStats 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 SrvMonIntSeries[] EMPTY_ARRAY

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

Constructor Detail

SrvMonIntSeries

public SrvMonIntSeries()

SrvMonIntSeries

public SrvMonIntSeries(int initialBackingBufferSize)

Method Detail

create

public static SrvMonIntSeries create()

createFromSerializedXbufContainer

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

createFromSerializedXbufContainer

public static SrvMonIntSeries createFromSerializedXbufContainer(byte[] serializedContainer)

createFrom

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

createFrom

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

getLastSequenceNumberFieldId

public static final int getLastSequenceNumberFieldId()

Get the field id for 'lastSequenceNumber'

This method can be used to set field interests.

See Also:

getLastSequenceNumber()

setLastSequenceNumber

public final void setLastSequenceNumber(long val)

Description copied from interface: ISrvMonIntSeries

Sets the value of 'lastSequenceNumber'

Field Description

The sequence number of the last data point collected or 0 if no data points have been collected.

Sequence numbers for collected data points start at 1, a value of 0 indicates that no data points have been collected. The Sequence Number always indicates the number or data points that have been collected since the statistic has been created or was last reset. If the statistic is reset then this value will reset to 0, when

Specified by:

setLastSequenceNumber in interface ISrvMonIntSeries

Parameters:

val - The value to set.

getLastSequenceNumber

public final long getLastSequenceNumber()

Description copied from interface: ISrvMonIntSeries

Gets the value of 'lastSequenceNumber'

Field Description

The sequence number of the last data point collected or 0 if no data points have been collected.

Sequence numbers for collected data points start at 1, a value of 0 indicates that no data points have been collected. The Sequence Number always indicates the number or data points that have been collected since the statistic has been created or was last reset. If the statistic is reset then this value will reset to 0, when

Specified by:

getLastSequenceNumber in interface ISrvMonIntSeries

Returns:

The sequence number of the last data point collected or 0 if no data points have been collected.

setLastSequenceNumberFrom

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

getLastSequenceNumberField

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

hasLastSequenceNumber

public final boolean hasLastSequenceNumber()

Description copied from interface: ISrvMonIntSeries

Checks for the presence of 'lastSequenceNumber'

Field Description

The sequence number of the last data point collected or 0 if no data points have been collected.

Sequence numbers for collected data points start at 1, a value of 0 indicates that no data points have been collected. The Sequence Number always indicates the number or data points that have been collected since the statistic has been created or was last reset. If the statistic is reset then this value will reset to 0, when

Specified by:

hasLastSequenceNumber in interface ISrvMonIntSeries

See Also:

ISrvMonIntSeries.getLastSequenceNumber()

clearLastSequenceNumber

public final void clearLastSequenceNumber()

Description copied from interface: ISrvMonIntSeries

Clears the value of 'lastSequenceNumber'

Field Description

The sequence number of the last data point collected or 0 if no data points have been collected.

Sequence numbers for collected data points start at 1, a value of 0 indicates that no data points have been collected. The Sequence Number always indicates the number or data points that have been collected since the statistic has been created or was last reset. If the statistic is reset then this value will reset to 0, when

Specified by:

clearLastSequenceNumber in interface ISrvMonIntSeries

See Also:

ISrvMonIntSeries.setLastSequenceNumber(long)

getNumDataPointsFieldId

public static final int getNumDataPointsFieldId()

Get the field id for 'numDataPoints'

This method can be used to set field interests.

See Also:

getNumDataPoints()

setNumDataPoints

public final void setNumDataPoints(int val)

Description copied from interface: ISrvMonIntSeries

Sets the value of 'numDataPoints'

Field Description

The number of data points collected in this interval.

Indicates the number of data points collected in this interval. If no data points were collected numDataPoints will be 0. The sequence number of the first value collected in this interval can be determined by subtracting numDataPoints from lastSequenceNumber. This can be used to determine if two consecutive datapoints have skipped data points due to under sampling or a missing heartbeat.

Specified by:

setNumDataPoints in interface ISrvMonIntSeries

Parameters:

val - The value to set.

getNumDataPoints

public final int getNumDataPoints()

Description copied from interface: ISrvMonIntSeries

Gets the value of 'numDataPoints'

Field Description

The number of data points collected in this interval.

Indicates the number of data points collected in this interval. If no data points were collected numDataPoints will be 0. The sequence number of the first value collected in this interval can be determined by subtracting numDataPoints from lastSequenceNumber. This can be used to determine if two consecutive datapoints have skipped data points due to under sampling or a missing heartbeat.

Specified by:

getNumDataPoints in interface ISrvMonIntSeries

Returns:

The number of data points collected in this interval.

setNumDataPointsFrom

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

getNumDataPointsField

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

hasNumDataPoints

public final boolean hasNumDataPoints()

Description copied from interface: ISrvMonIntSeries

Checks for the presence of 'numDataPoints'

Field Description

The number of data points collected in this interval.

Indicates the number of data points collected in this interval. If no data points were collected numDataPoints will be 0. The sequence number of the first value collected in this interval can be determined by subtracting numDataPoints from lastSequenceNumber. This can be used to determine if two consecutive datapoints have skipped data points due to under sampling or a missing heartbeat.

Specified by:

hasNumDataPoints in interface ISrvMonIntSeries

See Also:

ISrvMonIntSeries.getNumDataPoints()

clearNumDataPoints

public final void clearNumDataPoints()

Description copied from interface: ISrvMonIntSeries

Clears the value of 'numDataPoints'

Field Description

The number of data points collected in this interval.

Indicates the number of data points collected in this interval. If no data points were collected numDataPoints will be 0. The sequence number of the first value collected in this interval can be determined by subtracting numDataPoints from lastSequenceNumber. This can be used to determine if two consecutive datapoints have skipped data points due to under sampling or a missing heartbeat.

Specified by:

clearNumDataPoints in interface ISrvMonIntSeries

See Also:

ISrvMonIntSeries.setNumDataPoints(int)

getSkippedDatapointsFieldId

public static final int getSkippedDatapointsFieldId()

Get the field id for 'skippedDatapoints'

This method can be used to set field interests.

See Also:

getSkippedDatapoints()

setSkippedDatapoints

public final void setSkippedDatapoints(long val)

Description copied from interface: ISrvMonIntSeries

Sets the value of 'skippedDatapoints'

Field Description

The number of data points skipped due to undersampling

The runtime only holds on to a fixed number of data points for any particular statistic. If the sampling interval is too high then some datapoints may be skipped. For example let's say Latency stats are configured to hold on to a sample size of 1000 datapoints. If the number of data points being captured per second is 2000, and the stats collection interval is 1 second then on each collection, 1000 datapoints will be missed which will skew results. The skipped data points counter thus indicates how many datapoints have been missed in the reported runningStats. And if the count grows over two successive heartbeats indicates that the values the intervalStats don't reflect all the activity since the last interval. The skipped data points counter is a running counter ... it tracks the total number of data points that have been skipped since the underlying statistic was last reset.

Specified by:

setSkippedDatapoints in interface ISrvMonIntSeries

Parameters:

val - The value to set.

getSkippedDatapoints

public final long getSkippedDatapoints()

Description copied from interface: ISrvMonIntSeries

Gets the value of 'skippedDatapoints'

Field Description

The number of data points skipped due to undersampling

The runtime only holds on to a fixed number of data points for any particular statistic. If the sampling interval is too high then some datapoints may be skipped. For example let's say Latency stats are configured to hold on to a sample size of 1000 datapoints. If the number of data points being captured per second is 2000, and the stats collection interval is 1 second then on each collection, 1000 datapoints will be missed which will skew results. The skipped data points counter thus indicates how many datapoints have been missed in the reported runningStats. And if the count grows over two successive heartbeats indicates that the values the intervalStats don't reflect all the activity since the last interval. The skipped data points counter is a running counter ... it tracks the total number of data points that have been skipped since the underlying statistic was last reset.

Specified by:

getSkippedDatapoints in interface ISrvMonIntSeries

Returns:

The number of data points skipped due to undersampling

setSkippedDatapointsFrom

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

getSkippedDatapointsField

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

hasSkippedDatapoints

public final boolean hasSkippedDatapoints()

Description copied from interface: ISrvMonIntSeries

Checks for the presence of 'skippedDatapoints'

Field Description

The number of data points skipped due to undersampling

The runtime only holds on to a fixed number of data points for any particular statistic. If the sampling interval is too high then some datapoints may be skipped. For example let's say Latency stats are configured to hold on to a sample size of 1000 datapoints. If the number of data points being captured per second is 2000, and the stats collection interval is 1 second then on each collection, 1000 datapoints will be missed which will skew results. The skipped data points counter thus indicates how many datapoints have been missed in the reported runningStats. And if the count grows over two successive heartbeats indicates that the values the intervalStats don't reflect all the activity since the last interval. The skipped data points counter is a running counter ... it tracks the total number of data points that have been skipped since the underlying statistic was last reset.

Specified by:

hasSkippedDatapoints in interface ISrvMonIntSeries

See Also:

ISrvMonIntSeries.getSkippedDatapoints()

clearSkippedDatapoints

public final void clearSkippedDatapoints()

Description copied from interface: ISrvMonIntSeries

Clears the value of 'skippedDatapoints'

Field Description

The number of data points skipped due to undersampling

The runtime only holds on to a fixed number of data points for any particular statistic. If the sampling interval is too high then some datapoints may be skipped. For example let's say Latency stats are configured to hold on to a sample size of 1000 datapoints. If the number of data points being captured per second is 2000, and the stats collection interval is 1 second then on each collection, 1000 datapoints will be missed which will skew results. The skipped data points counter thus indicates how many datapoints have been missed in the reported runningStats. And if the count grows over two successive heartbeats indicates that the values the intervalStats don't reflect all the activity since the last interval. The skipped data points counter is a running counter ... it tracks the total number of data points that have been skipped since the underlying statistic was last reset.

Specified by:

clearSkippedDatapoints in interface ISrvMonIntSeries

See Also:

ISrvMonIntSeries.setSkippedDatapoints(long)

getDataPointsFieldId

public static final int getDataPointsFieldId()

Get the field id for 'dataPoints'

This method can be used to set field interests.

See Also:

getDataPoints()

createDataPointsFieldBuffer

public static final com.neeve.xbuf.XbufRepeatedIntFieldBuffer createDataPointsFieldBuffer(int initialBufferLength,
                                                                                          boolean isNative)

Returns a wrapped buffer that can be used for doing an efficient bulk copy from an XIterator returned for this field.

For example the following would result in a bulk transfer from this message

 XbufRepeatedIntFieldBuffer preallocated = SrvMonIntSeries.createDataPointsFieldBuffer(1024, true);
 // The following would then result in a buffer copy without any iteration:
 preallocated.setValue(inboundMessage.getDataPointsIterator());
 // The preallocated bulk copied values can then be transfered to an outbound message:
 outboundMessage.setDataPoints.setValueFrom(preallocated);
 

Bulk transfer from the backing buffer may only possible between two fields with the same id (protobuf tag) because the bulk transfered bytes are in protobuf wire format which for most repeated fields encode the field's tag for each element.

Parameters:

initialBufferLength - the initial size of the underlying backing buffer.

isNative - Whether the backing buffer should be a native or heap buffer.

setDataPoints

public final void setDataPoints(int[] val)

Description copied from interface: ISrvMonIntSeries

Sets the value of 'dataPoints'

Field Description

Holds the collected raw data points (when reported).

When the server is configured to include the capture data points for the statistic, the returned array will include the values collected during this interval. This allows monitoring tools to perform non lossy calculation of percentiles providing now data points were skipped due to under sampling or a missed heartbeat. Then number of valid values in the returned array is dicated by numDataPoints, if the length of the values array is longer than numDataPoints subsequent values in the array should be ignored.

Specified by:

setDataPoints in interface ISrvMonIntSeries

Parameters:

val - The value to set.

setDataPointsFrom

public final void setDataPointsFrom(XIntIterator val)

Description copied from interface: ISrvMonIntSeries

Sets the value of 'dataPoints' using the values from the provided iterator.

This method will call XIntIterator.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 'dataPoints' accessor can copy the values without iteration.

Field Description

Holds the collected raw data points (when reported).

When the server is configured to include the capture data points for the statistic, the returned array will include the values collected during this interval. This allows monitoring tools to perform non lossy calculation of percentiles providing now data points were skipped due to under sampling or a missed heartbeat. Then number of valid values in the returned array is dicated by numDataPoints, if the length of the values array is longer than numDataPoints subsequent values in the array should be ignored.

NOTE:
Passing a null or empty iterator has the same affect as calling ISrvMonIntSeries.setDataPoints(int[]) with a value of null.

Specified by:

setDataPointsFrom in interface ISrvMonIntSeries

Parameters:

val - the values to set.

addDataPoints

public final void addDataPoints(int val)

Description copied from interface: ISrvMonIntSeries

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

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

Holds the collected raw data points (when reported).

When the server is configured to include the capture data points for the statistic, the returned array will include the values collected during this interval. This allows monitoring tools to perform non lossy calculation of percentiles providing now data points were skipped due to under sampling or a missed heartbeat. Then number of valid values in the returned array is dicated by numDataPoints, if the length of the values array is longer than numDataPoints subsequent values in the array should be ignored.

Specified by:

addDataPoints in interface ISrvMonIntSeries

Parameters:

val - the value to add.

getDataPoints

public final int[] getDataPoints()

Description copied from interface: ISrvMonIntSeries

Gets the value of 'dataPoints'

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

Field Description

Holds the collected raw data points (when reported).

When the server is configured to include the capture data points for the statistic, the returned array will include the values collected during this interval. This allows monitoring tools to perform non lossy calculation of percentiles providing now data points were skipped due to under sampling or a missed heartbeat. Then number of valid values in the returned array is dicated by numDataPoints, if the length of the values array is longer than numDataPoints subsequent values in the array should be ignored.

Specified by:

getDataPoints in interface ISrvMonIntSeries

Returns:

Holds the collected raw data points (when reported). If the field is not set this method will return null.

getDataPointsEmptyIfNull

public final int[] getDataPointsEmptyIfNull()

Description copied from interface: ISrvMonIntSeries

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

Field Description

Holds the collected raw data points (when reported).

When the server is configured to include the capture data points for the statistic, the returned array will include the values collected during this interval. This allows monitoring tools to perform non lossy calculation of percentiles providing now data points were skipped due to under sampling or a missed heartbeat. Then number of valid values in the returned array is dicated by numDataPoints, if the length of the values array is longer than numDataPoints subsequent values in the array should be ignored.

Specified by:

getDataPointsEmptyIfNull in interface ISrvMonIntSeries

Returns:

Holds the collected raw data points (when reported). or an empty array if null if not set.

See Also:

ISrvMonIntSeries.getDataPoints()

getDataPointsIterator

public final XIntIterator getDataPointsIterator()

Description copied from interface: ISrvMonIntSeries

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

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(com.neeve.lang.XIntIterator) method can perform a direct copy of the underlying values without iteration.

Field Description

Holds the collected raw data points (when reported).

When the server is configured to include the capture data points for the statistic, the returned array will include the values collected during this interval. This allows monitoring tools to perform non lossy calculation of percentiles providing now data points were skipped due to under sampling or a missed heartbeat. Then number of valid values in the returned array is dicated by numDataPoints, if the length of the values array is longer than numDataPoints subsequent values in the array should be ignored.

Specified by:

getDataPointsIterator in interface ISrvMonIntSeries

Returns:

An XIntIterator containing this field values.

clearDataPoints

public final void clearDataPoints()

Description copied from interface: ISrvMonIntSeries

Clears the value of 'dataPoints'

Field Description

Holds the collected raw data points (when reported).

When the server is configured to include the capture data points for the statistic, the returned array will include the values collected during this interval. This allows monitoring tools to perform non lossy calculation of percentiles providing now data points were skipped due to under sampling or a missed heartbeat. Then number of valid values in the returned array is dicated by numDataPoints, if the length of the values array is longer than numDataPoints subsequent values in the array should be ignored.

Specified by:

clearDataPoints in interface ISrvMonIntSeries

See Also:

ISrvMonIntSeries.setDataPoints(int[])

getIntervalStatsFieldId

public static final int getIntervalStatsFieldId()

Get the field id for 'intervalStats'

This method can be used to set field interests.

See Also:

getIntervalStats()

setIntervalStats

public final void setIntervalStats(SrvMonIntHistogram val)

Description copied from interface: ISrvMonIntSeries

Sets the value of 'intervalStats'

Field Description

Computed latency statistics for the collection period corresponding to this heartbeat.

Hold computed results for the datpoints captured for this heartbeat (e.g. for the numDataPoints captured). This field may not be set if numDataPoints is 0 or if interval computations are not done on the server.

Specified by:

setIntervalStats in interface ISrvMonIntSeries

Parameters:

val - The value to set.

lendIntervalStats

public final void lendIntervalStats(SrvMonIntHistogram val)

Description copied from interface: ISrvMonIntSeries

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

Field Description

Computed latency statistics for the collection period corresponding to this heartbeat.

Hold computed results for the datpoints captured for this heartbeat (e.g. for the numDataPoints captured). This field may not be set if numDataPoints is 0 or if interval computations are not done on the server.

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:

lendIntervalStats in interface ISrvMonIntSeries

Parameters:

val - the value to 'lend' to lend.

getIntervalStats

public final SrvMonIntHistogram getIntervalStats()

Description copied from interface: ISrvMonIntSeries

Gets the value of 'intervalStats'

Field Description

Computed latency statistics for the collection period corresponding to this heartbeat.

Hold computed results for the datpoints captured for this heartbeat (e.g. for the numDataPoints captured). This field may not be set if numDataPoints is 0 or if interval computations are not done on the server.

Specified by:

getIntervalStats in interface ISrvMonIntSeries

Returns:

Computed latency statistics for the collection period corresponding to this heartbeat.

getIntervalStatsTo

public final void getIntervalStatsTo(SrvMonIntHistogram to)

Description copied from interface: ISrvMonIntSeries

Copies the value of SrvMonIntHistogram into the provided value.

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

Specified by:

getIntervalStatsTo in interface ISrvMonIntSeries

Parameters:

to - the value to copy into

See Also:

SrvMonIntHistogram.copyInto(SrvMonIntHistogram)

takeIntervalStats

public final SrvMonIntHistogram takeIntervalStats()

Description copied from interface: ISrvMonIntSeries

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

Field Description

Computed latency statistics for the collection period corresponding to this heartbeat.

Hold computed results for the datpoints captured for this heartbeat (e.g. for the numDataPoints captured). This field may not be set if numDataPoints is 0 or if interval computations are not done on the server.

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:

takeIntervalStats in interface ISrvMonIntSeries

Returns:

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

hasIntervalStats

public final boolean hasIntervalStats()

Description copied from interface: ISrvMonIntSeries

Checks for the presence of 'intervalStats'

Field Description

Computed latency statistics for the collection period corresponding to this heartbeat.

Hold computed results for the datpoints captured for this heartbeat (e.g. for the numDataPoints captured). This field may not be set if numDataPoints is 0 or if interval computations are not done on the server.

Specified by:

hasIntervalStats in interface ISrvMonIntSeries

See Also:

ISrvMonIntSeries.getIntervalStats()

clearIntervalStats

public final void clearIntervalStats()

Description copied from interface: ISrvMonIntSeries

Clears the value of 'intervalStats'

Field Description

Computed latency statistics for the collection period corresponding to this heartbeat.

Hold computed results for the datpoints captured for this heartbeat (e.g. for the numDataPoints captured). This field may not be set if numDataPoints is 0 or if interval computations are not done on the server.

Specified by:

clearIntervalStats in interface ISrvMonIntSeries

See Also:

ISrvMonIntSeries.setIntervalStats(SrvMonIntHistogram)

getRunningStatsFieldId

public static final int getRunningStatsFieldId()

Get the field id for 'runningStats'

This method can be used to set field interests.

See Also:

getRunningStats()

setRunningStats

public final void setRunningStats(SrvMonIntHistogram val)

Description copied from interface: ISrvMonIntSeries

Sets the value of 'runningStats'

Field Description

Computed latency statistics over the lifetime of the metric being collected.

Hold computed results for the datpoints over the lifetime of this statistics (e.g. since seqNo 1). If the underlying statistic is reset then the running stats are also corresponding reset.

Specified by:

setRunningStats in interface ISrvMonIntSeries

Parameters:

val - The value to set.

lendRunningStats

public final void lendRunningStats(SrvMonIntHistogram val)

Description copied from interface: ISrvMonIntSeries

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

Field Description

Computed latency statistics over the lifetime of the metric being collected.

Hold computed results for the datpoints over the lifetime of this statistics (e.g. since seqNo 1). If the underlying statistic is reset then the running stats are also corresponding reset.

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:

lendRunningStats in interface ISrvMonIntSeries

Parameters:

val - the value to 'lend' to lend.

getRunningStats

public final SrvMonIntHistogram getRunningStats()

Description copied from interface: ISrvMonIntSeries

Gets the value of 'runningStats'

Field Description

Computed latency statistics over the lifetime of the metric being collected.

Hold computed results for the datpoints over the lifetime of this statistics (e.g. since seqNo 1). If the underlying statistic is reset then the running stats are also corresponding reset.

Specified by:

getRunningStats in interface ISrvMonIntSeries

Returns:

Computed latency statistics over the lifetime of the metric being collected.

getRunningStatsTo

public final void getRunningStatsTo(SrvMonIntHistogram to)

Description copied from interface: ISrvMonIntSeries

Copies the value of SrvMonIntHistogram into the provided value.

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

Specified by:

getRunningStatsTo in interface ISrvMonIntSeries

Parameters:

to - the value to copy into

See Also:

SrvMonIntHistogram.copyInto(SrvMonIntHistogram)

takeRunningStats

public final SrvMonIntHistogram takeRunningStats()

Description copied from interface: ISrvMonIntSeries

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

Field Description

Computed latency statistics over the lifetime of the metric being collected.

Hold computed results for the datpoints over the lifetime of this statistics (e.g. since seqNo 1). If the underlying statistic is reset then the running stats are also corresponding reset.

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:

takeRunningStats in interface ISrvMonIntSeries

Returns:

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

hasRunningStats

public final boolean hasRunningStats()

Description copied from interface: ISrvMonIntSeries

Checks for the presence of 'runningStats'

Field Description

Computed latency statistics over the lifetime of the metric being collected.

Hold computed results for the datpoints over the lifetime of this statistics (e.g. since seqNo 1). If the underlying statistic is reset then the running stats are also corresponding reset.

Specified by:

hasRunningStats in interface ISrvMonIntSeries

See Also:

ISrvMonIntSeries.getRunningStats()

clearRunningStats

public final void clearRunningStats()

Description copied from interface: ISrvMonIntSeries

Clears the value of 'runningStats'

Field Description

Computed latency statistics over the lifetime of the metric being collected.

Hold computed results for the datpoints over the lifetime of this statistics (e.g. since seqNo 1). If the underlying statistic is reset then the running stats are also corresponding reset.

Specified by:

clearRunningStats in interface ISrvMonIntSeries

See Also:

ISrvMonIntSeries.setRunningStats(SrvMonIntHistogram)

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

deserializeFromIOElasticBuffer

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

deserializeFromByteArray

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

deserializeFromByteArray

public final SrvMonIntSeries deserializeFromByteArray(byte[] array)

deserializeFromByteBuffer

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

deserializeFromByteBuffer

public final SrvMonIntSeries deserializeFromByteBuffer(ByteBuffer buffer)

deserializeFromNative

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

deserializeFromNative

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

Returns:

Return 'this' object for method invocation chaining.

setPool

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

Returns:

Return 'this' object for method invocation chaining.

getPool

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

Returns:

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

isReferenceCounted

public final boolean isReferenceCounted()

acquire

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

Creates a copy of this SrvMonIntSeries.

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

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

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

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