com.neeve.server.mon

Interface ISrvMonSysIndividualThreadStats

All Superinterfaces:

IRogValidatable

All Known Implementing Classes:

SrvMonSysIndividualThreadStats

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

Holds statistics for an individual thread.

ADM Details

ADM Type	Embedded Entity
Factory	SrvMonFactory

ADM Field Summary

Field	Type	Id	Description
affinity	String	7	Affinitization details for the thread (if affinitized).
collectTime	Long	6	The time in nanoseconds just after cpu times were collected. The collect time can be used to determine the elapsed time between 2 samples for the thread to determine the amount of time that the thread was active.
cpuTime	Long	4	The cpu time used by the thread (in nanoseconds).
id	Long	1	The thread's id.
name	String	2	The thread's name. For performance reasons the thread name may be cached by the XVM so it is not always guaranteed that the returned value will reflect the most recent thread name if its name has been changed.
state	String	3	The thread's state at the time of the heartbeat.
usrTime	Long	5	The cpu time user time used by the thread (in nanoseconds).
waitCount	Long	9	The times the thread was recorded as waiting. Certain platform threads track time spent waiting for events to occur such as I/O spin loops or disruptor wait calls that don't reflect actual work being done. This counter records the number of times the thread entered a waiting state.
waitTime	Long	8	The time in nanoseconds spent waiting for events. Certain platform threads track time spent waiting for events to occur such as I/O spin loops or disruptor wait calls that don't reflect actual work being done. Especially for threads that wait using busy spinning, the counter can be used to determine the amount of cpu time that was not used for active processing. Note that this stat only reflects the time spent upon exiting a wait condition. If the thread is still in a waiting state at the time this statistic is collected that time will not be reflected.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAffinity() Clears the value of 'affinity'.
void	clearCollectTime() Clears the value of 'collectTime'.
void	clearCpuTime() Clears the value of 'cpuTime'.
void	clearId() Clears the value of 'id'.
void	clearName() Clears the value of 'name'.
void	clearState() Clears the value of 'state'.
void	clearUsrTime() Clears the value of 'usrTime'.
void	clearWaitCount() Clears the value of 'waitCount'.
void	clearWaitTime() Clears the value of 'waitTime'.
String	getAffinity() Gets the value of 'affinity'.
<T extends XString> T	getAffinityTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getAffinityTo(XString val) Copies the value of 'affinity' into the provided XString.
XString	getAffinityUnsafe() Gets the raw value of 'affinity'.
long	getCollectTime() Gets the value of 'collectTime'.
long	getCpuTime() Gets the value of 'cpuTime'.
long	getId() Gets the value of 'id'.
String	getName() Gets the value of 'name'.
<T extends XString> T	getNameTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getNameTo(XString val) Copies the value of 'name' into the provided XString.
XString	getNameUnsafe() Gets the raw value of 'name'.
String	getState() Gets the value of 'state'.
<T extends XString> T	getStateTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getStateTo(XString val) Copies the value of 'state' into the provided XString.
XString	getStateUnsafe() Gets the raw value of 'state'.
long	getUsrTime() Gets the value of 'usrTime'.
long	getWaitCount() Gets the value of 'waitCount'.
long	getWaitTime() Gets the value of 'waitTime'.
boolean	hasAffinity() Checks for the presence of 'affinity'.
boolean	hasCollectTime() Checks for the presence of 'collectTime'.
boolean	hasCpuTime() Checks for the presence of 'cpuTime'.
boolean	hasId() Checks for the presence of 'id'.
boolean	hasName() Checks for the presence of 'name'.
boolean	hasState() Checks for the presence of 'state'.
boolean	hasUsrTime() Checks for the presence of 'usrTime'.
boolean	hasWaitCount() Checks for the presence of 'waitCount'.
boolean	hasWaitTime() Checks for the presence of 'waitTime'.
void	lendAffinity(XString val) Lends the value of 'affinity' to this object.
void	lendName(XString val) Lends the value of 'name' to this object.
void	lendState(XString val) Lends the value of 'state' to this object.
void	setAffinity(String val) Sets the value of 'affinity'.
void	setAffinityFrom(long val) Sets the value of this String field to the given numeric value.
void	setAffinityFrom(XString val) Copies the provided XString value into this object's 'affinity'.
void	setCollectTime(long val) Sets the value of 'collectTime'.
void	setCpuTime(long val) Sets the value of 'cpuTime'.
void	setId(long val) Sets the value of 'id'.
void	setName(String val) Sets the value of 'name'.
void	setNameFrom(long val) Sets the value of this String field to the given numeric value.
void	setNameFrom(XString val) Copies the provided XString value into this object's 'name'.
void	setState(String val) Sets the value of 'state'.
void	setStateFrom(long val) Sets the value of this String field to the given numeric value.
void	setStateFrom(XString val) Copies the provided XString value into this object's 'state'.
void	setUsrTime(long val) Sets the value of 'usrTime'.
void	setWaitCount(long val) Sets the value of 'waitCount'.
void	setWaitTime(long val) Sets the value of 'waitTime'.

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

