com.neeve.server.mon

Interface ISrvMonSysThreadStats

All Superinterfaces:

IRogValidatable

All Known Implementing Classes:

SrvMonSysThreadStats

@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 ISrvMonSysThreadStats
extends IRogValidatable

Groups together stats related to the threads in the XVM's JVM.

ADM Details

ADM Type	Embedded Entity
Factory	SrvMonFactory

ADM Field Summary

Field	Type	Id	Description
daemonThreadCount	Integer	2	The number of active daemon threads in the system.
individualThreadStats	SrvMonSysIndividualThreadStats[]	4	Enumerates individual thread statistics (if enabled / available).
peakThreadCount	Integer	3	The peak number of threads observed in the system.
threadCount	Integer	1	The number of active threads in the system.

Method Summary

Methods

Modifier and Type	Method and Description
void	addIndividualThreadStats(SrvMonSysIndividualThreadStats val) Adds the provided value to the list of 'individualThreadStats' values.
void	clearDaemonThreadCount() Clears the value of 'daemonThreadCount'.
void	clearIndividualThreadStats() Clears the value of 'individualThreadStats'.
void	clearPeakThreadCount() Clears the value of 'peakThreadCount'.
void	clearThreadCount() Clears the value of 'threadCount'.
int	getDaemonThreadCount() Gets the value of 'daemonThreadCount'.
SrvMonSysIndividualThreadStats[]	getIndividualThreadStats() Gets the value of 'individualThreadStats'.
SrvMonSysIndividualThreadStats[]	getIndividualThreadStatsEmptyIfNull() Gets the value of 'individualThreadStats' or an empty array if the value is null or not set.
XIterator<SrvMonSysIndividualThreadStats>	getIndividualThreadStatsIterator() Gets the value of 'individualThreadStats' as iterator of values.
int	getPeakThreadCount() Gets the value of 'peakThreadCount'.
int	getThreadCount() Gets the value of 'threadCount'.
boolean	hasDaemonThreadCount() Checks for the presence of 'daemonThreadCount'.
boolean	hasPeakThreadCount() Checks for the presence of 'peakThreadCount'.
boolean	hasThreadCount() Checks for the presence of 'threadCount'.
void	lendIndividualThreadStats(SrvMonSysIndividualThreadStats val) Adds the provided value to the list of 'individualThreadStats' values and acquires a reference to it.
void	lendIndividualThreadStats(SrvMonSysIndividualThreadStats[] val) Lends the value of 'individualThreadStats'.
void	lendIndividualThreadStatsFrom(XIterator<SrvMonSysIndividualThreadStats> val) Sets the value of 'individualThreadStats' by lending the values from the provided iterator.
void	setDaemonThreadCount(int val) Sets the value of 'daemonThreadCount'.
void	setIndividualThreadStats(SrvMonSysIndividualThreadStats[] val) Sets the value of 'individualThreadStats'.
void	setIndividualThreadStatsFrom(XIterator<SrvMonSysIndividualThreadStats> val) Sets the value of 'individualThreadStats' using the values from the provided iterator.
void	setPeakThreadCount(int val) Sets the value of 'peakThreadCount'.
void	setThreadCount(int val) Sets the value of 'threadCount'.
SrvMonSysIndividualThreadStats[]	takeIndividualThreadStats() Takes the value of 'individualThreadStats'.

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

setThreadCount

void setThreadCount(int val)

Sets the value of 'threadCount'.

Field Description

The number of active threads in the system.

Parameters:

val - The value to set.

getThreadCount

int getThreadCount()

Gets the value of 'threadCount'.

Field Description

The number of active threads in the system.

Returns:

The number of active threads in the system.

clearThreadCount

void clearThreadCount()

Clears the value of 'threadCount'.

Field Description

The number of active threads in the system.

See Also:

setThreadCount(int)

hasThreadCount

boolean hasThreadCount()

Checks for the presence of 'threadCount'.

Field Description

The number of active threads in the system.

See Also:

getThreadCount()

setDaemonThreadCount

void setDaemonThreadCount(int val)

Sets the value of 'daemonThreadCount'.

Field Description

The number of active daemon threads in the system.

Parameters:

val - The value to set.

getDaemonThreadCount

int getDaemonThreadCount()

Gets the value of 'daemonThreadCount'.

Field Description

The number of active daemon threads in the system.

Returns:

The number of active daemon threads in the system.

clearDaemonThreadCount

void clearDaemonThreadCount()

Clears the value of 'daemonThreadCount'.

Field Description

The number of active daemon threads in the system.

See Also:

setDaemonThreadCount(int)

hasDaemonThreadCount

boolean hasDaemonThreadCount()

Checks for the presence of 'daemonThreadCount'.

Field Description

The number of active daemon threads in the system.

See Also:

getDaemonThreadCount()

setPeakThreadCount

void setPeakThreadCount(int val)

Sets the value of 'peakThreadCount'.

Field Description

The peak number of threads observed in the system.

Parameters:

val - The value to set.

getPeakThreadCount

