com.neeve.server.mon

Interface ISrvMonPoolStats

All Superinterfaces:

IRogValidatable

All Known Implementing Classes:

SrvMonPoolStats

@Generated(value="com.neeve.adm.AdmGenerator",
           date="Thu May 07 15:37:32 EDT 2020")
@AdmGenerated(compatLevel="4.0.0",
              admVersion="nvx-rumi-adm v3.14 (build 29)",
              date="5/7/20 3:37 PM",
              buildInfo="nvx-talon-3.14.19 (nvx-codegen-plugin)")
public interface ISrvMonPoolStats
extends IRogValidatable

Holds stats for a pool.

To keep heartbeat size under control, stats for a given pool are only included in a heartbeat if their have been pool misses in the last collection interval. Otherwise pool stats may be emitted periodically even without misses based on other criteria as well.

ADM Details

ADM Type	Embedded Entity
Factory	SrvMonFactory

ADM Field Summary

Field	Type	Id	Description
capacity	Integer	10	The current number of slots in the pool to hold elements that are not in use.
detachedWashes	Long	8	The number of elements initialized by the detached pool washer thread.
evicts	Long	7	The number of elements that have been evicted from the pool because the pool doesn't have capacity.
gets	Long	3	The number of times an element has been requested from the pool.
growths	Long	6	The number of times the pool capacity has been increased to accomodate free elements.
hits	Long	4	The number of times an element has been requested from the pool without needing to allocate a new object.
key	String	1	The name of the pool.
misses	Long	5	The number of times an element has been requested from the pool which required allocating a new object.
preallocated	Integer	11	The number of elements initially preallocated in the pool.
puts	Long	2	The number of times an element has been put (returned) to the pool.
size	Integer	9	The number of elements currently available in the pool to satisfy gets. Note that a value of 0 does not necessarily indicate that there is a pooling issue: a healthy pool in which elements are continuously being recycled will have a size of zero frequently while the elements have been checked out by the thread using them.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearCapacity() Clears the value of 'capacity'.
void	clearDetachedWashes() Clears the value of 'detachedWashes'.
void	clearEvicts() Clears the value of 'evicts'.
void	clearGets() Clears the value of 'gets'.
void	clearGrowths() Clears the value of 'growths'.
void	clearHits() Clears the value of 'hits'.
void	clearKey() Clears the value of 'key'.
void	clearMisses() Clears the value of 'misses'.
void	clearPreallocated() Clears the value of 'preallocated'.
void	clearPuts() Clears the value of 'puts'.
void	clearSize() Clears the value of 'size'.
int	getCapacity() Gets the value of 'capacity'.
long	getDetachedWashes() Gets the value of 'detachedWashes'.
long	getEvicts() Gets the value of 'evicts'.
long	getGets() Gets the value of 'gets'.
long	getGrowths() Gets the value of 'growths'.
long	getHits() Gets the value of 'hits'.
String	getKey() Gets the value of 'key'.
<T extends XString> T	getKeyTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getKeyTo(XString val) Copies the value of 'key' into the provided XString.
XString	getKeyUnsafe() Gets the raw value of 'key'.
long	getMisses() Gets the value of 'misses'.
int	getPreallocated() Gets the value of 'preallocated'.
long	getPuts() Gets the value of 'puts'.
int	getSize() Gets the value of 'size'.
boolean	hasCapacity() Checks for the presence of 'capacity'.
boolean	hasDetachedWashes() Checks for the presence of 'detachedWashes'.
boolean	hasEvicts() Checks for the presence of 'evicts'.
boolean	hasGets() Checks for the presence of 'gets'.
boolean	hasGrowths() Checks for the presence of 'growths'.
boolean	hasHits() Checks for the presence of 'hits'.
boolean	hasKey() Checks for the presence of 'key'.
boolean	hasMisses() Checks for the presence of 'misses'.
boolean	hasPreallocated() Checks for the presence of 'preallocated'.
boolean	hasPuts() Checks for the presence of 'puts'.
boolean	hasSize() Checks for the presence of 'size'.
void	lendKey(XString val) Lends the value of 'key' to this object.
void	setCapacity(int val) Sets the value of 'capacity'.
void	setDetachedWashes(long val) Sets the value of 'detachedWashes'.
void	setEvicts(long val) Sets the value of 'evicts'.
void	setGets(long val) Sets the value of 'gets'.
void	setGrowths(long val) Sets the value of 'growths'.
void	setHits(long val) Sets the value of 'hits'.
void	setKey(String val) Sets the value of 'key'.
void	setKeyFrom(long val) Sets the value of this String field to the given numeric value.
void	setKeyFrom(XString val) Copies the provided XString value into this object's 'key'.
void	setMisses(long val) Sets the value of 'misses'.
void	setPreallocated(int val) Sets the value of 'preallocated'.
void	setPuts(long val) Sets the value of 'puts'.
void	setSize(int val) Sets the value of 'size'.

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