setId

void setId(long val)

Sets the value of 'id'.

Field Description

The thread's id.

Parameters:

val - The value to set.

getId

long getId()

Gets the value of 'id'.

Field Description

The thread's id.

Returns:

The thread's id.

clearId

void clearId()

Clears the value of 'id'.

Field Description

The thread's id.

See Also:

setId(long)

hasId

boolean hasId()

Checks for the presence of 'id'.

Field Description

The thread's id.

See Also:

getId()

setCpuTime

void setCpuTime(long val)

Sets the value of 'cpuTime'.

Field Description

The cpu time used by the thread (in nanoseconds).

Parameters:

val - The value to set.

getCpuTime

long getCpuTime()

Gets the value of 'cpuTime'.

Field Description

The cpu time used by the thread (in nanoseconds).

Returns:

The cpu time used by the thread (in nanoseconds).

clearCpuTime

void clearCpuTime()

Clears the value of 'cpuTime'.

Field Description

The cpu time used by the thread (in nanoseconds).

See Also:

setCpuTime(long)

hasCpuTime

boolean hasCpuTime()

Checks for the presence of 'cpuTime'.

Field Description

The cpu time used by the thread (in nanoseconds).

See Also:

getCpuTime()

setUsrTime

void setUsrTime(long val)

Sets the value of 'usrTime'.

Field Description

The cpu time user time used by the thread (in nanoseconds).

Parameters:

val - The value to set.

getUsrTime

long getUsrTime()

Gets the value of 'usrTime'.

Field Description

The cpu time user time used by the thread (in nanoseconds).

Returns:

The cpu time user time used by the thread (in nanoseconds).

clearUsrTime

void clearUsrTime()

Clears the value of 'usrTime'.

Field Description

The cpu time user time used by the thread (in nanoseconds).

See Also:

setUsrTime(long)

hasUsrTime

boolean hasUsrTime()

Checks for the presence of 'usrTime'.

Field Description

The cpu time user time used by the thread (in nanoseconds).

See Also:

getUsrTime()

setCollectTime

void setCollectTime(long val)

Sets the value of 'collectTime'.

Field Description

The time in nanoseconds just after cpu times were collected.

The collect time can be used to determine the elapsed time between 2 samples for the thread to determine the amount of time that the thread was active.

Parameters:

val - The value to set.

getCollectTime

long getCollectTime()

Gets the value of 'collectTime'.

Field Description

The time in nanoseconds just after cpu times were collected.

The collect time can be used to determine the elapsed time between 2 samples for the thread to determine the amount of time that the thread was active.

Returns:

The time in nanoseconds just after cpu times were collected.

clearCollectTime

void clearCollectTime()

Clears the value of 'collectTime'.

Field Description

The time in nanoseconds just after cpu times were collected.

The collect time can be used to determine the elapsed time between 2 samples for the thread to determine the amount of time that the thread was active.

See Also:

setCollectTime(long)

hasCollectTime

boolean hasCollectTime()

Checks for the presence of 'collectTime'.

Field Description

The time in nanoseconds just after cpu times were collected.

The collect time can be used to determine the elapsed time between 2 samples for the thread to determine the amount of time that the thread was active.

See Also:

getCollectTime()

setWaitTime

void setWaitTime(long val)

Sets the value of 'waitTime'.

Field Description

The time in nanoseconds spent waiting for events.

Certain platform threads track time spent waiting for events to occur such as I/O spin loops or disruptor wait calls that don't reflect actual work being done. Especially for threads that wait using busy spinning, the counter can be used to determine the amount of cpu time that was not used for active processing.

