SrvMonIntHistogram (Talon 3.7.265 API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.neeve.server.mon
Class SrvMonIntHistogram

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

All Implemented Interfaces:: IRogValidatable, ISrvMonIntHistogram, UtlPool.Item<SrvMonIntHistogram>, 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=106) public final class SrvMonIntHistogram
extends Object
implements com.neeve.xbuf.IXbufDesyncer, UtlPool.Item<SrvMonIntHistogram>, ISrvMonIntHistogram
extends Object
implements com.neeve.xbuf.IXbufDesyncer, UtlPool.Item<SrvMonIntHistogram>, ISrvMonIntHistogram

Holds computed histographical data.

SrvMonIntHistogram reports results of server side calculations done for SrvMonIntSeries statistics.

Nested Class Summary
`static class`	`SrvMonIntHistogram.Field` The SrvMonIntHistogram xbuf field (used internally when this entity is used as a field of another entity).
`static class`	`SrvMonIntHistogram.ListField` The SrvMonIntHistogram list field (used internally when this entity is used as an array field of another entity).

Field Summary
`static SrvMonIntHistogram[]`	`EMPTY_ARRAY` A preallocated empty array used to avoid garbage when returning empty arrays of this type.

Constructor Summary
`SrvMonIntHistogram()`
`SrvMonIntHistogram(int initialBackingBufferSize)`