setPuts

void setPuts(long val)

Sets the value of 'puts'.

Field Description

The number of times an element has been put (returned) to the pool.

Parameters:

val - The value to set.

getPuts

long getPuts()

Gets the value of 'puts'.

Field Description

The number of times an element has been put (returned) to the pool.

Returns:

The number of times an element has been put (returned) to the pool.

clearPuts

void clearPuts()

Clears the value of 'puts'.

Field Description

The number of times an element has been put (returned) to the pool.

See Also:

setPuts(long)

hasPuts

boolean hasPuts()

Checks for the presence of 'puts'.

Field Description

The number of times an element has been put (returned) to the pool.

See Also:

getPuts()

setGets

void setGets(long val)

Sets the value of 'gets'.

Field Description

The number of times an element has been requested from the pool.

Parameters:

val - The value to set.

getGets

long getGets()

Gets the value of 'gets'.

Field Description

The number of times an element has been requested from the pool.

Returns:

The number of times an element has been requested from the pool.

clearGets

void clearGets()

Clears the value of 'gets'.

Field Description

The number of times an element has been requested from the pool.

See Also:

setGets(long)

hasGets

boolean hasGets()

Checks for the presence of 'gets'.

Field Description

The number of times an element has been requested from the pool.

See Also:

getGets()

setHits

void setHits(long val)

Sets the value of 'hits'.

Field Description

The number of times an element has been requested from the pool without needing to allocate a new object.

Parameters:

val - The value to set.

getHits

long getHits()

Gets the value of 'hits'.

Field Description

The number of times an element has been requested from the pool without needing to allocate a new object.

Returns:

The number of times an element has been requested from the pool without needing to allocate a new object.

clearHits

void clearHits()

Clears the value of 'hits'.

Field Description

The number of times an element has been requested from the pool without needing to allocate a new object.

See Also:

setHits(long)

hasHits

boolean hasHits()

Checks for the presence of 'hits'.

Field Description

The number of times an element has been requested from the pool without needing to allocate a new object.

See Also:

getHits()

setMisses

void setMisses(long val)

Sets the value of 'misses'.

Field Description

The number of times an element has been requested from the pool which required allocating a new object.

Parameters:

val - The value to set.

getMisses

long getMisses()

Gets the value of 'misses'.

Field Description

The number of times an element has been requested from the pool which required allocating a new object.

Returns:

The number of times an element has been requested from the pool which required allocating a new object.

clearMisses

void clearMisses()

Clears the value of 'misses'.

Field Description

The number of times an element has been requested from the pool which required allocating a new object.

See Also:

setMisses(long)

hasMisses

boolean hasMisses()

Checks for the presence of 'misses'.

Field Description

The number of times an element has been requested from the pool which required allocating a new object.

See Also:

getMisses()

setGrowths

void setGrowths(long val)

Sets the value of 'growths'.

Field Description

The number of times the pool capacity has been increased to accomodate free elements.

Parameters:

val - The value to set.

getGrowths

long getGrowths()

Gets the value of 'growths'.

Field Description

The number of times the pool capacity has been increased to accomodate free elements.

Returns:

The number of times the pool capacity has been increased to accomodate free elements.

clearGrowths

void clearGrowths()

Clears the value of 'growths'.

Field Description

The number of times the pool capacity has been increased to accomodate free elements.

See Also:

setGrowths(long)

hasGrowths

boolean hasGrowths()

Checks for the presence of 'growths'.

Field Description

The number of times the pool capacity has been increased to accomodate free elements.

See Also:

getGrowths()

setEvicts

void setEvicts(long val)

Sets the value of 'evicts'.

Field Description

The number of elements that have been evicted from the pool because the pool doesn't have capacity.

Parameters:

val - The value to set.

getEvicts

long getEvicts()

Gets the value of 'evicts'.

Field Description

The number of elements that have been evicted from the pool because the pool doesn't have capacity.

Returns:

The number of elements that have been evicted from the pool because the pool doesn't have capacity.

clearEvicts

void clearEvicts()

Clears the value of 'evicts'.

Field Description

The number of elements that have been evicted from the pool because the pool doesn't have capacity.

See Also:

setEvicts(long)

hasEvicts

boolean hasEvicts()

Checks for the presence of 'evicts'.

Field Description

The number of elements that have been evicted from the pool because the pool doesn't have capacity.

See Also:

getEvicts()

setDetachedWashes

void setDetachedWashes(long val)

Sets the value of 'detachedWashes'.

Field Description

The number of elements initialized by the detached pool washer thread.

Parameters:

val - The value to set.

getDetachedWashes

long getDetachedWashes()

Gets the value of 'detachedWashes'.

Field Description

The number of elements initialized by the detached pool washer thread.

Returns:

The number of elements initialized by the detached pool washer thread.

clearDetachedWashes

void clearDetachedWashes()