Note that this stat only reflects the time spent upon exiting a wait condition. If the thread is still in a waiting state at the time this statistic is collected that time will not be reflected.

Parameters:

val - The value to set.

getWaitTime

long getWaitTime()

Gets the value of 'waitTime'.

Field Description

The time in nanoseconds spent waiting for events.

Certain platform threads track time spent waiting for events to occur such as I/O spin loops or disruptor wait calls that don't reflect actual work being done. Especially for threads that wait using busy spinning, the counter can be used to determine the amount of cpu time that was not used for active processing.

Note that this stat only reflects the time spent upon exiting a wait condition. If the thread is still in a waiting state at the time this statistic is collected that time will not be reflected.

Returns:

The time in nanoseconds spent waiting for events

clearWaitTime

void clearWaitTime()

Clears the value of 'waitTime'.

Field Description

The time in nanoseconds spent waiting for events.

Certain platform threads track time spent waiting for events to occur such as I/O spin loops or disruptor wait calls that don't reflect actual work being done. Especially for threads that wait using busy spinning, the counter can be used to determine the amount of cpu time that was not used for active processing.

Note that this stat only reflects the time spent upon exiting a wait condition. If the thread is still in a waiting state at the time this statistic is collected that time will not be reflected.

See Also:

setWaitTime(long)

hasWaitTime

boolean hasWaitTime()

Checks for the presence of 'waitTime'.

Field Description

The time in nanoseconds spent waiting for events.

Certain platform threads track time spent waiting for events to occur such as I/O spin loops or disruptor wait calls that don't reflect actual work being done. Especially for threads that wait using busy spinning, the counter can be used to determine the amount of cpu time that was not used for active processing.

Note that this stat only reflects the time spent upon exiting a wait condition. If the thread is still in a waiting state at the time this statistic is collected that time will not be reflected.

See Also:

getWaitTime()

setWaitCount

void setWaitCount(long val)

Sets the value of 'waitCount'.

Field Description

The times the thread was recorded as waiting.

Certain platform threads track time spent waiting for events to occur such as I/O spin loops or disruptor wait calls that don't reflect actual work being done. This counter records the number of times the thread entered a waiting state.

Parameters:

val - The value to set.

getWaitCount

long getWaitCount()

Gets the value of 'waitCount'.

Field Description

The times the thread was recorded as waiting.

Certain platform threads track time spent waiting for events to occur such as I/O spin loops or disruptor wait calls that don't reflect actual work being done. This counter records the number of times the thread entered a waiting state.

Returns:

The times the thread was recorded as waiting

clearWaitCount

void clearWaitCount()

Clears the value of 'waitCount'.

Field Description

The times the thread was recorded as waiting.

Certain platform threads track time spent waiting for events to occur such as I/O spin loops or disruptor wait calls that don't reflect actual work being done. This counter records the number of times the thread entered a waiting state.

See Also:

setWaitCount(long)

hasWaitCount

boolean hasWaitCount()

Checks for the presence of 'waitCount'.

Field Description

The times the thread was recorded as waiting.

Certain platform threads track time spent waiting for events to occur such as I/O spin loops or disruptor wait calls that don't reflect actual work being done. This counter records the number of times the thread entered a waiting state.

See Also:

getWaitCount()

setName

void setName(String val)

Sets the value of 'name'.

Field Description

The thread's name.

For performance reasons the thread name may be cached by the XVM so it is not always guaranteed that the returned value will reflect the most recent thread name if its name has been changed.

Parameters:

val - The value to set.

getName

String getName()

Gets the value of 'name'.

Field Description

The thread's name.

For performance reasons the thread name may be cached by the XVM so it is not always guaranteed that the returned value will reflect the most recent thread name if its name has been changed.

Returns:

The thread's name.

lendName

void lendName(XString val)

Lends the value of 'name' to this object.

This method is equivalent to setName 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 thread's name.

For performance reasons the thread name may be cached by the XVM so it is not always guaranteed that the returned value will reflect the most recent thread name if its name has been changed.

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.

setNameFrom

void setNameFrom(long val)

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

Field Description

The thread's name.

For performance reasons the thread name may be cached by the XVM so it is not always guaranteed that the returned value will reflect the most recent thread name if its name has been changed.

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

getNameTo

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

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

Field Description

The thread's name.

