ISrvMonHeartbeatMessage (Talon 3.7.265 API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.neeve.server.mon
Interface ISrvMonHeartbeatMessage

All Superinterfaces:: CopyableMessageView<ISrvMonHeartbeatMessage>, IRogCopyableNode<ISrvMonHeartbeatMessage>, IRogMessage, IRogMetadata, IRogNode, IRogValidatable, IStoreObject, MapMessageView, MessageView, UtlReferenceTracker.HasReferenceTracker

All Known Implementing Classes:: SrvMonHeartbeatMessage

@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 ISrvMonHeartbeatMessage
extends IRogNode, IRogMessage, IRogCopyableNode<ISrvMonHeartbeatMessage>
extends IRogNode, IRogMessage, IRogCopyableNode<ISrvMonHeartbeatMessage>

Talon Server Heartbeat

The server heartbeat is emitted by a Talon server at regular intervals and contains all of the stats reported by a server.

Nested Class Summary

Nested classes/interfaces inherited from interface com.neeve.rog.IRogNode
`IRogNode.PoolingListener`

Nested classes/interfaces inherited from interface com.neeve.ods.IStoreObject
`IStoreObject.EncodingType`

Method Summary

void addAdminClientStats(SrvMonAdminClientStats val)
Adds the provided value to the list of 'adminClientStats' values.

void addAppsInfo(SrvMonAppInfo val)
Adds the provided value to the list of 'appsInfo' values.

void addAppsStats(SrvMonAppStats val)
Adds the provided value to the list of 'appsStats' values.

void addPoolStats(SrvMonPoolStats val)
Adds the provided value to the list of 'poolStats' values.

void clearAdminClientStats()
Clears the value of 'adminClientStats' Field Description Collects stats related to the admin client connections

void clearAppsInfo()
Clears the value of 'appsInfo' Field Description Information about the apps configured for this server

void clearAppsStats()
Clears the value of 'appsStats' Field Description Platform and user stats for loaded applications

void clearCollectionEndTime()
Clears the value of 'collectionEndTime' Field Description The collection end time in nanoseconds (e.g.

void clearCollectionStartTime()
Clears the value of 'collectionStartTime' Field Description The collection start time in nanoseconds (e.g.

void clearCollectionStartWallTime()
Clears the value of 'collectionStartWallTime' Field Description The collection start time in milliseconds since the Epoch (e.g.

void clearLoadedTime()
Clears the value of 'loadedTime' Field Description The time at which the server loaded

void clearPoolStats()
Clears the value of 'poolStats' Field Description Collects process wide pooling stats

void clearServerHostName()
Clears the value of 'serverHostName' Field Description The server's hostname

void clearServerName()
Clears the value of 'serverName' Field Description The name of the server

void clearServerPid()
Clears the value of 'serverPid' Field Description The server process id

void clearSysStats()
Clears the value of 'sysStats' Field Description Collects System System level stats such process or memory usage.

void clearSystemName()
Clears the value of 'systemName' Field Description The name of the system to which the server belongs.

void clearSystemVersion()
Clears the value of 'systemVersion' Field Description The version of the system to which the server belongs.

SrvMonHeartbeatMessage copy()
Creates a copy of this SrvMonHeartbeatMessage.

void copyInto(SrvMonHeartbeatMessage target)
Copies the contents of this SrvMonHeartbeatMessage into the target.

SrvMonAdminClientStats[] getAdminClientStats()
Gets the value of 'adminClientStats' If the field is not set this method will return null.

SrvMonAdminClientStats[] getAdminClientStatsEmptyIfNull()
Gets the value of 'adminClientStats' or an empty array if the value is null or not set.

XIterator<SrvMonAdminClientStats> getAdminClientStatsIterator()
Gets the value of 'adminClientStats' as iterator of values.

SrvMonAppInfo[] getAppsInfo()
Gets the value of 'appsInfo' If the field is not set this method will return null.

SrvMonAppInfo[] getAppsInfoEmptyIfNull()
Gets the value of 'appsInfo' or an empty array if the value is null or not set.

XIterator<SrvMonAppInfo> getAppsInfoIterator()
Gets the value of 'appsInfo' as iterator of values.

SrvMonAppStats[] getAppsStats()
Gets the value of 'appsStats' If the field is not set this method will return null.

SrvMonAppStats[] getAppsStatsEmptyIfNull()
Gets the value of 'appsStats' or an empty array if the value is null or not set.

XIterator<SrvMonAppStats> getAppsStatsIterator()
Gets the value of 'appsStats' as iterator of values.

long getCollectionEndTime()
Gets the value of 'collectionEndTime' Field Description The collection end time in nanoseconds (e.g.

long getCollectionStartTime()
Gets the value of 'collectionStartTime' Field Description The collection start time in nanoseconds (e.g.

long getCollectionStartWallTime()
Gets the value of 'collectionStartWallTime' Field Description The collection start time in milliseconds since the Epoch (e.g.

Date getLoadedTime()
Gets the value of 'loadedTime' Field Description The time at which the server loaded

long getLoadedTimeAsTimestamp()
Retrieves the date as a timestamp (a zero garbage operation for XBuf encoding).

SrvMonPoolStats[] getPoolStats()
Gets the value of 'poolStats' If the field is not set this method will return null.

SrvMonPoolStats[] getPoolStatsEmptyIfNull()
Gets the value of 'poolStats' or an empty array if the value is null or not set.

XIterator<SrvMonPoolStats> getPoolStatsIterator()
Gets the value of 'poolStats' as iterator of values.

String getServerHostName()
Gets the value of 'serverHostName' Field Description The server's hostname





<T extends XString> 


T

getServerHostNameTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory.

void getServerHostNameTo(XString val)
Copies the value of 'serverHostName' into the provided XString.

XString getServerHostNameUnsafe()
Gets the raw value of 'serverHostName'.

String getServerName()
Gets the value of 'serverName' Field Description The name of the server





<T extends XString> 


T

getServerNameTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory.

void getServerNameTo(XString val)
Copies the value of 'serverName' into the provided XString.

XString getServerNameUnsafe()
Gets the raw value of 'serverName'.

String getServerPid()
Gets the value of 'serverPid' Field Description The server process id





<T extends XString> 


T

getServerPidTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory.

void getServerPidTo(XString val)
Copies the value of 'serverPid' into the provided XString.

XString getServerPidUnsafe()
Gets the raw value of 'serverPid'.

SrvMonSysStats getSysStats()
Gets the value of 'sysStats' Field Description Collects System System level stats such process or memory usage.

void getSysStatsTo(SrvMonSysStats val)
Copies the value of SrvMonSysStats into the provided value.

String getSystemName()
Gets the value of 'systemName' Field Description The name of the system to which the server belongs.





<T extends XString> 


T

getSystemNameTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory.

void getSystemNameTo(XString val)
Copies the value of 'systemName' into the provided XString.

XString getSystemNameUnsafe()
Gets the raw value of 'systemName'.

String getSystemVersion()
Gets the value of 'systemVersion' Field Description The version of the system to which the server belongs.





<T extends XString> 


T

getSystemVersionTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory.

void getSystemVersionTo(XString val)
Copies the value of 'systemVersion' into the provided XString.

XString getSystemVersionUnsafe()
Gets the raw value of 'systemVersion'.

boolean hasCollectionEndTime()
Checks for the presence of 'collectionEndTime' Field Description The collection end time in nanoseconds (e.g.

boolean hasCollectionStartTime()
Checks for the presence of 'collectionStartTime' Field Description The collection start time in nanoseconds (e.g.

boolean hasCollectionStartWallTime()
Checks for the presence of 'collectionStartWallTime' Field Description The collection start time in milliseconds since the Epoch (e.g.

boolean hasLoadedTime()
Checks for the presence of 'loadedTime' Field Description The time at which the server loaded

boolean hasServerHostName()
Checks for the presence of 'serverHostName' Field Description The server's hostname

boolean hasServerName()
Checks for the presence of 'serverName' Field Description The name of the server

boolean hasServerPid()
Checks for the presence of 'serverPid' Field Description The server process id

boolean hasSysStats()
Checks for the presence of 'sysStats' Field Description Collects System System level stats such process or memory usage.

boolean hasSystemName()
Checks for the presence of 'systemName' Field Description The name of the system to which the server belongs.

boolean hasSystemVersion()
Checks for the presence of 'systemVersion' Field Description The version of the system to which the server belongs.

void lendAdminClientStats(SrvMonAdminClientStats val)
Adds the provided value to the list of 'adminClientStats' values and acquires a reference to it.

void lendAdminClientStats(SrvMonAdminClientStats[] val)
Lends the value of 'adminClientStats' Field Description Collects stats related to the admin client connections NOTE:
It is illegal to hold onto an entity 'set' on a message post the disposal of the container message.

void lendAdminClientStatsFrom(XIterator<SrvMonAdminClientStats> val)
Sets the value of 'adminClientStats' by lending the values from the provided iterator.

void lendAppsInfo(SrvMonAppInfo val)
Adds the provided value to the list of 'appsInfo' values and acquires a reference to it.

void lendAppsInfo(SrvMonAppInfo[] val)
Lends the value of 'appsInfo' Field Description Information about the apps configured for this server NOTE:
It is illegal to hold onto an entity 'set' on a message post the disposal of the container message.

void lendAppsInfoFrom(XIterator<SrvMonAppInfo> val)
Sets the value of 'appsInfo' by lending the values from the provided iterator.

void lendAppsStats(SrvMonAppStats val)
Adds the provided value to the list of 'appsStats' values and acquires a reference to it.

void lendAppsStats(SrvMonAppStats[] val)
Lends the value of 'appsStats' Field Description Platform and user stats for loaded applications NOTE:
It is illegal to hold onto an entity 'set' on a message post the disposal of the container message.

void lendAppsStatsFrom(XIterator<SrvMonAppStats> val)
Sets the value of 'appsStats' by lending the values from the provided iterator.

void lendPoolStats(SrvMonPoolStats val)
Adds the provided value to the list of 'poolStats' values and acquires a reference to it.

void lendPoolStats(SrvMonPoolStats[] val)
Lends the value of 'poolStats' Field Description Collects process wide pooling stats NOTE:
It is illegal to hold onto an entity 'set' on a message post the disposal of the container message.

void lendPoolStatsFrom(XIterator<SrvMonPoolStats> val)
Sets the value of 'poolStats' by lending the values from the provided iterator.

void lendServerHostName(XString val)
Sets the value of 'serverHostName' Field Description The server's hostname

void lendServerName(XString val)
Sets the value of 'serverName' Field Description The name of the server

void lendServerPid(XString val)
Sets the value of 'serverPid' Field Description The server process id

void lendSysStats(SrvMonSysStats val)
'Lends' a reference of the SrvMonSysStats to the message for this field.

void lendSystemName(XString val)
Sets the value of 'systemName' Field Description The name of the system to which the server belongs.

void lendSystemVersion(XString val)
Sets the value of 'systemVersion' Field Description The version of the system to which the server belongs.

void setAdminClientStats(SrvMonAdminClientStats[] val)
Sets the value of 'adminClientStats' Field Description Collects stats related to the admin client connections

void setAdminClientStatsFrom(XIterator<SrvMonAdminClientStats> val)
Sets the value of 'adminClientStats' using the values from the provided iterator.

void setAppsInfo(SrvMonAppInfo[] val)
Sets the value of 'appsInfo' Field Description Information about the apps configured for this server

void setAppsInfoFrom(XIterator<SrvMonAppInfo> val)
Sets the value of 'appsInfo' using the values from the provided iterator.

void setAppsStats(SrvMonAppStats[] val)
Sets the value of 'appsStats' Field Description Platform and user stats for loaded applications

void setAppsStatsFrom(XIterator<SrvMonAppStats> val)
Sets the value of 'appsStats' using the values from the provided iterator.

void setCollectionEndTime(long val)
Sets the value of 'collectionEndTime' Field Description The collection end time in nanoseconds (e.g.

void setCollectionStartTime(long val)
Sets the value of 'collectionStartTime' Field Description The collection start time in nanoseconds (e.g.

void setCollectionStartWallTime(long val)
Sets the value of 'collectionStartWallTime' Field Description The collection start time in milliseconds since the Epoch (e.g.

void setLoadedTime(Date val)
Sets the value of 'loadedTime' Field Description The time at which the server loaded

void setLoadedTimeAsTimestamp(long val)
Sets the date value as a timestamp.

void setPoolStats(SrvMonPoolStats[] val)
Sets the value of 'poolStats' Field Description Collects process wide pooling stats

void setPoolStatsFrom(XIterator<SrvMonPoolStats> val)
Sets the value of 'poolStats' using the values from the provided iterator.

void setServerHostName(String val)
Sets the value of 'serverHostName' Field Description The server's hostname

void setServerHostNameFrom(long val)
Sets the value of this String field to the given numeric value.

void setServerHostNameFrom(XString val)
Copies the provided XString value into this object's 'serverHostName'.

void setServerName(String val)
Sets the value of 'serverName' Field Description The name of the server

void setServerNameFrom(long val)
Sets the value of this String field to the given numeric value.

void setServerNameFrom(XString val)
Copies the provided XString value into this object's 'serverName'.

void setServerPid(String val)
Sets the value of 'serverPid' Field Description The server process id

void setServerPidFrom(long val)
Sets the value of this String field to the given numeric value.

void setServerPidFrom(XString val)
Copies the provided XString value into this object's 'serverPid'.

void setSysStats(SrvMonSysStats val)
Sets the value of 'sysStats' Field Description Collects System System level stats such process or memory usage.

void setSystemName(String val)
Sets the value of 'systemName' Field Description The name of the system to which the server belongs.

void setSystemNameFrom(long val)
Sets the value of this String field to the given numeric value.

void setSystemNameFrom(XString val)
Copies the provided XString value into this object's 'systemName'.

void setSystemVersion(String val)
Sets the value of 'systemVersion' Field Description The version of the system to which the server belongs.

void setSystemVersionFrom(long val)
Sets the value of this String field to the given numeric value.

void setSystemVersionFrom(XString val)
Copies the provided XString value into this object's 'systemVersion'.

SrvMonAdminClientStats[] takeAdminClientStats()
Takes the value of 'adminClientStats' Field Description Collects stats related to the admin client connections NOTE:
A nested entity reference returned by getAdminClientStats() 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.

SrvMonAppInfo[] takeAppsInfo()
Takes the value of 'appsInfo' Field Description Information about the apps configured for this server NOTE:
A nested entity reference returned by getAppsInfo() 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.

SrvMonAppStats[] takeAppsStats()
Takes the value of 'appsStats' Field Description Platform and user stats for loaded applications NOTE:
A nested entity reference returned by getAppsStats() 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.

SrvMonPoolStats[] takePoolStats()
Takes the value of 'poolStats' Field Description Collects process wide pooling stats NOTE:
A nested entity reference returned by getPoolStats() 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.

SrvMonSysStats takeSysStats()
'Takes' a reference to the sysStats field from the message.

Methods inherited from interface com.neeve.rog.IRogNode
`deserializeFromProtobuf, dispose, dump, getAttachment, getIsPriority, getIsReadOnly, getMetadata, getParent, getPoolingListener, getType, metadataToJsonString, serializeToProtobuf, setAsInboundMessage, setAsInternal, setAsLastTransaction, setAsMessage, setAsOutboundMessage, setAsPriority, setAsReadOnly, setAsReplayedMessage, setAttachment, setInMsgsInTransaction, setOutMsgsInTransaction, setParentId, setPoolingListener, setTransactionInSequenceNumber, setTransactionOutSequenceNumber`

Methods inherited from interface com.neeve.rog.IRogNode

deserializeFromProtobuf, dispose, dump, getAttachment, getIsPriority, getIsReadOnly, getMetadata, getParent, getPoolingListener, getType, metadataToJsonString, serializeToProtobuf, setAsInboundMessage, setAsInternal, setAsLastTransaction, setAsMessage, setAsOutboundMessage, setAsPriority, setAsReadOnly, setAsReplayedMessage, setAttachment, setInMsgsInTransaction, setOutMsgsInTransaction, setParentId, setPoolingListener, setTransactionInSequenceNumber, setTransactionOutSequenceNumber

Methods inherited from interface com.neeve.ods.IStoreObject
`acquire, deserialize, deserializeMetadata, deserializeMetadata, ensureId, getBinding, getCheckpointVersion, getContentEncodingType, getId, getOfid, getOwnershipCount, getSerializedMetadataLength, getStableTransactionId, getTransactionId, serialize, serializeMetadata, setBinding, setCheckpointVersion, setFieldValue, setId, setStableTransactionId, setTransactionId`

Methods inherited from interface com.neeve.sma.MapMessageView
`getMessageReflector`

Methods inherited from interface com.neeve.rog.IRogMetadata
getEnqueueTs, getEnqueueTsMicros, getGraphId, getInMsgsInTransaction, getIsInboundMessage, getIsInternal, getIsLastTransaction, getIsMessage, getIsOutboundMessage, getIsReplayedMessage, getMessageBus, getMessageChannel, getMessageFlow, getMessageKey, getMessageSender, getMessageSequenceNumber, getOutMsgsInTransaction, getOutTs, getOutTsMicros, getParentId, getPreProcessingTs, getPreProcessingTsMicros, getTransactionInSequenceNumber, getTransactionOutSequenceNumber, isPossibleDuplicate, metadataToJsonString, metadataToString

Methods inherited from interface com.neeve.rog.IRogMetadata

getEnqueueTs, getEnqueueTsMicros, getGraphId, getInMsgsInTransaction, getIsInboundMessage, getIsInternal, getIsLastTransaction, getIsMessage, getIsOutboundMessage, getIsReplayedMessage, getMessageBus, getMessageChannel, getMessageFlow, getMessageKey, getMessageSender, getMessageSequenceNumber, getOutMsgsInTransaction, getOutTs, getOutTsMicros, getParentId, getPreProcessingTs, getPreProcessingTsMicros, getTransactionInSequenceNumber, getTransactionOutSequenceNumber, isPossibleDuplicate, metadataToJsonString, metadataToString

Methods inherited from interface com.neeve.rog.IRogValidatable
`getValidationErrors, isValid`

Method Detail

setCollectionStartWallTime

void setCollectionStartWallTime(long val)

Sets the value of 'collectionStartWallTime'

Field Description

The collection start time in milliseconds since the Epoch (e.g. System.currentTimeMillis())

Parameters:: val - The value to set.

getCollectionStartWallTime

long getCollectionStartWallTime()

Gets the value of 'collectionStartWallTime'

Field Description

The collection start time in milliseconds since the Epoch (e.g. System.currentTimeMillis())

Returns:: The collection start time in milliseconds since the Epoch (e.g. System.currentTimeMillis())

clearCollectionStartWallTime

void clearCollectionStartWallTime()

Clears the value of 'collectionStartWallTime'

Field Description

The collection start time in milliseconds since the Epoch (e.g. System.currentTimeMillis())

See Also:: setCollectionStartWallTime(long)

hasCollectionStartWallTime

boolean hasCollectionStartWallTime()

Checks for the presence of 'collectionStartWallTime'

Field Description

The collection start time in milliseconds since the Epoch (e.g. System.currentTimeMillis())

See Also:: getCollectionStartWallTime()

setCollectionStartTime

void setCollectionStartTime(long val)

Sets the value of 'collectionStartTime'

Field Description

The collection start time in nanoseconds (e.g. System.nanoTime())

Parameters:: val - The value to set.

getCollectionStartTime

long getCollectionStartTime()

Gets the value of 'collectionStartTime'

Field Description

The collection start time in nanoseconds (e.g. System.nanoTime())

Returns:: The collection start time in nanoseconds (e.g. System.nanoTime())

clearCollectionStartTime

void clearCollectionStartTime()

Clears the value of 'collectionStartTime'

Field Description

The collection start time in nanoseconds (e.g. System.nanoTime())

See Also:: setCollectionStartTime(long)

hasCollectionStartTime

boolean hasCollectionStartTime()

Checks for the presence of 'collectionStartTime'

Field Description

The collection start time in nanoseconds (e.g. System.nanoTime())

See Also:: getCollectionStartTime()

setCollectionEndTime

void setCollectionEndTime(long val)

Sets the value of 'collectionEndTime'

Field Description

The collection end time in nanoseconds (e.g. System.nanoTime())

Parameters:: val - The value to set.

getCollectionEndTime

long getCollectionEndTime()

Gets the value of 'collectionEndTime'

Field Description

The collection end time in nanoseconds (e.g. System.nanoTime())

Returns:: The collection end time in nanoseconds (e.g. System.nanoTime())

clearCollectionEndTime

void clearCollectionEndTime()

Clears the value of 'collectionEndTime'

Field Description

The collection end time in nanoseconds (e.g. System.nanoTime())

See Also:: setCollectionEndTime(long)

hasCollectionEndTime

boolean hasCollectionEndTime()

Checks for the presence of 'collectionEndTime'

Field Description

The collection end time in nanoseconds (e.g. System.nanoTime())

See Also:: getCollectionEndTime()

setLoadedTime

void setLoadedTime(Date val)

Sets the value of 'loadedTime'

Field Description

The time at which the server loaded

Parameters:: val - The value to set.

getLoadedTime

Date getLoadedTime()

Gets the value of 'loadedTime'

Field Description

The time at which the server loaded

Returns:: The time at which the server loaded

setLoadedTimeAsTimestamp

void setLoadedTimeAsTimestamp(long val)

Sets the date value as a timestamp.

Field Description

The time at which the server loaded

Parameters:: val - The date value in milliseconds from the epoch

getLoadedTimeAsTimestamp

long getLoadedTimeAsTimestamp()

Retrieves the date as a timestamp (a zero garbage operation for XBuf encoding).

Field Description

The time at which the server loaded

NOTE:
Note that a return value of -1 could also indicate 1 millisecond before the epoch. In cases where a such an ambiguity is a practical concern, hasLoadedTime() should be called.

Returns:: The data as a timestamp in milliseconds from the epoch or -1 if null or not set

clearLoadedTime

void clearLoadedTime()

Clears the value of 'loadedTime'

Field Description

The time at which the server loaded

See Also:: setLoadedTime(Date)

hasLoadedTime

boolean hasLoadedTime()

Checks for the presence of 'loadedTime'

Field Description

The time at which the server loaded

See Also:: getLoadedTime()

setServerName

void setServerName(String val)

Sets the value of 'serverName'

Field Description

The name of the server

Parameters:: val - The value to set.

getServerName

String getServerName()

Gets the value of 'serverName'

Field Description

The name of the server

Returns:: The name of the server

lendServerName

void lendServerName(XString val)

Sets the value of 'serverName'

Field Description

The name of the server

Parameters:: val - The value to set.

setServerNameFrom

void setServerNameFrom(long val)

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

Field Description

The name of the server

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

getServerNameTo

<T extends XString> T getServerNameTo(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 server

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

setServerNameFrom

void setServerNameFrom(XString val)

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

Field Description

The name of the server

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

getServerNameTo

void getServerNameTo(XString val)

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

Field Description

The name of the server

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

See Also:: getServerName()

getServerNameUnsafe

XString getServerNameUnsafe()

Gets the raw value of 'serverName'.

Field Description

The name of the server

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

clearServerName

void clearServerName()

Clears the value of 'serverName'

Field Description

The name of the server

See Also:: setServerName(String)

hasServerName

boolean hasServerName()

Checks for the presence of 'serverName'

Field Description

The name of the server

See Also:: getServerName()

setServerHostName

void setServerHostName(String val)

Sets the value of 'serverHostName'

Field Description

The server's hostname

Parameters:: val - The value to set.

getServerHostName

String getServerHostName()

Gets the value of 'serverHostName'

Field Description

The server's hostname

Returns:: The server's hostname

lendServerHostName

void lendServerHostName(XString val)

Sets the value of 'serverHostName'

Field Description

The server's hostname

Parameters:: val - The value to set.

setServerHostNameFrom

void setServerHostNameFrom(long val)

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

Field Description

The server's hostname

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

getServerHostNameTo

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

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

Field Description

The server's hostname

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

setServerHostNameFrom

void setServerHostNameFrom(XString val)

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

Field Description

The server's hostname

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

getServerHostNameTo

void getServerHostNameTo(XString val)

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

Field Description

The server's hostname

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

See Also:: getServerHostName()

getServerHostNameUnsafe

XString getServerHostNameUnsafe()

Gets the raw value of 'serverHostName'.

Field Description

The server's hostname

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

clearServerHostName

void clearServerHostName()

Clears the value of 'serverHostName'

Field Description

The server's hostname

See Also:: setServerHostName(String)

hasServerHostName

boolean hasServerHostName()

Checks for the presence of 'serverHostName'

Field Description

The server's hostname

See Also:: getServerHostName()

setServerPid

void setServerPid(String val)

Sets the value of 'serverPid'

Field Description

The server process id

Parameters:: val - The value to set.

getServerPid

String getServerPid()

Gets the value of 'serverPid'

Field Description

The server process id

Returns:: The server process id

lendServerPid

void lendServerPid(XString val)

Sets the value of 'serverPid'

Field Description

The server process id

Parameters:: val - The value to set.

setServerPidFrom

void setServerPidFrom(long val)

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

Field Description

The server process id

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

getServerPidTo

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

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

Field Description

The server process id

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

setServerPidFrom

void setServerPidFrom(XString val)

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

Field Description

The server process id

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

getServerPidTo

void getServerPidTo(XString val)

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

Field Description

The server process id

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

See Also:: getServerPid()

getServerPidUnsafe

XString getServerPidUnsafe()

Gets the raw value of 'serverPid'.

Field Description

The server process id

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

clearServerPid

void clearServerPid()

Clears the value of 'serverPid'

Field Description

The server process id

See Also:: setServerPid(String)

hasServerPid

boolean hasServerPid()

Checks for the presence of 'serverPid'

Field Description

The server process id

See Also:: getServerPid()

setSysStats

void setSysStats(SrvMonSysStats val)

Sets the value of 'sysStats'

Field Description

Collects System System level stats such process or memory usage.

Parameters:: val - The value to set.

lendSysStats

void lendSysStats(SrvMonSysStats val)

'Lends' a reference of the SrvMonSysStats to the message for this field.

Field Description

Collects System System level stats such process or memory usage.

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.

getSysStats

SrvMonSysStats getSysStats()

Gets the value of 'sysStats'

Field Description

Collects System System level stats such process or memory usage.

Returns:: Collects System System level stats such process or memory usage.

getSysStatsTo

void getSysStatsTo(SrvMonSysStats val)

Copies the value of SrvMonSysStats into the provided value.

IF the value is not set, then the contents of the provided SrvMonSysStats are cleared.

Parameters:: val - the value to copy into
See Also:: SrvMonSysStats.copyInto(SrvMonSysStats)

takeSysStats

SrvMonSysStats takeSysStats()

'Takes' a reference to the sysStats field from the message.

Field Description

Collects System System level stats such process or memory usage.

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

hasSysStats

boolean hasSysStats()

Checks for the presence of 'sysStats'

Field Description

Collects System System level stats such process or memory usage.

See Also:: getSysStats()

clearSysStats

void clearSysStats()

Clears the value of 'sysStats'

Field Description

Collects System System level stats such process or memory usage.

See Also:: setSysStats(SrvMonSysStats)

setPoolStats

void setPoolStats(SrvMonPoolStats[] val)

Sets the value of 'poolStats'

Field Description

Collects process wide pooling stats

Parameters:: val - The value to set.

setPoolStatsFrom

void setPoolStatsFrom(XIterator<SrvMonPoolStats> val)

Sets the value of 'poolStats' 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 'poolStats' accessor can copy the values without iteration.

Field Description

Collects process wide pooling stats

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

Parameters:: val - the values to set.

lendPoolStatsFrom

void lendPoolStatsFrom(XIterator<SrvMonPoolStats> val)

Sets the value of 'poolStats' 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 'poolStats' accessor can copy the values without iteration.

Field Description

Collects process wide pooling stats

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

Parameters:: val - the values to set.

addPoolStats

void addPoolStats(SrvMonPoolStats val)

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

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

Collects process wide pooling stats

Parameters:: val - the value to add.

lendPoolStats

void lendPoolStats(SrvMonPoolStats val)

Adds the provided value to the list of 'poolStats' 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 'poolStats' accessor can copy the values without iteration.

Field Description

Collects process wide pooling stats

Parameters:: val - the value to add.

getPoolStatsIterator

XIterator<SrvMonPoolStats> getPoolStatsIterator()

Gets the value of 'poolStats' 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 this object intends to keep beyond the lifespan. of this object (unless the element is lent to another object in which that object will acquire it then).

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

Collects process wide pooling stats

Returns:: An iterator containing this field values.

lendPoolStats

void lendPoolStats(SrvMonPoolStats[] val)

Lends the value of 'poolStats'

Field Description

Collects process wide pooling stats

Parameters:: val - the value to 'lend' to lend.

getPoolStats

SrvMonPoolStats[] getPoolStats()

Gets the value of 'poolStats'

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

Field Description

Collects process wide pooling stats

Returns:: Collects process wide pooling stats If the field is not set this method will return null.

getPoolStatsEmptyIfNull

SrvMonPoolStats[] getPoolStatsEmptyIfNull()

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

Field Description

Collects process wide pooling stats

Returns:: Collects process wide pooling stats or an empty array if null if not set.
See Also:: getPoolStats()

takePoolStats

SrvMonPoolStats[] takePoolStats()

Takes the value of 'poolStats'

Field Description

Collects process wide pooling stats

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

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

clearPoolStats

void clearPoolStats()

Clears the value of 'poolStats'

Field Description

Collects process wide pooling stats

See Also:: setPoolStats(SrvMonPoolStats[])

setAppsInfo

void setAppsInfo(SrvMonAppInfo[] val)

Sets the value of 'appsInfo'

Field Description

Information about the apps configured for this server

Parameters:: val - The value to set.

setAppsInfoFrom

void setAppsInfoFrom(XIterator<SrvMonAppInfo> val)

Sets the value of 'appsInfo' 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 'appsInfo' accessor can copy the values without iteration.

Field Description

Information about the apps configured for this server

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

Parameters:: val - the values to set.

lendAppsInfoFrom

void lendAppsInfoFrom(XIterator<SrvMonAppInfo> val)

Sets the value of 'appsInfo' 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 'appsInfo' accessor can copy the values without iteration.

Field Description

Information about the apps configured for this server

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

Parameters:: val - the values to set.

addAppsInfo

void addAppsInfo(SrvMonAppInfo val)

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

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

Field Description

Information about the apps configured for this server

Parameters:: val - the value to add.

lendAppsInfo

void lendAppsInfo(SrvMonAppInfo val)

Adds the provided value to the list of 'appsInfo' 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 'appsInfo' accessor can copy the values without iteration.

Field Description

Information about the apps configured for this server

Parameters:: val - the value to add.

getAppsInfoIterator

XIterator<SrvMonAppInfo> getAppsInfoIterator()

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

Field Description

Information about the apps configured for this server

Returns:: An iterator containing this field values.

lendAppsInfo

void lendAppsInfo(SrvMonAppInfo[] val)

Lends the value of 'appsInfo'

Field Description

Information about the apps configured for this server

Parameters:: val - the value to 'lend' to lend.

getAppsInfo

SrvMonAppInfo[] getAppsInfo()

Gets the value of 'appsInfo'

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

Field Description

Information about the apps configured for this server

Returns:: Information about the apps configured for this server If the field is not set this method will return null.

getAppsInfoEmptyIfNull

SrvMonAppInfo[] getAppsInfoEmptyIfNull()

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

Field Description

Information about the apps configured for this server

Returns:: Information about the apps configured for this server or an empty array if null if not set.
See Also:: getAppsInfo()

takeAppsInfo

SrvMonAppInfo[] takeAppsInfo()

Takes the value of 'appsInfo'

Field Description

Information about the apps configured for this server

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

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

clearAppsInfo

void clearAppsInfo()

Clears the value of 'appsInfo'

Field Description

Information about the apps configured for this server

See Also:: setAppsInfo(SrvMonAppInfo[])

setAppsStats

void setAppsStats(SrvMonAppStats[] val)

Sets the value of 'appsStats'

Field Description

Platform and user stats for loaded applications

Parameters:: val - The value to set.

setAppsStatsFrom

void setAppsStatsFrom(XIterator<SrvMonAppStats> val)

Sets the value of 'appsStats' 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 'appsStats' accessor can copy the values without iteration.

Field Description

Platform and user stats for loaded applications

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

Parameters:: val - the values to set.

lendAppsStatsFrom

void lendAppsStatsFrom(XIterator<SrvMonAppStats> val)

Sets the value of 'appsStats' 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 'appsStats' accessor can copy the values without iteration.

Field Description

Platform and user stats for loaded applications

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

Parameters:: val - the values to set.

addAppsStats

void addAppsStats(SrvMonAppStats val)

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

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

Field Description

Platform and user stats for loaded applications

Parameters:: val - the value to add.

lendAppsStats

void lendAppsStats(SrvMonAppStats val)

Adds the provided value to the list of 'appsStats' 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 'appsStats' accessor can copy the values without iteration.

Field Description

Platform and user stats for loaded applications

Parameters:: val - the value to add.

getAppsStatsIterator

XIterator<SrvMonAppStats> getAppsStatsIterator()

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

Field Description

Platform and user stats for loaded applications

Returns:: An iterator containing this field values.

lendAppsStats

void lendAppsStats(SrvMonAppStats[] val)

Lends the value of 'appsStats'

Field Description

Platform and user stats for loaded applications

Parameters:: val - the value to 'lend' to lend.

getAppsStats

SrvMonAppStats[] getAppsStats()

Gets the value of 'appsStats'

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

Field Description

Platform and user stats for loaded applications

Returns:: Platform and user stats for loaded applications If the field is not set this method will return null.

getAppsStatsEmptyIfNull

SrvMonAppStats[] getAppsStatsEmptyIfNull()

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

Field Description

Platform and user stats for loaded applications

Returns:: Platform and user stats for loaded applications or an empty array if null if not set.
See Also:: getAppsStats()

takeAppsStats

SrvMonAppStats[] takeAppsStats()

Takes the value of 'appsStats'

Field Description

Platform and user stats for loaded applications

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

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

clearAppsStats

void clearAppsStats()

Clears the value of 'appsStats'

Field Description

Platform and user stats for loaded applications

See Also:: setAppsStats(SrvMonAppStats[])

setAdminClientStats

void setAdminClientStats(SrvMonAdminClientStats[] val)

Sets the value of 'adminClientStats'

Field Description

Collects stats related to the admin client connections

Parameters:: val - The value to set.

setAdminClientStatsFrom

void setAdminClientStatsFrom(XIterator<SrvMonAdminClientStats> val)

Sets the value of 'adminClientStats' 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 'adminClientStats' accessor can copy the values without iteration.

Field Description

Collects stats related to the admin client connections

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

Parameters:: val - the values to set.

lendAdminClientStatsFrom

void lendAdminClientStatsFrom(XIterator<SrvMonAdminClientStats> val)

Sets the value of 'adminClientStats' 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.

Field Description

Collects stats related to the admin client connections

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

Parameters:: val - the values to set.

addAdminClientStats

void addAdminClientStats(SrvMonAdminClientStats val)

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

Field Description

Collects stats related to the admin client connections

Parameters:: val - the value to add.

lendAdminClientStats

void lendAdminClientStats(SrvMonAdminClientStats val)

Adds the provided value to the list of 'adminClientStats' 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.

Field Description

Collects stats related to the admin client connections

Parameters:: val - the value to add.

getAdminClientStatsIterator

XIterator<SrvMonAdminClientStats> getAdminClientStatsIterator()

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

Field Description

Collects stats related to the admin client connections

Returns:: An iterator containing this field values.

lendAdminClientStats

void lendAdminClientStats(SrvMonAdminClientStats[] val)

Lends the value of 'adminClientStats'

Field Description

Collects stats related to the admin client connections

Parameters:: val - the value to 'lend' to lend.

getAdminClientStats

SrvMonAdminClientStats[] getAdminClientStats()

Gets the value of 'adminClientStats'

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

Field Description

Collects stats related to the admin client connections

Returns:: Collects stats related to the admin client connections If the field is not set this method will return null.

getAdminClientStatsEmptyIfNull

SrvMonAdminClientStats[] getAdminClientStatsEmptyIfNull()

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

Field Description

Collects stats related to the admin client connections

Returns:: Collects stats related to the admin client connections or an empty array if null if not set.
See Also:: getAdminClientStats()

takeAdminClientStats

SrvMonAdminClientStats[] takeAdminClientStats()

Takes the value of 'adminClientStats'

Field Description

Collects stats related to the admin client connections

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

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

clearAdminClientStats

void clearAdminClientStats()

Clears the value of 'adminClientStats'

Field Description

Collects stats related to the admin client connections

See Also:: setAdminClientStats(SrvMonAdminClientStats[])

setSystemName

void setSystemName(String val)

Sets the value of 'systemName'

Field Description

The name of the system to which the server belongs.

Parameters:: val - The value to set.

getSystemName

String getSystemName()

Gets the value of 'systemName'

Field Description

The name of the system to which the server belongs.

Returns:: The name of the system to which the server belongs.

lendSystemName

void lendSystemName(XString val)

Sets the value of 'systemName'

Field Description

The name of the system to which the server belongs.

Parameters:: val - The value to set.

setSystemNameFrom

void setSystemNameFrom(long val)

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

Field Description

The name of the system to which the server belongs.

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

getSystemNameTo

<T extends XString> T getSystemNameTo(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 system to which the server belongs.

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

setSystemNameFrom

void setSystemNameFrom(XString val)

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

Field Description

The name of the system to which the server belongs.

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

getSystemNameTo

void getSystemNameTo(XString val)

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

Field Description

The name of the system to which the server belongs.

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

See Also:: getSystemName()

getSystemNameUnsafe

XString getSystemNameUnsafe()

Gets the raw value of 'systemName'.

Field Description

The name of the system to which the server belongs.

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

clearSystemName

void clearSystemName()

Clears the value of 'systemName'

Field Description

The name of the system to which the server belongs.

See Also:: setSystemName(String)

hasSystemName

boolean hasSystemName()

Checks for the presence of 'systemName'

Field Description

The name of the system to which the server belongs.

See Also:: getSystemName()

setSystemVersion

void setSystemVersion(String val)

Sets the value of 'systemVersion'

Field Description

The version of the system to which the server belongs.

Parameters:: val - The value to set.

getSystemVersion

String getSystemVersion()

Gets the value of 'systemVersion'

Field Description

The version of the system to which the server belongs.

Returns:: The version of the system to which the server belongs.

lendSystemVersion

void lendSystemVersion(XString val)

Sets the value of 'systemVersion'

Field Description

The version of the system to which the server belongs.

Parameters:: val - The value to set.

setSystemVersionFrom

void setSystemVersionFrom(long val)

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

Field Description

The version of the system to which the server belongs.

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

getSystemVersionTo

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

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

Field Description

The version of the system to which the server belongs.

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

setSystemVersionFrom

void setSystemVersionFrom(XString val)

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

Field Description

The version of the system to which the server belongs.

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

getSystemVersionTo

void getSystemVersionTo(XString val)

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

Field Description

The version of the system to which the server belongs.

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

See Also:: getSystemVersion()

getSystemVersionUnsafe

XString getSystemVersionUnsafe()

Gets the raw value of 'systemVersion'.

Field Description

The version of the system to which the server belongs.

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

clearSystemVersion

void clearSystemVersion()

Clears the value of 'systemVersion'

Field Description

The version of the system to which the server belongs.

See Also:: setSystemVersion(String)

hasSystemVersion

boolean hasSystemVersion()

Checks for the presence of 'systemVersion'

Field Description

The version of the system to which the server belongs.

See Also:: getSystemVersion()

copy

SrvMonHeartbeatMessage copy()

Creates a copy of this SrvMonHeartbeatMessage.

The copy copies primitive, enum and embedded entity fields into the returned copy. Each embedded entity field is cloned so that modifications made to the copy's embedded entity fields do not affect this SrvMonHeartbeatMessage's embedded entity fields.

The returned copy will be writeable even if this SrvMonHeartbeatMessage is read only.

No metadata is copied except as documented IRogCopyableNode. See IRogCopyableNode for more detailed information on the semantics of this method.

Specified by:: copy in interface CopyableMessageView<ISrvMonHeartbeatMessage>
Specified by:: copy in interface IRogCopyableNode<ISrvMonHeartbeatMessage>

Returns:: A copy of this SrvMonHeartbeatMessage.
See Also:: IRogCopyableNode, CopyableMessageView

copyInto

void copyInto(SrvMonHeartbeatMessage target)

Copies the contents of this SrvMonHeartbeatMessage into the target.

The copy clears the target's contents and copies primitive, enum and embedded entity fields into the provided copy. Each embedded entity field is cloned so that modifications made to the copy's embedded entity fields do not affect this SrvMonHeartbeatMessage's embedded entity fields.

The returned copy will be writeable even if this SrvMonHeartbeatMessage is read only.

No metadata is copied except as documented IRogCopyableNode. See IRogCopyableNode for more detailed information on the semantics of this method.

Parameters:: target - The target to copy into which must not be null or read only.

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.neeve.server.mon Interface ISrvMonHeartbeatMessage

setCollectionStartWallTime

Field Description

getCollectionStartWallTime

Field Description

clearCollectionStartWallTime

Field Description

hasCollectionStartWallTime

Field Description

setCollectionStartTime

Field Description

getCollectionStartTime

Field Description

clearCollectionStartTime

Field Description

hasCollectionStartTime

Field Description

setCollectionEndTime

Field Description

getCollectionEndTime

Field Description

clearCollectionEndTime

Field Description

hasCollectionEndTime

Field Description

setLoadedTime

Field Description

getLoadedTime

Field Description

setLoadedTimeAsTimestamp

Field Description

getLoadedTimeAsTimestamp

Field Description

clearLoadedTime

Field Description

hasLoadedTime

Field Description

setServerName

Field Description

getServerName

Field Description

lendServerName

Field Description

setServerNameFrom

Field Description

getServerNameTo

Field Description

setServerNameFrom

Field Description

getServerNameTo

Field Description

getServerNameUnsafe

Field Description

clearServerName

Field Description

hasServerName

Field Description

setServerHostName

Field Description

getServerHostName

Field Description

lendServerHostName

Field Description

setServerHostNameFrom

Field Description

getServerHostNameTo

Field Description

setServerHostNameFrom

Field Description

getServerHostNameTo

Field Description

getServerHostNameUnsafe

Field Description

clearServerHostName

Field Description

hasServerHostName

Field Description

setServerPid

Field Description

getServerPid

com.neeve.server.mon
Interface ISrvMonHeartbeatMessage