com.neeve.server.mon

Interface ISrvMonAdminClientStats

All Superinterfaces:

IRogValidatable

All Known Implementing Classes:

SrvMonAdminClientStats

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

Holds stats for a connected admin client.

A Talon XVM maintains statistics for connected "admin" clients. The XVM prioritizes its integrity to the reliability of information that it sends to admin clients. In other words, if the XVM detects that its integrity could be compromised due to congestion in its communication with the admin client, it will start to drop messages that it sends to the client. These statistics primarily serve the purpose of understanding the health of the connection to the admin client.

ADM Details

ADM Type	Embedded Entity
Factory	SrvMonFactory

ADM Field Summary

Field	Type	Id	Description
flushesExecuted	Long	13	The number of outbound queue flushes executed.
flushesScheduled	Long	12	The number of outbound queue flushes scheduled.
heartbeatsDropped	Long	4	The number of heartbeats dropped because of congestion.
heartbeatsSent	Long	3	The number of heartbeats sent to the client.
lifecyclesSent	Long	2	The number of lifecycle events sent to the client.
name	String	1	The name of the admin client.
outboundQueueCapacity	Integer	7	The capacity, in bytes, of the client's outbound queue.
outboundQueueCount	Integer	9	The number of elements in the client's outbound queue.
outboundQueueFlushCount	Long	11	The number of elements flushed from the client's outbound queue.
outboundQueueFlushSize	Long	10	The number of bytes flushed from the client's outbound queue.
outboundQueueSize	Integer	8	The size, in bytes, of the client's outbound queue. Note that the size of a client's outbound queue can exceed the capacity. This can be caused when lifecycle events need to be sent to the client but the client connection. is congested. Since lifecycle events are not ever dropped, it can cause the queue capacity to be exceeded
tracesDropped	Long	6	The number of trace records dropped because of congestion.
tracesSent	Long	5	The number of trace records sent to the client.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearFlushesExecuted() Clears the value of 'flushesExecuted'.
void	clearFlushesScheduled() Clears the value of 'flushesScheduled'.
void	clearHeartbeatsDropped() Clears the value of 'heartbeatsDropped'.
void	clearHeartbeatsSent() Clears the value of 'heartbeatsSent'.
void	clearLifecyclesSent() Clears the value of 'lifecyclesSent'.
void	clearName() Clears the value of 'name'.
void	clearOutboundQueueCapacity() Clears the value of 'outboundQueueCapacity'.
void	clearOutboundQueueCount() Clears the value of 'outboundQueueCount'.
void	clearOutboundQueueFlushCount() Clears the value of 'outboundQueueFlushCount'.
void	clearOutboundQueueFlushSize() Clears the value of 'outboundQueueFlushSize'.
void	clearOutboundQueueSize() Clears the value of 'outboundQueueSize'.
void	clearTracesDropped() Clears the value of 'tracesDropped'.
void	clearTracesSent() Clears the value of 'tracesSent'.
long	getFlushesExecuted() Gets the value of 'flushesExecuted'.
long	getFlushesScheduled() Gets the value of 'flushesScheduled'.
long	getHeartbeatsDropped() Gets the value of 'heartbeatsDropped'.
long	getHeartbeatsSent() Gets the value of 'heartbeatsSent'.
long	getLifecyclesSent() Gets the value of 'lifecyclesSent'.
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'.
int	getOutboundQueueCapacity() Gets the value of 'outboundQueueCapacity'.
int	getOutboundQueueCount() Gets the value of 'outboundQueueCount'.
long	getOutboundQueueFlushCount() Gets the value of 'outboundQueueFlushCount'.
long	getOutboundQueueFlushSize() Gets the value of 'outboundQueueFlushSize'.
int	getOutboundQueueSize() Gets the value of 'outboundQueueSize'.
long	getTracesDropped() Gets the value of 'tracesDropped'.
long	getTracesSent() Gets the value of 'tracesSent'.
boolean	hasFlushesExecuted() Checks for the presence of 'flushesExecuted'.
boolean	hasFlushesScheduled() Checks for the presence of 'flushesScheduled'.
boolean	hasHeartbeatsDropped() Checks for the presence of 'heartbeatsDropped'.
boolean	hasHeartbeatsSent() Checks for the presence of 'heartbeatsSent'.
boolean	hasLifecyclesSent() Checks for the presence of 'lifecyclesSent'.
boolean	hasName() Checks for the presence of 'name'.
boolean	hasOutboundQueueCapacity() Checks for the presence of 'outboundQueueCapacity'.
boolean	hasOutboundQueueCount() Checks for the presence of 'outboundQueueCount'.
boolean	hasOutboundQueueFlushCount() Checks for the presence of 'outboundQueueFlushCount'.
boolean	hasOutboundQueueFlushSize() Checks for the presence of 'outboundQueueFlushSize'.
boolean	hasOutboundQueueSize() Checks for the presence of 'outboundQueueSize'.
boolean	hasTracesDropped() Checks for the presence of 'tracesDropped'.
boolean	hasTracesSent() Checks for the presence of 'tracesSent'.
void	lendName(XString val) Lends the value of 'name' to this object.
void	setFlushesExecuted(long val) Sets the value of 'flushesExecuted'.
void	setFlushesScheduled(long val) Sets the value of 'flushesScheduled'.
void	setHeartbeatsDropped(long val) Sets the value of 'heartbeatsDropped'.
void	setHeartbeatsSent(long val) Sets the value of 'heartbeatsSent'.
void	setLifecyclesSent(long val) Sets the value of 'lifecyclesSent'.
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	setOutboundQueueCapacity(int val) Sets the value of 'outboundQueueCapacity'.
void	setOutboundQueueCount(int val) Sets the value of 'outboundQueueCount'.
void	setOutboundQueueFlushCount(long val) Sets the value of 'outboundQueueFlushCount'.
void	setOutboundQueueFlushSize(long val) Sets the value of 'outboundQueueFlushSize'.
void	setOutboundQueueSize(int val) Sets the value of 'outboundQueueSize'.
void	setTracesDropped(long val) Sets the value of 'tracesDropped'.
void	setTracesSent(long val) Sets the value of 'tracesSent'.

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