Clears the value of 'detachedWashes'.

Field Description

The number of elements initialized by the detached pool washer thread.

See Also:

setDetachedWashes(long)

hasDetachedWashes

boolean hasDetachedWashes()

Checks for the presence of 'detachedWashes'.

Field Description

The number of elements initialized by the detached pool washer thread.

See Also:

getDetachedWashes()

setSize

void setSize(int val)

Sets the value of 'size'.

Field Description

The number of elements currently available in the pool to satisfy gets.

Note that a value of 0 does not necessarily indicate that there is a pooling issue: a healthy pool in which elements are continuously being recycled will have a size of zero frequently while the elements have been checked out by the thread using them.

Parameters:

val - The value to set.

getSize

int getSize()

Gets the value of 'size'.

Field Description

The number of elements currently available in the pool to satisfy gets.

Note that a value of 0 does not necessarily indicate that there is a pooling issue: a healthy pool in which elements are continuously being recycled will have a size of zero frequently while the elements have been checked out by the thread using them.

Returns:

The number of elements currently available in the pool to satisfy gets.

clearSize

void clearSize()

Clears the value of 'size'.

Field Description

The number of elements currently available in the pool to satisfy gets.

Note that a value of 0 does not necessarily indicate that there is a pooling issue: a healthy pool in which elements are continuously being recycled will have a size of zero frequently while the elements have been checked out by the thread using them.

See Also:

setSize(int)

hasSize

boolean hasSize()

Checks for the presence of 'size'.

Field Description

The number of elements currently available in the pool to satisfy gets.

Note that a value of 0 does not necessarily indicate that there is a pooling issue: a healthy pool in which elements are continuously being recycled will have a size of zero frequently while the elements have been checked out by the thread using them.

See Also:

getSize()

setCapacity

void setCapacity(int val)

Sets the value of 'capacity'.

Field Description

The current number of slots in the pool to hold elements that are not in use.

Parameters:

val - The value to set.

getCapacity

int getCapacity()

Gets the value of 'capacity'.

Field Description

The current number of slots in the pool to hold elements that are not in use.

Returns:

The current number of slots in the pool to hold elements that are not in use.

clearCapacity

void clearCapacity()

Clears the value of 'capacity'.

Field Description

The current number of slots in the pool to hold elements that are not in use.

See Also:

setCapacity(int)

hasCapacity

boolean hasCapacity()

Checks for the presence of 'capacity'.

Field Description

The current number of slots in the pool to hold elements that are not in use.

See Also:

getCapacity()

setPreallocated

void setPreallocated(int val)

Sets the value of 'preallocated'.

Field Description

The number of elements initially preallocated in the pool.

Parameters:

val - The value to set.

getPreallocated

int getPreallocated()

Gets the value of 'preallocated'.

Field Description

The number of elements initially preallocated in the pool.

Returns:

The number of elements initially preallocated in the pool.

clearPreallocated

void clearPreallocated()

Clears the value of 'preallocated'.

Field Description

The number of elements initially preallocated in the pool.

See Also:

setPreallocated(int)

hasPreallocated

boolean hasPreallocated()

Checks for the presence of 'preallocated'.

Field Description

The number of elements initially preallocated in the pool.

See Also:

getPreallocated()

setKey

void setKey(String val)

Sets the value of 'key'.

Field Description

The name of the pool.

Parameters:

val - The value to set.

getKey

String getKey()

Gets the value of 'key'.

Field Description

The name of the pool.

Returns:

The name of the pool.

lendKey

void lendKey(XString val)

Lends the value of 'key' to this object.

This method is equivalent to setKey except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.

Field Description

The name of the pool.

Usage Notes

Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.

Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.

Parameters:

val - The value to set.

Throws:

IllegalArgumentException - If the value is mutable.

setKeyFrom

void setKeyFrom(long val)

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

Field Description

The name of the pool.

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

getKeyTo

<T extends XString> T getKeyTo(XString.Factory<T> factory)

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

Field Description

The name of the pool.

If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);

This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;

Parameters:

factory - The factory from which to get the XString to copy into and return

Returns:

a new XString from the provided factory if this field is set or null.

Throws:

NullPointerException - if the provided factory is null

setKeyFrom

void setKeyFrom(XString val)

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

Field Description

The name of the pool.

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

getKeyTo

void getKeyTo(XString val)

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

Field Description

The name of the pool.

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

See Also:

getKey()

getKeyUnsafe

XString getKeyUnsafe()

Gets the raw value of 'key'.

Field Description

The name of the pool.

NOTE:
This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.

However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.

Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.

Returns:

the field's raw value

See Also:

getKey()

clearKey

void clearKey()

Clears the value of 'key'.

Field Description

The name of the pool.

See Also:

setKey(String)

hasKey

boolean hasKey()

Checks for the presence of 'key'.

Field Description

The name of the pool.

See Also:

getKey()