int getPeakThreadCount()

Gets the value of 'peakThreadCount'.

Field Description

The peak number of threads observed in the system.

Returns:

The peak number of threads observed in the system.

clearPeakThreadCount

void clearPeakThreadCount()

Clears the value of 'peakThreadCount'.

Field Description

The peak number of threads observed in the system.

See Also:

setPeakThreadCount(int)

hasPeakThreadCount

boolean hasPeakThreadCount()

Checks for the presence of 'peakThreadCount'.

Field Description

The peak number of threads observed in the system.

See Also:

getPeakThreadCount()

setIndividualThreadStats

void setIndividualThreadStats(SrvMonSysIndividualThreadStats[] val)

Sets the value of 'individualThreadStats'.

Field Description

Enumerates individual thread statistics (if enabled / available).

Parameters:

val - The value to set.

setIndividualThreadStatsFrom

void setIndividualThreadStatsFrom(XIterator<SrvMonSysIndividualThreadStats> val)

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

This method will call XIterator.toFirst() before and after setting the values, meaning that all values from the iterator will be set and the iterator will be reset on return.

This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'individualThreadStats' accessor can copy the values without iteration.

Field Description

Enumerates individual thread statistics (if enabled / available).

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

Parameters:

val - the values to set.

lendIndividualThreadStatsFrom

void lendIndividualThreadStatsFrom(XIterator<SrvMonSysIndividualThreadStats> val)

Sets the value of 'individualThreadStats' by lending the values from the provided iterator.

This method will call XIterator.toFirst() before and after setting the values, meaning that all values from the iterator will be set and the iterator will be reset on return.

This method will acquire references to each non null value in the provided iterator making it suitable for cases where the values come from another message that may be disposed.

This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'individualThreadStats' accessor can copy the values without iteration.

Field Description

Enumerates individual thread statistics (if enabled / available).

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

Parameters:

val - the values to set.

addIndividualThreadStats

void addIndividualThreadStats(SrvMonSysIndividualThreadStats val)

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

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

Enumerates individual thread statistics (if enabled / available).

Parameters:

val - the value to add.

lendIndividualThreadStats

void lendIndividualThreadStats(SrvMonSysIndividualThreadStats val)

Adds the provided value to the list of 'individualThreadStats' values and acquires a reference to it.

Lending of an added value is useful in cases where a field is being added from a source message to provide dispose of the source value when the source message is disposed.

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

Enumerates individual thread statistics (if enabled / available).

Parameters:

val - the value to add.

getIndividualThreadStatsIterator

XIterator<SrvMonSysIndividualThreadStats> getIndividualThreadStatsIterator()

Gets the value of 'individualThreadStats' as iterator of values.

This method will always return a non null iterator value. The returned iterator is not threadsafe, and the caller may not hold on to it beyond the pooling lifespan of this object. Depending on the implementation, the same iterator instance may be returned by this object on each call to avoid garbage. Each time this method is called the iterator is reset by calling its toFirst() method. Callers should therefore be especially careful about calling this method while iterating on the iterator returned by this method.

The elements returned by this iterator are owned by and pooled along with this object. The caller must call acquire() on each returned object that it intends to keep beyond the either the next call to next(), toFirst() or the lifespace of this object as each object returned by this iterator is disposed on a subsequent call to next() or when this object is disposed.

This method is zero garbage for Xbuf generated classes, and this method is optimized such that passing the returned iterator to another object's setXXX(XIterator method can perform a direct copy of the underlying values without iteration.

Field Description

Enumerates individual thread statistics (if enabled / available).

Returns:

An iterator containing this field values.

lendIndividualThreadStats

void lendIndividualThreadStats(SrvMonSysIndividualThreadStats[] val)

Lends the value of 'individualThreadStats'.

Field Description

Enumerates individual thread statistics (if enabled / available).

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.

Parameters:

val - the value to 'lend' to lend.

getIndividualThreadStats

SrvMonSysIndividualThreadStats[] getIndividualThreadStats()

Gets the value of 'individualThreadStats'.

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

Field Description

Enumerates individual thread statistics (if enabled / available).

Returns:

Enumerates individual thread statistics (if enabled / available). If the field is not set this method will return null.

getIndividualThreadStatsEmptyIfNull

SrvMonSysIndividualThreadStats[] getIndividualThreadStatsEmptyIfNull()

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

Field Description

Enumerates individual thread statistics (if enabled / available).

Returns:

Enumerates individual thread statistics (if enabled / available). or an empty array if null if not set.

See Also:

getIndividualThreadStats()

takeIndividualThreadStats

SrvMonSysIndividualThreadStats[] takeIndividualThreadStats()

Takes the value of 'individualThreadStats'.

Field Description

Enumerates individual thread statistics (if enabled / available).

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

Returns:

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

clearIndividualThreadStats

void clearIndividualThreadStats()

Clears the value of 'individualThreadStats'.

Field Description

Enumerates individual thread statistics (if enabled / available).

See Also:

setIndividualThreadStats(SrvMonSysIndividualThreadStats[])