setLifecyclesSent

void setLifecyclesSent(long val)

Sets the value of 'lifecyclesSent'.

Field Description

The number of lifecycle events sent to the client.

Parameters:

val - The value to set.

getLifecyclesSent

long getLifecyclesSent()

Gets the value of 'lifecyclesSent'.

Field Description

The number of lifecycle events sent to the client.

Returns:

The number of lifecycle events sent to the client.

clearLifecyclesSent

void clearLifecyclesSent()

Clears the value of 'lifecyclesSent'.

Field Description

The number of lifecycle events sent to the client.

See Also:

setLifecyclesSent(long)

hasLifecyclesSent

boolean hasLifecyclesSent()

Checks for the presence of 'lifecyclesSent'.

Field Description

The number of lifecycle events sent to the client.

See Also:

getLifecyclesSent()

setHeartbeatsSent

void setHeartbeatsSent(long val)

Sets the value of 'heartbeatsSent'.

Field Description

The number of heartbeats sent to the client.

Parameters:

val - The value to set.

getHeartbeatsSent

long getHeartbeatsSent()

Gets the value of 'heartbeatsSent'.

Field Description

The number of heartbeats sent to the client.

Returns:

The number of heartbeats sent to the client.

clearHeartbeatsSent

void clearHeartbeatsSent()

Clears the value of 'heartbeatsSent'.

Field Description

The number of heartbeats sent to the client.

See Also:

setHeartbeatsSent(long)

hasHeartbeatsSent

boolean hasHeartbeatsSent()

Checks for the presence of 'heartbeatsSent'.

Field Description

The number of heartbeats sent to the client.

See Also:

getHeartbeatsSent()

setHeartbeatsDropped

void setHeartbeatsDropped(long val)

Sets the value of 'heartbeatsDropped'.

Field Description

The number of heartbeats dropped because of congestion.

Parameters:

val - The value to set.

getHeartbeatsDropped

long getHeartbeatsDropped()

Gets the value of 'heartbeatsDropped'.

Field Description

The number of heartbeats dropped because of congestion.

Returns:

The number of heartbeats dropped because of congestion.

clearHeartbeatsDropped

void clearHeartbeatsDropped()

Clears the value of 'heartbeatsDropped'.

Field Description

The number of heartbeats dropped because of congestion.

See Also:

setHeartbeatsDropped(long)

hasHeartbeatsDropped

boolean hasHeartbeatsDropped()

Checks for the presence of 'heartbeatsDropped'.

Field Description

The number of heartbeats dropped because of congestion.

See Also:

getHeartbeatsDropped()

setTracesSent

void setTracesSent(long val)

Sets the value of 'tracesSent'.

Field Description

The number of trace records sent to the client.

Parameters:

val - The value to set.

getTracesSent

long getTracesSent()