Method Summary
`SrvMonIntHistogram`	`acquire()`
`void`	`clearContent()`
`void`	`clearMaximum()` Clears the value of 'maximum' Field Description The maximum value recorded in the sample set The value may not be set if the sample size is 0.
`void`	`clearMean()` Clears the value of 'mean' Field Description The mean value for the sample set The value may not be set if the sample size is 0.
`void`	`clearMedian()` Clears the value of 'median' Field Description The median value for the sample set The value may not be set if the sample size is 0.
`void`	`clearMinimum()` Clears the value of 'minimum' Field Description The minimum value recorded in the sample set The value may not be set if the sample size is 0.
`void`	`clearPct75()` Clears the value of 'pct75' Field Description The 75th percentile for the sample set The value may not be set if the sample size is 0.
`void`	`clearPct90()` Clears the value of 'pct90' Field Description The 90th percentile for the sample set The value may not be set if the sample size is 0.
`void`	`clearPct99()` Clears the value of 'pct99' Field Description The 99th percentile for the sample set The value may not be set if the sample size is 0.
`void`	`clearPct999()` Clears the value of 'pct999' Field Description The 99.9th percentile for the the sample set The value may not be set if the sample size is 0.
`void`	`clearPct9999()` Clears the value of 'pct9999' Field Description The 99.99th percentile for the sample set The value may not be set if the sample size is 0.
`void`	`clearSampleSize()` Clears the value of 'sampleSize' Field Description The number of datapoints over which results were calculated
`void`	`clearSamplesOverMax()` Clears the value of 'samplesOverMax' Field Description The number of samples that exceeded the maximum recordable value When computing data point percentiles using an HDRHistogram it is possible that a recorded value will exceed the maximum value allowable.
`void`	`clearSamplesUnderMin()` Clears the value of 'samplesUnderMin' Field Description The number of samples that fell below the minimum recordable value When computing data point percentiles using an HDRHistogram it is possible that a recorded value will be below 0 (e.g for latency stats in cases where clock skew is possible.)
`void`	`clearXRogType()`
`Object`	`clone()` Creates a clone of this object.
`SrvMonIntHistogram`	`copy()` Creates a copy of this SrvMonIntHistogram.
`void`	`copyInto(SrvMonIntHistogram copy)` Copies the contents of this SrvMonIntHistogram into the target.
`static SrvMonIntHistogram`	`create()`
`static SrvMonIntHistogram`	`createFrom(byte[] serializedContainer)`
`static SrvMonIntHistogram`	`createFrom(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)`
`static SrvMonIntHistogram`	`createFromSerializedXbufContainer(byte[] serializedContainer)`
`static SrvMonIntHistogram`	`createFromSerializedXbufContainer(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)`
`static com.neeve.xbuf.XbufSchema`	`createSchema()`
`SrvMonIntHistogram`	`deserializeFromByteArray(byte[] array)`
`SrvMonIntHistogram`	`deserializeFromByteArray(byte[] array, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)`
`SrvMonIntHistogram`	`deserializeFromByteBuffer(ByteBuffer buffer)`
`SrvMonIntHistogram`	`deserializeFromByteBuffer(ByteBuffer buffer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)`
`SrvMonIntHistogram`	`deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length)`
`SrvMonIntHistogram`	`deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)`
`SrvMonIntHistogram`	`deserializeFromNative(long address, int offset, int length)`
`SrvMonIntHistogram`	`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()`
`boolean`	`getIsReadOnly()`
`int`	`getMaximum()` Gets the value of 'maximum' Field Description The maximum value recorded in the sample set The value may not be set if the sample size is 0.
`com.neeve.xbuf.XbufVariableIntField`	`getMaximumField()`
`static int`	`getMaximumFieldId()` Get the field id for 'maximum' This method can be used to set field interests.
`int`	`getMean()` Gets the value of 'mean' Field Description The mean value for the sample set The value may not be set if the sample size is 0.
`com.neeve.xbuf.XbufVariableIntField`	`getMeanField()`
`static int`	`getMeanFieldId()` Get the field id for 'mean' This method can be used to set field interests.
`int`	`getMedian()` Gets the value of 'median' Field Description The median value for the sample set The value may not be set if the sample size is 0.
`com.neeve.xbuf.XbufVariableIntField`	`getMedianField()`
`static int`	`getMedianFieldId()` Get the field id for 'median' This method can be used to set field interests.
`int`	`getMinimum()` Gets the value of 'minimum' Field Description The minimum value recorded in the sample set The value may not be set if the sample size is 0.
`com.neeve.xbuf.XbufVariableIntField`	`getMinimumField()`
`static int`	`getMinimumFieldId()` Get the field id for 'minimum' This method can be used to set field interests.
`int`	`getOwnerCount()`
`int`	`getPct75()` Gets the value of 'pct75' Field Description The 75th percentile for the sample set The value may not be set if the sample size is 0.
`com.neeve.xbuf.XbufVariableIntField`	`getPct75Field()`
`static int`	`getPct75FieldId()` Get the field id for 'pct75' This method can be used to set field interests.
`int`	`getPct90()` Gets the value of 'pct90' Field Description The 90th percentile for the sample set The value may not be set if the sample size is 0.
`com.neeve.xbuf.XbufVariableIntField`	`getPct90Field()`
`static int`	`getPct90FieldId()` Get the field id for 'pct90' This method can be used to set field interests.
`int`	`getPct99()` Gets the value of 'pct99' Field Description The 99th percentile for the sample set The value may not be set if the sample size is 0.
`int`	`getPct999()` Gets the value of 'pct999' Field Description The 99.9th percentile for the the sample set The value may not be set if the sample size is 0.
`int`	`getPct9999()` Gets the value of 'pct9999' Field Description The 99.99th percentile for the sample set The value may not be set if the sample size is 0.
`com.neeve.xbuf.XbufVariableIntField`	`getPct9999Field()`
`static int`	`getPct9999FieldId()` Get the field id for 'pct9999' This method can be used to set field interests.
`com.neeve.xbuf.XbufVariableIntField`	`getPct999Field()`
`static int`	`getPct999FieldId()` Get the field id for 'pct999' This method can be used to set field interests.
`com.neeve.xbuf.XbufVariableIntField`	`getPct99Field()`
`static int`	`getPct99FieldId()` Get the field id for 'pct99' This method can be used to set field interests.
`UtlPool<SrvMonIntHistogram>`	`getPool()` Get a pool item's pool.
`long`	`getSampleSize()` Gets the value of 'sampleSize' Field Description The number of datapoints over which results were calculated
`com.neeve.xbuf.XbufVariableLongField`	`getSampleSizeField()`
`static int`	`getSampleSizeFieldId()` Get the field id for 'sampleSize' This method can be used to set field interests.
`long`	`getSamplesOverMax()` Gets the value of 'samplesOverMax' Field Description The number of samples that exceeded the maximum recordable value When computing data point percentiles using an HDRHistogram it is possible that a recorded value will exceed the maximum value allowable.
`com.neeve.xbuf.XbufVariableLongField`	`getSamplesOverMaxField()`
`static int`	`getSamplesOverMaxFieldId()` Get the field id for 'samplesOverMax' This method can be used to set field interests.
`long`	`getSamplesUnderMin()` Gets the value of 'samplesUnderMin' Field Description The number of samples that fell below the minimum recordable value When computing data point percentiles using an HDRHistogram it is possible that a recorded value will be below 0 (e.g for latency stats in cases where clock skew is possible.)
`com.neeve.xbuf.XbufVariableLongField`	`getSamplesUnderMinField()`
`static int`	`getSamplesUnderMinFieldId()` Get the field id for 'samplesUnderMin' 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`	`hasMaximum()` Checks for the presence of 'maximum' Field Description The maximum value recorded in the sample set The value may not be set if the sample size is 0.
`boolean`	`hasMean()` Checks for the presence of 'mean' Field Description The mean value for the sample set The value may not be set if the sample size is 0.
`boolean`	`hasMedian()` Checks for the presence of 'median' Field Description The median value for the sample set The value may not be set if the sample size is 0.
`boolean`	`hasMinimum()` Checks for the presence of 'minimum' Field Description The minimum value recorded in the sample set The value may not be set if the sample size is 0.
`boolean`	`hasPct75()` Checks for the presence of 'pct75' Field Description The 75th percentile for the sample set The value may not be set if the sample size is 0.
`boolean`	`hasPct90()` Checks for the presence of 'pct90' Field Description The 90th percentile for the sample set The value may not be set if the sample size is 0.
`boolean`	`hasPct99()` Checks for the presence of 'pct99' Field Description The 99th percentile for the sample set The value may not be set if the sample size is 0.
`boolean`	`hasPct999()` Checks for the presence of 'pct999' Field Description The 99.9th percentile for the the sample set The value may not be set if the sample size is 0.
`boolean`	`hasPct9999()` Checks for the presence of 'pct9999' Field Description The 99.99th percentile for the sample set The value may not be set if the sample size is 0.
`boolean`	`hasSampleSize()` Checks for the presence of 'sampleSize' Field Description The number of datapoints over which results were calculated
`boolean`	`hasSamplesOverMax()` Checks for the presence of 'samplesOverMax' Field Description The number of samples that exceeded the maximum recordable value When computing data point percentiles using an HDRHistogram it is possible that a recorded value will exceed the maximum value allowable.
`boolean`	`hasSamplesUnderMin()` Checks for the presence of 'samplesUnderMin' Field Description The number of samples that fell below the minimum recordable value When computing data point percentiles using an HDRHistogram it is possible that a recorded value will be below 0 (e.g for latency stats in cases where clock skew is possible.)
`boolean`	`hasXRogType()`
`SrvMonIntHistogram`	`init()` Initialize an item.
`boolean`	`isBufferBacked()`
`boolean`	`isDirty()`
`boolean`	`isReferenceCounted()`
`boolean`	`isValid()` Tests if this object has any validation errors.
`static void`	`optimizeFor(int val)`
`byte[]`	`serializeToByteArray()`
`ByteBuffer`	`serializeToByteBuffer()`
`com.neeve.io.IOBuffer`	`serializeToIOBuffer(boolean useNative)`
`int`	`serializeToNative(long address, int addressOffset)`
`void`	`setAsReadOnly()`
`static void`	`setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)`
`static void`	`setFieldInterest(List<Integer> fieldIds)`
`void`	`setMaximum(int val)` Sets the value of 'maximum' Field Description The maximum value recorded in the sample set The value may not be set if the sample size is 0.
`void`	`setMaximumFrom(com.neeve.xbuf.XbufVariableIntField val)`
`void`	`setMean(int val)` Sets the value of 'mean' Field Description The mean value for the sample set The value may not be set if the sample size is 0.
`void`	`setMeanFrom(com.neeve.xbuf.XbufVariableIntField val)`
`void`	`setMedian(int val)` Sets the value of 'median' Field Description The median value for the sample set The value may not be set if the sample size is 0.
`void`	`setMedianFrom(com.neeve.xbuf.XbufVariableIntField val)`
`void`	`setMinimum(int val)` Sets the value of 'minimum' Field Description The minimum value recorded in the sample set The value may not be set if the sample size is 0.
`void`	`setMinimumFrom(com.neeve.xbuf.XbufVariableIntField val)`
`void`	`setPct75(int val)` Sets the value of 'pct75' Field Description The 75th percentile for the sample set The value may not be set if the sample size is 0.
`void`	`setPct75From(com.neeve.xbuf.XbufVariableIntField val)`
`void`	`setPct90(int val)` Sets the value of 'pct90' Field Description The 90th percentile for the sample set The value may not be set if the sample size is 0.
`void`	`setPct90From(com.neeve.xbuf.XbufVariableIntField val)`
`void`	`setPct99(int val)` Sets the value of 'pct99' Field Description The 99th percentile for the sample set The value may not be set if the sample size is 0.
`void`	`setPct999(int val)` Sets the value of 'pct999' Field Description The 99.9th percentile for the the sample set The value may not be set if the sample size is 0.
`void`	`setPct9999(int val)` Sets the value of 'pct9999' Field Description The 99.99th percentile for the sample set The value may not be set if the sample size is 0.
`void`	`setPct9999From(com.neeve.xbuf.XbufVariableIntField val)`
`void`	`setPct999From(com.neeve.xbuf.XbufVariableIntField val)`
`void`	`setPct99From(com.neeve.xbuf.XbufVariableIntField val)`
`SrvMonIntHistogram`	`setPool(UtlPool<SrvMonIntHistogram> pool)` Set a pool item's pool.
`void`	`setSampleSize(long val)` Sets the value of 'sampleSize' Field Description The number of datapoints over which results were calculated
`void`	`setSampleSizeFrom(com.neeve.xbuf.XbufVariableLongField val)`
`void`	`setSamplesOverMax(long val)` Sets the value of 'samplesOverMax' Field Description The number of samples that exceeded the maximum recordable value When computing data point percentiles using an HDRHistogram it is possible that a recorded value will exceed the maximum value allowable.
`void`	`setSamplesOverMaxFrom(com.neeve.xbuf.XbufVariableLongField val)`
`void`	`setSamplesUnderMin(long val)` Sets the value of 'samplesUnderMin' Field Description The number of samples that fell below the minimum recordable value When computing data point percentiles using an HDRHistogram it is possible that a recorded value will be below 0 (e.g for latency stats in cases where clock skew is possible.)
`void`	`setSamplesUnderMinFrom(com.neeve.xbuf.XbufVariableLongField val)`
`void`	`setXRogType(short val)`
`void`	`setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)`
`void`	`sync()`
`void`	`syncFieldBitmask()`
`String`	`toString()`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

EMPTY_ARRAY

public static final SrvMonIntHistogram[] EMPTY_ARRAY

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

Constructor Detail

SrvMonIntHistogram

public SrvMonIntHistogram()

SrvMonIntHistogram

public SrvMonIntHistogram(int initialBackingBufferSize)

Method Detail

create

public static SrvMonIntHistogram create()

createFromSerializedXbufContainer

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

createFromSerializedXbufContainer

public static SrvMonIntHistogram createFromSerializedXbufContainer(byte[] serializedContainer)

createFrom

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

createFrom

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

getSampleSizeFieldId

public static final int getSampleSizeFieldId()

Get the field id for 'sampleSize'

This method can be used to set field interests.

See Also:: getSampleSize()

setSampleSize

public final void setSampleSize(long val)

Description copied from interface: ISrvMonIntHistogram

Sets the value of 'sampleSize'

Field Description

The number of datapoints over which results were calculated

Specified by:: setSampleSize in interface ISrvMonIntHistogram

Parameters:: val - The value to set.

getSampleSize

public final long getSampleSize()

Description copied from interface: ISrvMonIntHistogram

Gets the value of 'sampleSize'

Field Description

The number of datapoints over which results were calculated

Specified by:: getSampleSize in interface ISrvMonIntHistogram

Returns:: The number of datapoints over which results were calculated

setSampleSizeFrom

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

getSampleSizeField

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

hasSampleSize

public final boolean hasSampleSize()

Description copied from interface: ISrvMonIntHistogram

Checks for the presence of 'sampleSize'

Field Description

The number of datapoints over which results were calculated

Specified by:: hasSampleSize in interface ISrvMonIntHistogram

See Also:: ISrvMonIntHistogram.getSampleSize()

clearSampleSize

public final void clearSampleSize()

Description copied from interface: ISrvMonIntHistogram

Clears the value of 'sampleSize'

Field Description

The number of datapoints over which results were calculated

Specified by:: clearSampleSize in interface ISrvMonIntHistogram

See Also:: ISrvMonIntHistogram.setSampleSize(long)

getMinimumFieldId

public static final int getMinimumFieldId()

Get the field id for 'minimum'

This method can be used to set field interests.

See Also:: getMinimum()

setMinimum

public final void setMinimum(int val)

Description copied from interface: ISrvMonIntHistogram

Sets the value of 'minimum'

Field Description

The minimum value recorded in the sample set

The value may not be set if the sample size is 0.

Specified by:: setMinimum in interface ISrvMonIntHistogram

Parameters:: val - The value to set.

getMinimum

public final int getMinimum()

Description copied from interface: ISrvMonIntHistogram

Gets the value of 'minimum'

Field Description

The minimum value recorded in the sample set

The value may not be set if the sample size is 0.

Specified by:: getMinimum in interface ISrvMonIntHistogram

Returns:: The minimum value recorded in the sample set

setMinimumFrom

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

getMinimumField

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

hasMinimum

public final boolean hasMinimum()

Description copied from interface: ISrvMonIntHistogram

Checks for the presence of 'minimum'

Field Description

The minimum value recorded in the sample set

The value may not be set if the sample size is 0.

Specified by:: hasMinimum in interface ISrvMonIntHistogram

See Also:: ISrvMonIntHistogram.getMinimum()

clearMinimum

public final void clearMinimum()

Description copied from interface: ISrvMonIntHistogram

Clears the value of 'minimum'

Field Description

The minimum value recorded in the sample set

The value may not be set if the sample size is 0.

Specified by:: clearMinimum in interface ISrvMonIntHistogram

See Also:: ISrvMonIntHistogram.setMinimum(int)

getMaximumFieldId

public static final int getMaximumFieldId()

Get the field id for 'maximum'

This method can be used to set field interests.

See Also:: getMaximum()

setMaximum

public final void setMaximum(int val)

Description copied from interface: ISrvMonIntHistogram

Sets the value of 'maximum'

Field Description

The maximum value recorded in the sample set

The value may not be set if the sample size is 0.

Specified by:: setMaximum in interface ISrvMonIntHistogram

Parameters:: val - The value to set.

getMaximum

public final int getMaximum()

Description copied from interface: ISrvMonIntHistogram

Gets the value of 'maximum'

Field Description

The maximum value recorded in the sample set

The value may not be set if the sample size is 0.

Specified by:: getMaximum in interface ISrvMonIntHistogram

Returns:: The maximum value recorded in the sample set

setMaximumFrom

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

getMaximumField

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

hasMaximum

public final boolean hasMaximum()

Description copied from interface: ISrvMonIntHistogram

Checks for the presence of 'maximum'

Field Description

The maximum value recorded in the sample set

The value may not be set if the sample size is 0.

Specified by:: hasMaximum in interface ISrvMonIntHistogram

See Also:: ISrvMonIntHistogram.getMaximum()

clearMaximum

public final void clearMaximum()

Description copied from interface: ISrvMonIntHistogram

Clears the value of 'maximum'

Field Description

The maximum value recorded in the sample set

The value may not be set if the sample size is 0.

Specified by:: clearMaximum in interface ISrvMonIntHistogram

See Also:: ISrvMonIntHistogram.setMaximum(int)

getMeanFieldId

public static final int getMeanFieldId()

Get the field id for 'mean'

This method can be used to set field interests.

See Also:: getMean()

setMean

public final void setMean(int val)

Description copied from interface: ISrvMonIntHistogram

Sets the value of 'mean'

Field Description

The mean value for the sample set

The value may not be set if the sample size is 0.

Specified by:: setMean in interface ISrvMonIntHistogram

Parameters:: val - The value to set.

getMean

public final int getMean()

Description copied from interface: ISrvMonIntHistogram

Gets the value of 'mean'

Field Description

The mean value for the sample set

The value may not be set if the sample size is 0.

Specified by:: getMean in interface ISrvMonIntHistogram

Returns:: The mean value for the sample set

setMeanFrom

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

getMeanField

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

hasMean

public final boolean hasMean()

Description copied from interface: ISrvMonIntHistogram

Checks for the presence of 'mean'

Field Description

The mean value for the sample set

The value may not be set if the sample size is 0.

Specified by:: hasMean in interface ISrvMonIntHistogram

See Also:: ISrvMonIntHistogram.getMean()

clearMean

public final void clearMean()

Description copied from interface: ISrvMonIntHistogram

Clears the value of 'mean'

Field Description

The mean value for the sample set

The value may not be set if the sample size is 0.

Specified by:: clearMean in interface ISrvMonIntHistogram

See Also:: ISrvMonIntHistogram.setMean(int)

getMedianFieldId

public static final int getMedianFieldId()

Get the field id for 'median'

This method can be used to set field interests.

See Also:: getMedian()

setMedian

public final void setMedian(int val)

Description copied from interface: ISrvMonIntHistogram

Sets the value of 'median'

Field Description

The median value for the sample set

The value may not be set if the sample size is 0.

Specified by:: setMedian in interface ISrvMonIntHistogram

Parameters:: val - The value to set.

getMedian

public final int getMedian()

Description copied from interface: ISrvMonIntHistogram

Gets the value of 'median'

Field Description

The median value for the sample set

The value may not be set if the sample size is 0.

Specified by:: getMedian in interface ISrvMonIntHistogram

Returns:: The median value for the sample set

setMedianFrom

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

getMedianField

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

hasMedian

public final boolean hasMedian()

Description copied from interface: ISrvMonIntHistogram

Checks for the presence of 'median'

Field Description

The median value for the sample set

The value may not be set if the sample size is 0.

Specified by:: hasMedian in interface ISrvMonIntHistogram

See Also:: ISrvMonIntHistogram.getMedian()

clearMedian

public final void clearMedian()

Description copied from interface: ISrvMonIntHistogram

Clears the value of 'median'

Field Description

The median value for the sample set

The value may not be set if the sample size is 0.

Specified by:: clearMedian in interface ISrvMonIntHistogram

See Also:: ISrvMonIntHistogram.setMedian(int)

getPct75FieldId

public static final int getPct75FieldId()

Get the field id for 'pct75'

This method can be used to set field interests.

See Also:: getPct75()

setPct75

public final void setPct75(int val)

Description copied from interface: ISrvMonIntHistogram

Sets the value of 'pct75'

Field Description

The 75th percentile for the sample set

The value may not be set if the sample size is 0.

Specified by:: setPct75 in interface ISrvMonIntHistogram

Parameters:: val - The value to set.

getPct75

public final int getPct75()

Description copied from interface: ISrvMonIntHistogram

Gets the value of 'pct75'

Field Description

The 75th percentile for the sample set

The value may not be set if the sample size is 0.

Specified by:: getPct75 in interface ISrvMonIntHistogram

Returns:: The 75th percentile for the sample set

setPct75From

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

getPct75Field

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

hasPct75

public final boolean hasPct75()

Description copied from interface: ISrvMonIntHistogram

Checks for the presence of 'pct75'

Field Description

The 75th percentile for the sample set

The value may not be set if the sample size is 0.

Specified by:: hasPct75 in interface ISrvMonIntHistogram

See Also:: ISrvMonIntHistogram.getPct75()

clearPct75

public final void clearPct75()

Description copied from interface: ISrvMonIntHistogram

Clears the value of 'pct75'

Field Description

The 75th percentile for the sample set

The value may not be set if the sample size is 0.

Specified by:: clearPct75 in interface ISrvMonIntHistogram

See Also:: ISrvMonIntHistogram.setPct75(int)

getPct90FieldId

public static final int getPct90FieldId()

Get the field id for 'pct90'

This method can be used to set field interests.

See Also:: getPct90()

setPct90

public final void setPct90(int val)

Description copied from interface: ISrvMonIntHistogram

Sets the value of 'pct90'

Field Description

The 90th percentile for the sample set

The value may not be set if the sample size is 0.

Specified by:: setPct90 in interface ISrvMonIntHistogram

Parameters:: val - The value to set.

getPct90

public final int getPct90()

Description copied from interface: ISrvMonIntHistogram

Gets the value of 'pct90'

Field Description

The 90th percentile for the sample set

The value may not be set if the sample size is 0.

Specified by:: getPct90 in interface ISrvMonIntHistogram

Returns:: The 90th percentile for the sample set

setPct90From

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

getPct90Field

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

hasPct90

public final boolean hasPct90()

Description copied from interface: ISrvMonIntHistogram

Checks for the presence of 'pct90'

Field Description

The 90th percentile for the sample set

The value may not be set if the sample size is 0.

Specified by:: hasPct90 in interface ISrvMonIntHistogram

See Also:: ISrvMonIntHistogram.getPct90()

clearPct90

public final void clearPct90()

Description copied from interface: ISrvMonIntHistogram

Clears the value of 'pct90'

Field Description

The 90th percentile for the sample set

The value may not be set if the sample size is 0.

Specified by:: clearPct90 in interface ISrvMonIntHistogram

See Also:: ISrvMonIntHistogram.setPct90(int)

getPct99FieldId

public static final int getPct99FieldId()

Get the field id for 'pct99'

This method can be used to set field interests.

See Also:: getPct99()

setPct99

public final void setPct99(int val)

Description copied from interface: ISrvMonIntHistogram

Sets the value of 'pct99'

Field Description

The 99th percentile for the sample set

The value may not be set if the sample size is 0.

Specified by:: setPct99 in interface ISrvMonIntHistogram

Parameters:: val - The value to set.

getPct99

public final int getPct99()

Description copied from interface: ISrvMonIntHistogram

Gets the value of 'pct99'

Field Description

The 99th percentile for the sample set

The value may not be set if the sample size is 0.

Specified by:: getPct99 in interface ISrvMonIntHistogram

Returns:: The 99th percentile for the sample set

setPct99From

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

getPct99Field

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

hasPct99

public final boolean hasPct99()

Description copied from interface: ISrvMonIntHistogram

Checks for the presence of 'pct99'

Field Description

The 99th percentile for the sample set

The value may not be set if the sample size is 0.

Specified by:: hasPct99 in interface ISrvMonIntHistogram

See Also:: ISrvMonIntHistogram.getPct99()

clearPct99

public final void clearPct99()

Description copied from interface: ISrvMonIntHistogram

Clears the value of 'pct99'

Field Description

The 99th percentile for the sample set

The value may not be set if the sample size is 0.

Specified by:: clearPct99 in interface ISrvMonIntHistogram

See Also:: ISrvMonIntHistogram.setPct99(int)

getPct999FieldId

public static final int getPct999FieldId()

Get the field id for 'pct999'

This method can be used to set field interests.

See Also:: getPct999()

setPct999

public final void setPct999(int val)

Description copied from interface: ISrvMonIntHistogram

Sets the value of 'pct999'

Field Description

The 99.9th percentile for the the sample set

The value may not be set if the sample size is 0.

Specified by:: setPct999 in interface ISrvMonIntHistogram

Parameters:: val - The value to set.

getPct999

public final int getPct999()

Description copied from interface: ISrvMonIntHistogram

Gets the value of 'pct999'

Field Description

The 99.9th percentile for the the sample set

The value may not be set if the sample size is 0.

Specified by:: getPct999 in interface ISrvMonIntHistogram

Returns:: The 99.9th percentile for the the sample set

setPct999From

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

getPct999Field

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

hasPct999

public final boolean hasPct999()

Description copied from interface: ISrvMonIntHistogram

Checks for the presence of 'pct999'

Field Description

The 99.9th percentile for the the sample set

The value may not be set if the sample size is 0.

Specified by:: hasPct999 in interface ISrvMonIntHistogram

See Also:: ISrvMonIntHistogram.getPct999()

clearPct999

public final void clearPct999()

Description copied from interface: ISrvMonIntHistogram

Clears the value of 'pct999'

Field Description

The 99.9th percentile for the the sample set

The value may not be set if the sample size is 0.

Specified by:: clearPct999 in interface ISrvMonIntHistogram

See Also:: ISrvMonIntHistogram.setPct999(int)

getPct9999FieldId

public static final int getPct9999FieldId()

Get the field id for 'pct9999'

This method can be used to set field interests.

See Also:: getPct9999()

setPct9999

public final void setPct9999(int val)

Description copied from interface: ISrvMonIntHistogram

Sets the value of 'pct9999'

Field Description

The 99.99th percentile for the sample set

The value may not be set if the sample size is 0.

Specified by:: setPct9999 in interface ISrvMonIntHistogram

Parameters:: val - The value to set.

getPct9999

public final int getPct9999()

Description copied from interface: ISrvMonIntHistogram

Gets the value of 'pct9999'

Field Description

The 99.99th percentile for the sample set

The value may not be set if the sample size is 0.

Specified by:: getPct9999 in interface ISrvMonIntHistogram

Returns:: The 99.99th percentile for the sample set

setPct9999From

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

getPct9999Field

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

hasPct9999

public final boolean hasPct9999()

Description copied from interface: ISrvMonIntHistogram

Checks for the presence of 'pct9999'

Field Description

The 99.99th percentile for the sample set

The value may not be set if the sample size is 0.

Specified by:: hasPct9999 in interface ISrvMonIntHistogram

See Also:: ISrvMonIntHistogram.getPct9999()

clearPct9999

public final void clearPct9999()

Description copied from interface: ISrvMonIntHistogram

Clears the value of 'pct9999'

Field Description

The 99.99th percentile for the sample set

The value may not be set if the sample size is 0.

Specified by:: clearPct9999 in interface ISrvMonIntHistogram

See Also:: ISrvMonIntHistogram.setPct9999(int)

getSamplesOverMaxFieldId

public static final int getSamplesOverMaxFieldId()

Get the field id for 'samplesOverMax'

This method can be used to set field interests.

See Also:: getSamplesOverMax()

setSamplesOverMax

public final void setSamplesOverMax(long val)

Description copied from interface: ISrvMonIntHistogram

Sets the value of 'samplesOverMax'

Field Description

The number of samples that exceeded the maximum recordable value

When computing data point percentiles using an HDRHistogram it is possible that a recorded value will exceed the maximum value allowable. In this case the data point is downsampled to the maximum recordable value which skews the percentile calculations lower. SamplesOverMax allows detection of how frequently this is occuring.

Specified by:: setSamplesOverMax in interface ISrvMonIntHistogram

Parameters:: val - The value to set.

getSamplesOverMax

public final long getSamplesOverMax()

Description copied from interface: ISrvMonIntHistogram

Gets the value of 'samplesOverMax'

Field Description

The number of samples that exceeded the maximum recordable value

Specified by:: getSamplesOverMax in interface ISrvMonIntHistogram

Returns:: The number of samples that exceeded the maximum recordable value

setSamplesOverMaxFrom

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

getSamplesOverMaxField

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

hasSamplesOverMax

public final boolean hasSamplesOverMax()

Description copied from interface: ISrvMonIntHistogram

Checks for the presence of 'samplesOverMax'

Field Description

The number of samples that exceeded the maximum recordable value

Specified by:: hasSamplesOverMax in interface ISrvMonIntHistogram

See Also:: ISrvMonIntHistogram.getSamplesOverMax()

clearSamplesOverMax

public final void clearSamplesOverMax()

Description copied from interface: ISrvMonIntHistogram

Clears the value of 'samplesOverMax'

Field Description

The number of samples that exceeded the maximum recordable value

Specified by:: clearSamplesOverMax in interface ISrvMonIntHistogram

See Also:: ISrvMonIntHistogram.setSamplesOverMax(long)

getSamplesUnderMinFieldId

public static final int getSamplesUnderMinFieldId()

Get the field id for 'samplesUnderMin'

This method can be used to set field interests.

See Also:: getSamplesUnderMin()

setSamplesUnderMin

public final void setSamplesUnderMin(long val)

Description copied from interface: ISrvMonIntHistogram

Sets the value of 'samplesUnderMin'

Field Description

The number of samples that fell below the minimum recordable value

When computing data point percentiles using an HDRHistogram it is possible that a recorded value will be below 0 (e.g for latency stats in cases where clock skew is possible.) In such cases the the value will be upsampled to 0 which can skew the histogram results. SamplesUnderMin allows detection of how frequently this is happening.

Specified by:: setSamplesUnderMin in interface ISrvMonIntHistogram

Parameters:: val - The value to set.

getSamplesUnderMin

public final long getSamplesUnderMin()

Description copied from interface: ISrvMonIntHistogram

Gets the value of 'samplesUnderMin'

Field Description

The number of samples that fell below the minimum recordable value

Specified by:: getSamplesUnderMin in interface ISrvMonIntHistogram

Returns:: The number of samples that fell below the minimum recordable value

setSamplesUnderMinFrom

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

getSamplesUnderMinField

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

hasSamplesUnderMin

public final boolean hasSamplesUnderMin()

Description copied from interface: ISrvMonIntHistogram

Checks for the presence of 'samplesUnderMin'

Field Description

The number of samples that fell below the minimum recordable value

Specified by:: hasSamplesUnderMin in interface ISrvMonIntHistogram

See Also:: ISrvMonIntHistogram.getSamplesUnderMin()

clearSamplesUnderMin

public final void clearSamplesUnderMin()

Description copied from interface: ISrvMonIntHistogram

Clears the value of 'samplesUnderMin'

Field Description

The number of samples that fell below the minimum recordable value

Specified by:: clearSamplesUnderMin in interface ISrvMonIntHistogram

See Also:: ISrvMonIntHistogram.setSamplesUnderMin(long)

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

deserializeFromIOElasticBuffer

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

deserializeFromByteArray

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

deserializeFromByteArray

public final SrvMonIntHistogram deserializeFromByteArray(byte[] array)

deserializeFromByteBuffer

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

deserializeFromByteBuffer

public final SrvMonIntHistogram deserializeFromByteBuffer(ByteBuffer buffer)

deserializeFromNative

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

deserializeFromNative

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

Returns:: Return 'this' object for method invocation chaining.

setPool

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

Returns:: Return 'this' object for method invocation chaining.

getPool

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

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

isReferenceCounted

public final boolean isReferenceCounted()

acquire

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

Creates a copy of this SrvMonIntHistogram.

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

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

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

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

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.neeve.server.mon Class SrvMonIntHistogram

EMPTY_ARRAY

SrvMonIntHistogram

SrvMonIntHistogram

create

createFromSerializedXbufContainer

createFromSerializedXbufContainer

createFrom

createFrom

setDesyncPolicy

getDesyncPolicy

setFieldInterest

clearContent

syncFieldBitmask

desyncFieldBitmask

getBackingBuffer

optimizeFor

setAsReadOnly

getIsReadOnly

getXRogTypeFieldId

setXRogType

getXRogType

setXRogTypeFrom

getXRogTypeField

hasXRogType

clearXRogType

getSampleSizeFieldId

setSampleSize

Field Description

getSampleSize

Field Description

setSampleSizeFrom

getSampleSizeField

hasSampleSize

Field Description

clearSampleSize

Field Description

getMinimumFieldId

setMinimum

Field Description

getMinimum

Field Description

setMinimumFrom

getMinimumField

hasMinimum

Field Description

clearMinimum

Field Description

getMaximumFieldId

setMaximum

Field Description

getMaximum

Field Description

setMaximumFrom

getMaximumField

hasMaximum

Field Description

clearMaximum

Field Description

getMeanFieldId

setMean

Field Description

getMean

Field Description

setMeanFrom

getMeanField

hasMean

Field Description

clearMean

Field Description

getMedianFieldId

setMedian

Field Description

getMedian

Field Description

setMedianFrom

getMedianField

hasMedian

Field Description

clearMedian

com.neeve.server.mon
Class SrvMonIntHistogram