For performance reasons the thread name may be cached by the XVM so it is not always guaranteed that the returned value will reflect the most recent thread name if its name has been changed.

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

setNameFrom

void setNameFrom(XString val)

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

Field Description

The thread's name.

For performance reasons the thread name may be cached by the XVM so it is not always guaranteed that the returned value will reflect the most recent thread name if its name has been changed.

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

getNameTo

void getNameTo(XString val)

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

Field Description

The thread's name.

For performance reasons the thread name may be cached by the XVM so it is not always guaranteed that the returned value will reflect the most recent thread name if its name has been changed.

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

See Also:

getName()

getNameUnsafe

XString getNameUnsafe()

Gets the raw value of 'name'.

Field Description

The thread's name.

For performance reasons the thread name may be cached by the XVM so it is not always guaranteed that the returned value will reflect the most recent thread name if its name has been changed.

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:

getName()

clearName

void clearName()

Clears the value of 'name'.

Field Description

The thread's name.

For performance reasons the thread name may be cached by the XVM so it is not always guaranteed that the returned value will reflect the most recent thread name if its name has been changed.

See Also:

setName(String)

hasName

boolean hasName()

Checks for the presence of 'name'.

Field Description

The thread's name.

For performance reasons the thread name may be cached by the XVM so it is not always guaranteed that the returned value will reflect the most recent thread name if its name has been changed.

See Also:

getName()

setState

void setState(String val)

Sets the value of 'state'.

Field Description

The thread's state at the time of the heartbeat.

Parameters:

val - The value to set.

getState

String getState()

Gets the value of 'state'.

Field Description

The thread's state at the time of the heartbeat.

Returns:

The thread's state at the time of the heartbeat.

lendState

void lendState(XString val)

Lends the value of 'state' to this object.

This method is equivalent to setState 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 thread's state at the time of the heartbeat.

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.

setStateFrom

void setStateFrom(long val)

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

Field Description

The thread's state at the time of the heartbeat.

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

getStateTo

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

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

Field Description

The thread's state at the time of the heartbeat.

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

setStateFrom

void setStateFrom(XString val)

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

Field Description

The thread's state at the time of the heartbeat.

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

getStateTo

void getStateTo(XString val)

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

Field Description

The thread's state at the time of the heartbeat.

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

See Also:

getState()

getStateUnsafe

XString getStateUnsafe()

Gets the raw value of 'state'.

Field Description

The thread's state at the time of the heartbeat.

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:

getState()

clearState

void clearState()

Clears the value of 'state'.

Field Description

The thread's state at the time of the heartbeat.

See Also:

setState(String)

hasState

boolean hasState()

Checks for the presence of 'state'.

Field Description

The thread's state at the time of the heartbeat.

See Also:

getState()

setAffinity

void setAffinity(String val)

Sets the value of 'affinity'.

Field Description

Affinitization details for the thread (if affinitized).

Parameters:

val - The value to set.

getAffinity

String getAffinity()

Gets the value of 'affinity'.

Field Description

Affinitization details for the thread (if affinitized).

Returns:

Affinitization details for the thread (if affinitized).

lendAffinity

void lendAffinity(XString val)

Lends the value of 'affinity' to this object.

This method is equivalent to setAffinity 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

Affinitization details for the thread (if affinitized).

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.

setAffinityFrom

void setAffinityFrom(long val)

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

Field Description

Affinitization details for the thread (if affinitized).

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

getAffinityTo

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

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

Field Description

Affinitization details for the thread (if affinitized).

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

setAffinityFrom

void setAffinityFrom(XString val)

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

Field Description

Affinitization details for the thread (if affinitized).

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

getAffinityTo

void getAffinityTo(XString val)

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

Field Description

Affinitization details for the thread (if affinitized).

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

See Also:

getAffinity()

getAffinityUnsafe

XString getAffinityUnsafe()

Gets the raw value of 'affinity'.

Field Description

Affinitization details for the thread (if affinitized).

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:

getAffinity()

clearAffinity

void clearAffinity()

Clears the value of 'affinity'.

Field Description

Affinitization details for the thread (if affinitized).

See Also:

setAffinity(String)

hasAffinity

boolean hasAffinity()

Checks for the presence of 'affinity'.

Field Description

Affinitization details for the thread (if affinitized).

See Also:

getAffinity()