Gets the value of 'tracesSent'.

Field Description

The number of trace records sent to the client.

Returns:

The number of trace records sent to the client.

clearTracesSent

void clearTracesSent()

Clears the value of 'tracesSent'.

Field Description

The number of trace records sent to the client.

See Also:

setTracesSent(long)

hasTracesSent

boolean hasTracesSent()

Checks for the presence of 'tracesSent'.

Field Description

The number of trace records sent to the client.

See Also:

getTracesSent()

setTracesDropped

void setTracesDropped(long val)

Sets the value of 'tracesDropped'.

Field Description

The number of trace records dropped because of congestion.

Parameters:

val - The value to set.

getTracesDropped

long getTracesDropped()

Gets the value of 'tracesDropped'.

Field Description

The number of trace records dropped because of congestion.

Returns:

The number of trace records dropped because of congestion.

clearTracesDropped

void clearTracesDropped()

Clears the value of 'tracesDropped'.

Field Description

The number of trace records dropped because of congestion.

See Also:

setTracesDropped(long)

hasTracesDropped

boolean hasTracesDropped()

Checks for the presence of 'tracesDropped'.

Field Description

The number of trace records dropped because of congestion.

See Also:

getTracesDropped()

setOutboundQueueCapacity

void setOutboundQueueCapacity(int val)

Sets the value of 'outboundQueueCapacity'.

Field Description

The capacity, in bytes, of the client's outbound queue.

Parameters:

val - The value to set.

getOutboundQueueCapacity

int getOutboundQueueCapacity()

Gets the value of 'outboundQueueCapacity'.

Field Description

The capacity, in bytes, of the client's outbound queue.

Returns:

The capacity, in bytes, of the client's outbound queue.

clearOutboundQueueCapacity

void clearOutboundQueueCapacity()

Clears the value of 'outboundQueueCapacity'.

Field Description

The capacity, in bytes, of the client's outbound queue.

See Also:

setOutboundQueueCapacity(int)

hasOutboundQueueCapacity

boolean hasOutboundQueueCapacity()

Checks for the presence of 'outboundQueueCapacity'.

Field Description

The capacity, in bytes, of the client's outbound queue.

See Also:

getOutboundQueueCapacity()

setOutboundQueueSize

void setOutboundQueueSize(int val)

Sets the value of 'outboundQueueSize'.

Field Description

The size, in bytes, of the client's outbound queue.

Note that the size of a client's outbound queue can exceed the capacity. This can be caused when lifecycle events need to be sent to the client but the client connection. is congested. Since lifecycle events are not ever dropped, it can cause the queue capacity to be exceeded

Parameters:

val - The value to set.

getOutboundQueueSize

int getOutboundQueueSize()

Gets the value of 'outboundQueueSize'.

Field Description

The size, in bytes, of the client's outbound queue.

Note that the size of a client's outbound queue can exceed the capacity. This can be caused when lifecycle events need to be sent to the client but the client connection. is congested. Since lifecycle events are not ever dropped, it can cause the queue capacity to be exceeded

Returns:

The size, in bytes, of the client's outbound queue.

clearOutboundQueueSize

void clearOutboundQueueSize()

Clears the value of 'outboundQueueSize'.

Field Description

The size, in bytes, of the client's outbound queue.

Note that the size of a client's outbound queue can exceed the capacity. This can be caused when lifecycle events need to be sent to the client but the client connection. is congested. Since lifecycle events are not ever dropped, it can cause the queue capacity to be exceeded

See Also:

setOutboundQueueSize(int)

hasOutboundQueueSize

boolean hasOutboundQueueSize()

Checks for the presence of 'outboundQueueSize'.

Field Description

The size, in bytes, of the client's outbound queue.

Note that the size of a client's outbound queue can exceed the capacity. This can be caused when lifecycle events need to be sent to the client but the client connection. is congested. Since lifecycle events are not ever dropped, it can cause the queue capacity to be exceeded

See Also:

getOutboundQueueSize()

setOutboundQueueCount

void setOutboundQueueCount(int val)

Sets the value of 'outboundQueueCount'.

Field Description

The number of elements in the client's outbound queue.

Parameters:

val - The value to set.

getOutboundQueueCount

int getOutboundQueueCount()

Gets the value of 'outboundQueueCount'.

Field Description

The number of elements in the client's outbound queue.

Returns:

The number of elements in the client's outbound queue

clearOutboundQueueCount

void clearOutboundQueueCount()

Clears the value of 'outboundQueueCount'.

Field Description

