com.neeve.server.mon
Interface ISrvMonSysIndividualThreadStats

All Superinterfaces:
IRogValidatable
All Known Implementing Classes:
SrvMonSysIndividualThreadStats

@Generated(value="com.neeve.adm.AdmGenerator",
           date="Wed Mar 28 10:54:31 EDT 2018")
@AdmGenerated(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)")
public interface ISrvMonSysIndividualThreadStats
extends IRogValidatable

Holds statistics for an individual thread.


Method Summary
 void clearAffinity()
          Clears the value of 'affinity' Field Description Affinitization details for the thread (if affinitized).
 void clearCollectTime()
          Clears the value of 'collectTime' Field Description The time in nanoseconds just after cpu times were collected.
 void clearCpuTime()
          Clears the value of 'cpuTime' Field Description The cpu time used by the thread (in nanoseconds).
 void clearId()
          Clears the value of 'id' Field Description The thread's id.
 void clearName()
          Clears the value of 'name' Field Description The thread's name.
 void clearState()
          Clears the value of 'state' Field Description The thread's state at the time of the heartbeat.
 void clearUsrTime()
          Clears the value of 'usrTime' Field Description The cpu time user time used by the thread (in nanoseconds).
 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.
 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.
 String getAffinity()
          Gets the value of 'affinity' Field Description Affinitization details for the thread (if affinitized).
<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' Field Description The time in nanoseconds just after cpu times were collected.
 long getCpuTime()
          Gets the value of 'cpuTime' Field Description The cpu time used by the thread (in nanoseconds).
 long getId()
          Gets the value of 'id' Field Description The thread's id.
 String getName()
          Gets the value of 'name' Field Description The thread's 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' Field Description The thread's state at the time of the heartbeat.
<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' Field Description The cpu time user time used by the thread (in nanoseconds).
 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.
 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.
 boolean hasAffinity()
          Checks for the presence of 'affinity' Field Description Affinitization details for the thread (if affinitized).
 boolean hasCollectTime()
          Checks for the presence of 'collectTime' Field Description The time in nanoseconds just after cpu times were collected.
 boolean hasCpuTime()
          Checks for the presence of 'cpuTime' Field Description The cpu time used by the thread (in nanoseconds).
 boolean hasId()
          Checks for the presence of 'id' Field Description The thread's id.
 boolean hasName()
          Checks for the presence of 'name' Field Description The thread's name.
 boolean hasState()
          Checks for the presence of 'state' Field Description The thread's state at the time of the heartbeat.
 boolean hasUsrTime()
          Checks for the presence of 'usrTime' Field Description The cpu time user time used by the thread (in nanoseconds).
 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.
 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.
 void lendAffinity(XString val)
          Sets the value of 'affinity' Field Description Affinitization details for the thread (if affinitized).
 void lendName(XString val)
          Sets the value of 'name' Field Description The thread's name.
 void lendState(XString val)
          Sets the value of 'state' Field Description The thread's state at the time of the heartbeat.
 void setAffinity(String val)
          Sets the value of 'affinity' Field Description Affinitization details for the thread (if affinitized).
 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' Field Description The time in nanoseconds just after cpu times were collected.
 void setCpuTime(long val)
          Sets the value of 'cpuTime' Field Description The cpu time used by the thread (in nanoseconds).
 void setId(long val)
          Sets the value of 'id' Field Description The thread's id.
 void setName(String val)
          Sets the value of 'name' Field Description The thread's 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' Field Description The thread's state at the time of the heartbeat.
 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' Field Description The cpu time user time used by the thread (in nanoseconds).
 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.
 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.
 
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 server 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 server 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)
Sets the value of 'name'

Field Description

The thread's name.

For performance reasons the thread name may be cached by the server 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.

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 server 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 server 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 server 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 server 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 server 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 server 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 server 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)
Sets the value of 'state'

Field Description

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

Parameters:
val - The value to set.

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)
Sets the value of 'affinity'

Field Description

Affinitization details for the thread (if affinitized).

Parameters:
val - The value to set.

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()


Copyright © 2016 Neeve Research, LLC. All Rights Reserved.