The number of elements in the client's outbound queue.

See Also:

setOutboundQueueCount(int)

hasOutboundQueueCount

boolean hasOutboundQueueCount()

Checks for the presence of 'outboundQueueCount'.

Field Description

The number of elements in the client's outbound queue.

See Also:

getOutboundQueueCount()

setOutboundQueueFlushSize

void setOutboundQueueFlushSize(long val)

Sets the value of 'outboundQueueFlushSize'.

Field Description

The number of bytes flushed from the client's outbound queue.

Parameters:

val - The value to set.

getOutboundQueueFlushSize

long getOutboundQueueFlushSize()

Gets the value of 'outboundQueueFlushSize'.

Field Description

The number of bytes flushed from the client's outbound queue.

Returns:

The number of bytes flushed from the client's outbound queue.

clearOutboundQueueFlushSize

void clearOutboundQueueFlushSize()

Clears the value of 'outboundQueueFlushSize'.

Field Description

The number of bytes flushed from the client's outbound queue.

See Also:

setOutboundQueueFlushSize(long)

hasOutboundQueueFlushSize

boolean hasOutboundQueueFlushSize()

Checks for the presence of 'outboundQueueFlushSize'.

Field Description

The number of bytes flushed from the client's outbound queue.

See Also:

getOutboundQueueFlushSize()

setOutboundQueueFlushCount

void setOutboundQueueFlushCount(long val)

Sets the value of 'outboundQueueFlushCount'.

Field Description

The number of elements flushed from the client's outbound queue.

Parameters:

val - The value to set.

getOutboundQueueFlushCount

long getOutboundQueueFlushCount()

Gets the value of 'outboundQueueFlushCount'.

Field Description

The number of elements flushed from the client's outbound queue.

Returns:

The number of elements flushed from the client's outbound queue

clearOutboundQueueFlushCount

void clearOutboundQueueFlushCount()

Clears the value of 'outboundQueueFlushCount'.

Field Description

The number of elements flushed from the client's outbound queue.

See Also:

setOutboundQueueFlushCount(long)

hasOutboundQueueFlushCount

boolean hasOutboundQueueFlushCount()

Checks for the presence of 'outboundQueueFlushCount'.

Field Description

The number of elements flushed from the client's outbound queue.

See Also:

getOutboundQueueFlushCount()

setFlushesScheduled

void setFlushesScheduled(long val)

Sets the value of 'flushesScheduled'.

Field Description

The number of outbound queue flushes scheduled.

Parameters:

val - The value to set.

getFlushesScheduled

long getFlushesScheduled()

Gets the value of 'flushesScheduled'.

Field Description

The number of outbound queue flushes scheduled.

Returns:

The number of outbound queue flushes scheduled.

clearFlushesScheduled

void clearFlushesScheduled()

Clears the value of 'flushesScheduled'.

Field Description

The number of outbound queue flushes scheduled.

See Also:

setFlushesScheduled(long)

hasFlushesScheduled

boolean hasFlushesScheduled()

Checks for the presence of 'flushesScheduled'.

Field Description

The number of outbound queue flushes scheduled.

See Also:

getFlushesScheduled()

setFlushesExecuted

void setFlushesExecuted(long val)

Sets the value of 'flushesExecuted'.

Field Description

The number of outbound queue flushes executed.

Parameters:

val - The value to set.

getFlushesExecuted

long getFlushesExecuted()

Gets the value of 'flushesExecuted'.

Field Description

The number of outbound queue flushes executed.

Returns:

The number of outbound queue flushes executed

clearFlushesExecuted

void clearFlushesExecuted()

Clears the value of 'flushesExecuted'.

Field Description

The number of outbound queue flushes executed.

See Also:

setFlushesExecuted(long)

hasFlushesExecuted

boolean hasFlushesExecuted()

Checks for the presence of 'flushesExecuted'.

Field Description

The number of outbound queue flushes executed.

See Also:

getFlushesExecuted()

setName

void setName(String val)

Sets the value of 'name'.

Field Description

The name of the admin client.

Parameters:

val - The value to set.

getName

String getName()

Gets the value of 'name'.

Field Description

The name of the admin client.

Returns:

The name of the admin client.

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 name of the admin client.

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 name of the admin client.

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 name of the admin client.

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 name of the admin client.

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 name of the admin client.

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 name of the admin client.

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 name of the admin client.

See Also:

setName(String)

hasName

boolean hasName()

Checks for the presence of 'name'.

Field Description

The name of the admin client.

See Also:

getName()