@Generated(value="com.neeve.adm.AdmXbufGenerator", date="Fri Dec 05 13:32:50 UTC 2025") @AdmGenerated(encoding="Xbuf", compatLevel="4.1.0", admVersion="Unknown Version", date="12/5/25 1:32 PM", buildInfo="nvx-talon-3.16.63 (nvx-codegen-plugin)") @AdmFactoryInfo(factoryClass=SrvMonFactory.class, vfid=32, ofid=32, typeId=99) public final class SrvMonHeartbeatMessage extends com.neeve.rog.impl.RogNode implements ISrvMonHeartbeatMessage, com.neeve.link.ILnkMessage, MessageReflector, com.neeve.xbuf.IXbufDesyncer, IRogJsonizable
The XVM heartbeat is emitted by a Talon XVM at regular intervals and contains all of the stats reported by a XVM.
| ADM Type | Message |
| Factory | SrvMonFactory |
| ADM Field Summary |
|---|
| Field | Type | Id | Description |
|---|---|---|---|
| adminClientStats | SrvMonAdminClientStats[] | 26 | Collects stats related to the admin client connections. |
| appsInfo | SrvMonAppInfo[] | 24 | Information about the apps configured for this XVM. |
| appsStats | SrvMonAppStats[] | 25 | Platform and user stats for loaded applications. |
| collectionEndTime | Long | 18 | The collection end time in nanoseconds (e.g. System.nanoTime()). |
| collectionStartTime | Long | 17 | The collection start time in nanoseconds (e.g. System.nanoTime()). |
| collectionStartWallTime | Long | 16 | The collection start time in milliseconds since the Epoch (e.g. System.currentTimeMillis()). |
| heartbeatLoggerStats | SrvMonAppMessageLoggerStats |
30 | Logger stats for the xvm's binary heartbeat log (if enabled). |
| loadedTime | Date | 27 | The time at which the XVM loaded. |
| poolStats | SrvMonPoolStats[] | 23 | Collects process wide pooling stats. |
| serverHostName | String | 20 | The XVM's hostname. |
| serverName | String | 19 | The name of the XVM. |
| serverPid | String | 21 | The XVM process id. |
| sysStats | SrvMonSysStats |
22 | Collects System System level stats such process or memory usage. |
| systemName | String | 28 | The name of the system to which the XVM belongs. |
| systemVersion | String | 29 | The version of the system to which the XVM belongs. |
| xvmHeader | SrvMonXvmHeader | 6019 | Details about the message source. |
| Modifier and Type | Class and Description |
|---|---|
static class |
SrvMonHeartbeatMessage.PacketBody
The backing packet type for SrvMonHeartbeatMessage (used internally for serialization purposes).
|
IRogNode.PoolingListenerIStoreObject.EncodingType| Modifier and Type | Field and Description |
|---|---|
static SrvMonHeartbeatMessage[] |
EMPTY_ARRAY
A preallocated empty array used to avoid garbage when returning empty arrays of this type.
|
count, head, next, prev| Modifier and Type | Method and Description |
|---|---|
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.
|
boolean |
appendFieldValueTo(Object node,
String[] pathComponents,
XString target)
Appends a reflected field value as a string into the given XString.
|
boolean |
appendFieldValueTo(Object message,
String name,
XString target)
Appends a reflected field value as a string into the given XString.
|
void |
clearAdminClientStats()
Clears the value of 'adminClientStats'.
|
void |
clearAppsInfo()
Clears the value of 'appsInfo'.
|
void |
clearAppsStats()
Clears the value of 'appsStats'.
|
void |
clearCollectionEndTime()
Clears the value of 'collectionEndTime'.
|
void |
clearCollectionStartTime()
Clears the value of 'collectionStartTime'.
|
void |
clearCollectionStartWallTime()
Clears the value of 'collectionStartWallTime'.
|
void |
clearContent() |
void |
clearHeartbeatLoggerStats()
Clears the value of 'heartbeatLoggerStats'.
|
void |
clearLoadedTime()
Clears the value of 'loadedTime'.
|
void |
clearPoolStats()
Clears the value of 'poolStats'.
|
void |
clearServerHostName()
Clears the value of 'serverHostName'.
|
void |
clearServerName()
Clears the value of 'serverName'.
|
void |
clearServerPid()
Clears the value of 'serverPid'.
|
void |
clearSysStats()
Clears the value of 'sysStats'.
|
void |
clearSystemName()
Clears the value of 'systemName'.
|
void |
clearSystemVersion()
Clears the value of 'systemVersion'.
|
void |
clearXRogType() |
void |
clearXvmHeader()
Clears the value of 'xvmHeader'.
|
SrvMonHeartbeatMessage |
copy()
Creates a copy of this SrvMonHeartbeatMessage.
|
void |
copyInto(SrvMonHeartbeatMessage copy)
Copies the contents of this SrvMonHeartbeatMessage into the target.
|
static SrvMonHeartbeatMessage |
create() |
static SrvMonHeartbeatMessage |
create(com.eaio.uuid.UUID id) |
static SrvMonHeartbeatMessage |
createFrom(byte[] serializedContainer) |
static SrvMonHeartbeatMessage |
createFrom(ByteBuffer serializedContainer) |
static SrvMonHeartbeatMessage |
createFromJson(String json) |
static SrvMonHeartbeatMessage |
createFromRawJson(String json) |
static SrvMonHeartbeatMessage |
createFromSerializedXbufContainer(byte[] serializedContainer) |
static SrvMonHeartbeatMessage |
createFromSerializedXbufContainer(ByteBuffer serializedContainer) |
static SrvMonHeartbeatMessage |
createFromSerializedXbufContainerPacket(byte[] serializedPacket) |
static SrvMonHeartbeatMessage |
createFromSerializedXbufContainerPacket(ByteBuffer serializedPacket) |
static SrvMonHeartbeatMessage |
createFromXbufContainerPacket(PktPacket packet) |
static com.neeve.xbuf.XbufSchema |
createSchema() |
SrvMonHeartbeatMessage |
deserialize(PktPacket packet)
Deserialize an object's data.
|
SrvMonHeartbeatMessage |
deserializeFromByteArray(byte[] array)
Deserialize a view's backing message from a byte array.
|
SrvMonHeartbeatMessage |
deserializeFromByteBuffer(ByteBuffer buffer)
Deserialize a view's backing message from a byte buffer.
|
SrvMonHeartbeatMessage |
deserializeFromJson(String json)
Deserialize a view's backing message from a json string
|
SrvMonHeartbeatMessage |
deserializeFromPacket(PktPacket packet)
Deserialize a view's backing message from a packet.
|
SrvMonHeartbeatMessage |
deserializeFromProtobuf(com.google.protobuf.Message message)
Deserialize a node's data from a protobuf message.
|
SrvMonHeartbeatMessage |
deserializeFromRawJson(String json) |
int |
desync(PktBuffer buffer,
int pos,
boolean frameOnly)
Desync fields from a buffer
|
void |
desyncFieldBitmask() |
int |
dispose()
Implementation of
IRogNode.dispose()
ROG nodes piggyback on packet pooling to perform node pooling. |
boolean |
fieldExists(Object message,
String name)
Check if a field of the supplied name exists in a message.
|
SrvMonAdminClientStats[] |
getAdminClientStats()
Gets the value of 'adminClientStats'.
|
SrvMonAdminClientStats[] |
getAdminClientStatsEmptyIfNull()
Gets the value of 'adminClientStats' or an empty array if the value is
null or not set. |
static int |
getAdminClientStatsFieldId() |
XIterator<SrvMonAdminClientStats> |
getAdminClientStatsIterator()
Gets the value of 'adminClientStats' as iterator of values.
|
SrvMonAppInfo[] |
getAppsInfo()
Gets the value of 'appsInfo'.
|
SrvMonAppInfo[] |
getAppsInfoEmptyIfNull()
Gets the value of 'appsInfo' or an empty array if the value is
null or not set. |
static int |
getAppsInfoFieldId() |
XIterator<SrvMonAppInfo> |
getAppsInfoIterator()
Gets the value of 'appsInfo' as iterator of values.
|
SrvMonAppStats[] |
getAppsStats()
Gets the value of 'appsStats'.
|
SrvMonAppStats[] |
getAppsStatsEmptyIfNull()
Gets the value of 'appsStats' or an empty array if the value is
null or not set. |
static int |
getAppsStatsFieldId() |
XIterator<SrvMonAppStats> |
getAppsStatsIterator()
Gets the value of 'appsStats' as iterator of values.
|
PktBuffer |
getBackingBuffer() |
long |
getCollectionEndTime()
Gets the value of 'collectionEndTime'.
|
Long |
getCollectionEndTimeAsObject()
Gets the value of 'collectionEndTime'.
|
com.neeve.xbuf.XbufVariableLongField |
getCollectionEndTimeField() |
static int |
getCollectionEndTimeFieldId() |
long |
getCollectionStartTime()
Gets the value of 'collectionStartTime'.
|
Long |
getCollectionStartTimeAsObject()
Gets the value of 'collectionStartTime'.
|
com.neeve.xbuf.XbufVariableLongField |
getCollectionStartTimeField() |
static int |
getCollectionStartTimeFieldId() |
long |
getCollectionStartWallTime()
Gets the value of 'collectionStartWallTime'.
|
Long |
getCollectionStartWallTimeAsObject()
Gets the value of 'collectionStartWallTime'.
|
com.neeve.xbuf.XbufVariableLongField |
getCollectionStartWallTimeField() |
static int |
getCollectionStartWallTimeFieldId() |
IStoreObject.EncodingType |
getContentEncodingType()
Get an object's content data encoding type.
|
static com.neeve.xbuf.XbufDesyncPolicy |
getDesyncPolicy() |
XString |
getFieldValueAsRawString(Object message,
String name)
Get the value of a reflectable field in a message as a string.
|
XString |
getFieldValueAsRawString(Object message,
String[] pathComponents)
Get the value of a reflectable field in a message as a string.
|
String |
getFieldValueAsString(Object message,
String name)
Get the value of a reflectable field in a message as a string.
|
String |
getFieldValueAsString(Object message,
String[] pathComponents)
Get the value of a reflectable field in a message as a string.
|
SrvMonAppMessageLoggerStats |
getHeartbeatLoggerStats()
Gets the value of 'heartbeatLoggerStats'.
|
static int |
getHeartbeatLoggerStatsFieldId() |
void |
getHeartbeatLoggerStatsTo(SrvMonAppMessageLoggerStats to)
Copies the value of SrvMonAppMessageLoggerStats into the provided value.
|
Date |
getLoadedTime()
Gets the value of 'loadedTime'.
|
Instant |
getLoadedTimeAsInstant()
Retrieves the date as a java.time.Instant object.
|
long |
getLoadedTimeAsTimestamp()
Retrieves the date as a timestamp (a zero garbage operation for XBuf encoding).
|
Long |
getLoadedTimeAsTimestampObject()
Retrieves the date as a timestamp object (autobox long).
|
com.neeve.xbuf.XbufVariableDateField |
getLoadedTimeField() |
static int |
getLoadedTimeFieldId() |
PktPacket |
getPacket()
Return the packet tied to this message.
|
SrvMonPoolStats[] |
getPoolStats()
Gets the value of 'poolStats'.
|
SrvMonPoolStats[] |
getPoolStatsEmptyIfNull()
Gets the value of 'poolStats' or an empty array if the value is
null or not set. |
static int |
getPoolStatsFieldId() |
XIterator<SrvMonPoolStats> |
getPoolStatsIterator()
Gets the value of 'poolStats' as iterator of values.
|
String |
getServerHostName()
Gets the value of 'serverHostName'.
|
com.neeve.xbuf.XbufStringField |
getServerHostNameField() |
static int |
getServerHostNameFieldId() |
<T extends XString> |
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'.
|
com.neeve.xbuf.XbufStringField |
getServerNameField() |
static int |
getServerNameFieldId() |
<T extends XString> |
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'.
|
com.neeve.xbuf.XbufStringField |
getServerPidField() |
static int |
getServerPidFieldId() |
<T extends XString> |
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'.
|
static int |
getSysStatsFieldId() |
void |
getSysStatsTo(SrvMonSysStats to)
Copies the value of SrvMonSysStats into the provided value.
|
String |
getSystemName()
Gets the value of 'systemName'.
|
com.neeve.xbuf.XbufStringField |
getSystemNameField() |
static int |
getSystemNameFieldId() |
<T extends XString> |
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'.
|
com.neeve.xbuf.XbufStringField |
getSystemVersionField() |
static int |
getSystemVersionFieldId() |
<T extends XString> |
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'.
|
short |
getXRogType() |
Short |
getXRogTypeAsObject() |
com.neeve.xbuf.XbufVariableShortField |
getXRogTypeField() |
static int |
getXRogTypeFieldId() |
com.neeve.server.mon.common.SrvMonXvmHeader |
getXvmHeader()
Gets the value of 'xvmHeader'.
|
static int |
getXvmHeaderFieldId() |
void |
getXvmHeaderTo(com.neeve.server.mon.common.SrvMonXvmHeader to)
Copies the value of SrvMonXvmHeader into the provided value.
|
boolean |
hasCollectionEndTime()
Checks for the presence of 'collectionEndTime'.
|
boolean |
hasCollectionStartTime()
Checks for the presence of 'collectionStartTime'.
|
boolean |
hasCollectionStartWallTime()
Checks for the presence of 'collectionStartWallTime'.
|
boolean |
hasHeartbeatLoggerStats()
Checks for the presence of 'heartbeatLoggerStats'.
|
boolean |
hasLoadedTime()
Checks for the presence of 'loadedTime'.
|
boolean |
hasServerHostName()
Checks for the presence of 'serverHostName'.
|
boolean |
hasServerName()
Checks for the presence of 'serverName'.
|
boolean |
hasServerPid()
Checks for the presence of 'serverPid'.
|
boolean |
hasSysStats()
Checks for the presence of 'sysStats'.
|
boolean |
hasSystemName()
Checks for the presence of 'systemName'.
|
boolean |
hasSystemVersion()
Checks for the presence of 'systemVersion'.
|
boolean |
hasXRogType() |
boolean |
hasXvmHeader()
Checks for the presence of 'xvmHeader'.
|
boolean |
isDirty() |
boolean |
isFieldReflectable(Object message,
String name)
Check if a field of the supplied name is reflectable.
|
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'.
|
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'.
|
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'.
|
void |
lendAppsStatsFrom(XIterator<SrvMonAppStats> val)
Sets the value of 'appsStats' by lending the values from the provided iterator.
|
void |
lendHeartbeatLoggerStats(SrvMonAppMessageLoggerStats val)
'Lends' a reference of the SrvMonAppMessageLoggerStats to the message for this field.
|
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'.
|
void |
lendPoolStatsFrom(XIterator<SrvMonPoolStats> val)
Sets the value of 'poolStats' by lending the values from the provided iterator.
|
void |
lendServerHostName(XString val)
Lends the value of 'serverHostName' to this object.
|
void |
lendServerName(XString val)
Lends the value of 'serverName' to this object.
|
void |
lendServerPid(XString val)
Lends the value of 'serverPid' to this object.
|
void |
lendSysStats(SrvMonSysStats val)
'Lends' a reference of the SrvMonSysStats to the message for this field.
|
void |
lendSystemName(XString val)
Lends the value of 'systemName' to this object.
|
void |
lendSystemVersion(XString val)
Lends the value of 'systemVersion' to this object.
|
void |
lendXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)
'Lends' a reference of the SrvMonXvmHeader to the message for this field.
|
boolean |
needsSync()
Check if a view needs to be sync'd for reflection.
|
static void |
optimizeFor(int val) |
PktPacket |
serialize()
Serialize an object's data.
|
byte[] |
serializeToByteArray()
Serialize a view's backing message to a byte array.
|
ByteBuffer |
serializeToByteBuffer()
Serialize a view's backing message to a byte buffer.
|
com.neeve.io.IOBuffer |
serializeToIOBuffer(boolean useNative)
Default implementation of
MessageView.serializeToIOBuffer(boolean) |
String |
serializeToJson()
Serialize a view's backing message to JSON.
|
PktPacket |
serializeToPacket()
Serialize a view's backing message to a packet.
|
com.google.protobuf.Message |
serializeToProtobuf()
Serialize a node's data to a proto message.
|
String |
serializeToRawJson() |
void |
setAdminClientStats(SrvMonAdminClientStats[] val)
Sets the value of 'adminClientStats'.
|
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'.
|
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'.
|
void |
setAppsStatsFrom(XIterator<SrvMonAppStats> val)
Sets the value of 'appsStats' using the values from the provided iterator.
|
void |
setAsReadOnly()
Implementation of
IRogNode.setAsReadOnly() |
void |
setCollectionEndTime(long val)
Sets the value of 'collectionEndTime'.
|
void |
setCollectionEndTimeAsObject(Long val)
Sets the value of 'collectionEndTime'.
|
void |
setCollectionEndTimeFrom(com.neeve.xbuf.XbufVariableLongField val) |
void |
setCollectionStartTime(long val)
Sets the value of 'collectionStartTime'.
|
void |
setCollectionStartTimeAsObject(Long val)
Sets the value of 'collectionStartTime'.
|
void |
setCollectionStartTimeFrom(com.neeve.xbuf.XbufVariableLongField val) |
void |
setCollectionStartWallTime(long val)
Sets the value of 'collectionStartWallTime'.
|
void |
setCollectionStartWallTimeAsObject(Long val)
Sets the value of 'collectionStartWallTime'.
|
void |
setCollectionStartWallTimeFrom(com.neeve.xbuf.XbufVariableLongField val) |
static void |
setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val) |
static void |
setFieldInterest(List<Integer> fieldIds) |
IStoreObject |
setFieldValue(int id,
Object val) |
void |
setHeartbeatLoggerStats(SrvMonAppMessageLoggerStats val)
Sets the value of 'heartbeatLoggerStats'.
|
void |
setLoadedTime(Date val)
Sets the value of 'loadedTime'.
|
void |
setLoadedTimeAsInstant(Instant val)
Sets the date value as a java.time.Instant.
|
void |
setLoadedTimeAsTimestamp(long val)
Sets the date value as a timestamp.
|
void |
setLoadedTimeFrom(com.neeve.xbuf.XbufVariableDateField val) |
void |
setPoolStats(SrvMonPoolStats[] val)
Sets the value of 'poolStats'.
|
void |
setPoolStatsFrom(XIterator<SrvMonPoolStats> val)
Sets the value of 'poolStats' using the values from the provided iterator.
|
void |
setPreserializedFields(PktBuffer buffer) |
void |
setServerHostName(String val)
Sets the value of 'serverHostName'.
|
void |
setServerHostNameFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setServerHostNameFrom(com.neeve.xbuf.XbufStringField val) |
void |
setServerHostNameFrom(XString val)
Copies the provided XString value into this object's 'serverHostName'.
|
void |
setServerName(String val)
Sets the value of 'serverName'.
|
void |
setServerNameFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setServerNameFrom(com.neeve.xbuf.XbufStringField val) |
void |
setServerNameFrom(XString val)
Copies the provided XString value into this object's 'serverName'.
|
void |
setServerPid(String val)
Sets the value of 'serverPid'.
|
void |
setServerPidFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setServerPidFrom(com.neeve.xbuf.XbufStringField val) |
void |
setServerPidFrom(XString val)
Copies the provided XString value into this object's 'serverPid'.
|
void |
setSysStats(SrvMonSysStats val)
Sets the value of 'sysStats'.
|
void |
setSystemName(String val)
Sets the value of 'systemName'.
|
void |
setSystemNameFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setSystemNameFrom(com.neeve.xbuf.XbufStringField val) |
void |
setSystemNameFrom(XString val)
Copies the provided XString value into this object's 'systemName'.
|
void |
setSystemVersion(String val)
Sets the value of 'systemVersion'.
|
void |
setSystemVersionFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setSystemVersionFrom(com.neeve.xbuf.XbufStringField val) |
void |
setSystemVersionFrom(XString val)
Copies the provided XString value into this object's 'systemVersion'.
|
void |
setXRogType(short val) |
void |
setXRogTypeAsObject(Short val) |
void |
setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val) |
void |
setXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)
Sets the value of 'xvmHeader'.
|
void |
sync()
Ensure a view's backing message is prepared and ready for transport
|
void |
syncFieldBitmask() |
SrvMonAdminClientStats[] |
takeAdminClientStats()
Takes the value of 'adminClientStats'.
|
SrvMonAppInfo[] |
takeAppsInfo()
Takes the value of 'appsInfo'.
|
SrvMonAppStats[] |
takeAppsStats()
Takes the value of 'appsStats'.
|
SrvMonAppMessageLoggerStats |
takeHeartbeatLoggerStats()
'Takes' a reference to the heartbeatLoggerStats field from the message.
|
SrvMonPoolStats[] |
takePoolStats()
Takes the value of 'poolStats'.
|
SrvMonSysStats |
takeSysStats()
'Takes' a reference to the sysStats field from the message.
|
com.neeve.server.mon.common.SrvMonXvmHeader |
takeXvmHeader()
'Takes' a reference to the xvmHeader field from the message.
|
String |
toJsonString()
Get a JSON representation of an ROG entity
|
String |
toJsonString(boolean includeMetadata,
String metadataObjectName,
String payloadObjectName)
Get a full JSON representation of an ROG entity
|
String |
toString()
Return a string representation of an ROG node.
|
void |
undispose(com.eaio.uuid.UUID id)
Recuscitate a disposed node.
|
accept, deserializeMetadata, deserializeMetadata, dump, ensureId, getAppSendBeginTs, getAppSendDoneTs, getAttachment, getBinding, getCheckpointVersion, getCommittedDataSize, getCreateTs, getEnqueueTs, getEnqueueTsMicros, getFields, getGraphId, getId, getInMsgsInTransaction, getIsInboundMessage, getIsInternal, getIsLastTransaction, getIsLiveInboundMessage, getIsMessage, getIsOutboundMessage, getIsPriority, getIsReadOnly, getIsReplayedMessage, getMessageBus, getMessageBusAsRaw, getMessageChannel, getMessageChannelAsRaw, getMessageFlow, getMessageKey, getMessageKeyAsRaw, getMessageReflector, getMessageSender, getMessageSequenceNumber, getMessageTransportHeaders, getMetadata, getOfid, getOriginTs, getOutMsgsInTransaction, getOutTs, getOutTsMicros, getParent, getParentId, getPoolingListener, getPostDeserializeTs, getPostProcessingTs, getPostProcessingTsMicros, getPostSerializeTs, getPostWireSendTs, getPostWireTs, getPreDeserializeTs, getPreProcessingTs, getPreProcessingTsMicros, getPreSerializeTs, getPreWireTs, getReceiveTs, getSendStartTs, getSendTs, getSerializedMetadataLength, getStableTransactionId, getStoreMetadata, getTransactionId, getTransactionInSequenceNumber, getTransactionOutSequenceNumber, getTypeFromJson, getValidationErrors, isPossibleDuplicate, isValid, metadataToJsonString, metadataToJsonString, metadataToString, resolveMessageKeyWith, resolveMessageKeyWith, saveMemory, serializeMetadata, setAppSendBeginTs, setAppSendDoneTs, setAsInboundMessage, setAsInternal, setAsLastTransaction, setAsMessage, setAsOutboundMessage, setAsPriority, setAsReplayedMessage, setAttachment, setBinding, setCheckpointVersion, setCommittedDataSize, setCreateTs, setEnqueueTsMicros, setFieldValue, setGraphId, setId, setInMsgsInTransaction, setMessageBus, setMessageBusAsRaw, setMessageChannel, setMessageChannelAsRaw, setMessageFlow, setMessageKey, setMessageKeyAsRaw, setMessageSender, setMessageSequenceNumber, setMessageTransportHeaders, setOriginTs, setOutMsgsInTransaction, setOutTs, setOutTsMicros, setParentId, setPoolingListener, setPossibleDuplicate, setPostDeserializeTs, setPostProcessingTs, setPostProcessingTsMicros, setPostSerializeTs, setPostWireSendTs, setPostWireTs, setPreDeserializeTs, setPreProcessingTs, setPreProcessingTsMicros, setPreSerializeTs, setPreWireTs, setReceiveTs, setSendStartTs, setSendTs, setStableTransactionId, setTransactionId, setTransactionInSequenceNumber, setTransactionOutSequenceNumberacquire, deserializeFrom, deserializeFrom, deserializeFrom, deserializeFrom, deserializeFrom, deserializeFrom, getMessage, getMessageEncodingType, getOwnershipCount, getTag, getType, getVfid, referenceTracker, serializeTo, serializeTo, serializeTo, serializeTo, serializeTo, serializeTo, setTagcount, insertAfter, insertBefore, isLinked, next, previous, unlink, wipeequals, getClass, hashCode, notify, notifyAll, wait, wait, waitdump, getAttachment, getIsLiveInboundMessage, getIsPriority, getIsReadOnly, getMetadata, getParent, getPoolingListener, getType, metadataToJsonString, setAsInboundMessage, setAsInternal, setAsLastTransaction, setAsMessage, setAsOutboundMessage, setAsPriority, setAsReplayedMessage, setAttachment, setInMsgsInTransaction, setOutMsgsInTransaction, setParentId, setPoolingListener, setTransactionInSequenceNumber, setTransactionOutSequenceNumberacquire, deserializeMetadata, deserializeMetadata, getOwnershipCount, getSerializedMetadataLength, getStoreMetadata, saveMemory, serializeMetadata, setFieldValueensureId, getBinding, getCheckpointVersion, getCommittedDataSize, getId, getOfid, getStableTransactionId, getTransactionId, setBinding, setCheckpointVersion, setCommittedDataSize, setId, setStableTransactionId, setTransactionIdgetMessageReflectorgetEnqueueTs, getEnqueueTsMicros, getGraphId, getInMsgsInTransaction, getIsInboundMessage, getIsInternal, getIsLastTransaction, getIsMessage, getIsOutboundMessage, getIsReplayedMessage, getMessageBus, getMessageChannel, getMessageFlow, getMessageKey, getMessageSender, getMessageSequenceNumber, getMessageTransportHeaders, getOutMsgsInTransaction, getOutTs, getOutTsMicros, getParentId, getPreProcessingTs, getPreProcessingTsMicros, getTransactionInSequenceNumber, getTransactionOutSequenceNumber, isPossibleDuplicate, metadataToJsonString, metadataToStringgetValidationErrors, isValidpublic static final SrvMonHeartbeatMessage[] EMPTY_ARRAY
public static SrvMonHeartbeatMessage create()
public static SrvMonHeartbeatMessage create(com.eaio.uuid.UUID id)
public static SrvMonHeartbeatMessage createFromXbufContainerPacket(PktPacket packet)
public static SrvMonHeartbeatMessage createFromSerializedXbufContainerPacket(ByteBuffer serializedPacket)
public static SrvMonHeartbeatMessage createFromSerializedXbufContainerPacket(byte[] serializedPacket)
public static SrvMonHeartbeatMessage createFromSerializedXbufContainer(ByteBuffer serializedContainer)
public static SrvMonHeartbeatMessage createFromSerializedXbufContainer(byte[] serializedContainer)
public static SrvMonHeartbeatMessage createFromRawJson(String json)
public static SrvMonHeartbeatMessage createFromJson(String json)
public static SrvMonHeartbeatMessage createFrom(ByteBuffer serializedContainer)
public static SrvMonHeartbeatMessage createFrom(byte[] serializedContainer)
public static final void setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
public static final com.neeve.xbuf.XbufDesyncPolicy getDesyncPolicy()
public final void clearContent()
public final void syncFieldBitmask()
public final void desyncFieldBitmask()
public final PktBuffer getBackingBuffer()
public static final void optimizeFor(int val)
public final PktPacket getPacket()
com.neeve.link.ILnkMessagegetPacket in interface com.neeve.link.ILnkMessagepublic final com.google.protobuf.Message serializeToProtobuf()
IRogNodeserializeToProtobuf in interface IRogNodepublic final String serializeToRawJson()
public final String serializeToJson()
MessageViewserializeToJson in interface MessageViewpublic final SrvMonHeartbeatMessage deserializeFromProtobuf(com.google.protobuf.Message message)
IRogNodedeserializeFromProtobuf in interface IRogNodemessage - The protobuf messagepublic final SrvMonHeartbeatMessage deserializeFromRawJson(String json)
public final SrvMonHeartbeatMessage deserializeFromJson(String json)
MessageViewdeserializeFromJson in interface MessageViewjson - The string containing the json serialized form of the messagepublic final void setAsReadOnly()
com.neeve.rog.impl.RogNodeIRogNode.setAsReadOnly()setAsReadOnly in interface IRogNodesetAsReadOnly in class com.neeve.rog.impl.RogNodepublic int dispose()
com.neeve.rog.impl.RogNodeIRogNode.dispose()
ROG nodes piggyback on packet pooling to perform node pooling. When this
disposed, nodes release their reference to their backing packet (if a
node is not backed by a packet, the this method does nothing and the
node is released for garbage collection). The reference release will
cause the packet to ultimately enter into its pool (if a poolable
packet type). Since nodes are tagged to packets (via TAG_ROG_ENVELOPE),
nodes implictly also get pooled. To resuscitate a disposed node, the
user should get the node from its packet and invoke RogNode.undispose(com.eaio.uuid.UUID)
dispose in interface IStoreObjectdispose in interface IRogNodedispose in interface MessageViewdispose in class com.neeve.rog.impl.RogNodepublic void undispose(com.eaio.uuid.UUID id)
com.neeve.rog.impl.RogNodeundispose in class com.neeve.rog.impl.RogNodeid - The resuscitated node's id.
This method should be called to resuscitate a disposed node. Since the caller must release all references to a disposed node, the only place a disposed node can be obtained from is its pooled backing packet container. Upon retrieving a packet from a pool, the user should obtain the node from the TAG_ROG_ENVELOPE packet tag. If the tag is non-null, then it refers to an ROG node object. The user should invoke this method on the node before using the node.
public final void setPreserializedFields(PktBuffer buffer)
public static final int getXRogTypeFieldId()
public final void setXRogType(short val)
public final void setXRogTypeAsObject(Short val)
public final short getXRogType()
public final Short getXRogTypeAsObject()
public final void setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)
public final com.neeve.xbuf.XbufVariableShortField getXRogTypeField()
public final boolean hasXRogType()
public final void clearXRogType()
public static final int getCollectionStartWallTimeFieldId()
public final void setCollectionStartWallTime(long val)
ISrvMonHeartbeatMessagesetCollectionStartWallTime in interface ISrvMonHeartbeatMessageval - The value to set.public final void setCollectionStartWallTimeAsObject(Long val)
ISrvMonHeartbeatMessagesetCollectionStartWallTimeAsObject in interface ISrvMonHeartbeatMessageval - The value to set.public final long getCollectionStartWallTime()
ISrvMonHeartbeatMessagegetCollectionStartWallTime in interface ISrvMonHeartbeatMessagepublic final Long getCollectionStartWallTimeAsObject()
ISrvMonHeartbeatMessagegetCollectionStartWallTimeAsObject in interface ISrvMonHeartbeatMessagepublic final void setCollectionStartWallTimeFrom(com.neeve.xbuf.XbufVariableLongField val)
public final com.neeve.xbuf.XbufVariableLongField getCollectionStartWallTimeField()
public final boolean hasCollectionStartWallTime()
ISrvMonHeartbeatMessagehasCollectionStartWallTime in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.getCollectionStartWallTime()public final void clearCollectionStartWallTime()
ISrvMonHeartbeatMessageclearCollectionStartWallTime in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.setCollectionStartWallTime(long)public static final int getCollectionStartTimeFieldId()
public final void setCollectionStartTime(long val)
ISrvMonHeartbeatMessagesetCollectionStartTime in interface ISrvMonHeartbeatMessageval - The value to set.public final void setCollectionStartTimeAsObject(Long val)
ISrvMonHeartbeatMessagesetCollectionStartTimeAsObject in interface ISrvMonHeartbeatMessageval - The value to set.public final long getCollectionStartTime()
ISrvMonHeartbeatMessagegetCollectionStartTime in interface ISrvMonHeartbeatMessagepublic final Long getCollectionStartTimeAsObject()
ISrvMonHeartbeatMessagegetCollectionStartTimeAsObject in interface ISrvMonHeartbeatMessagepublic final void setCollectionStartTimeFrom(com.neeve.xbuf.XbufVariableLongField val)
public final com.neeve.xbuf.XbufVariableLongField getCollectionStartTimeField()
public final boolean hasCollectionStartTime()
ISrvMonHeartbeatMessagehasCollectionStartTime in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.getCollectionStartTime()public final void clearCollectionStartTime()
ISrvMonHeartbeatMessageclearCollectionStartTime in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.setCollectionStartTime(long)public static final int getCollectionEndTimeFieldId()
public final void setCollectionEndTime(long val)
ISrvMonHeartbeatMessagesetCollectionEndTime in interface ISrvMonHeartbeatMessageval - The value to set.public final void setCollectionEndTimeAsObject(Long val)
ISrvMonHeartbeatMessagesetCollectionEndTimeAsObject in interface ISrvMonHeartbeatMessageval - The value to set.public final long getCollectionEndTime()
ISrvMonHeartbeatMessagegetCollectionEndTime in interface ISrvMonHeartbeatMessagepublic final Long getCollectionEndTimeAsObject()
ISrvMonHeartbeatMessagegetCollectionEndTimeAsObject in interface ISrvMonHeartbeatMessagepublic final void setCollectionEndTimeFrom(com.neeve.xbuf.XbufVariableLongField val)
public final com.neeve.xbuf.XbufVariableLongField getCollectionEndTimeField()
public final boolean hasCollectionEndTime()
ISrvMonHeartbeatMessagehasCollectionEndTime in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.getCollectionEndTime()public final void clearCollectionEndTime()
ISrvMonHeartbeatMessageclearCollectionEndTime in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.setCollectionEndTime(long)public static final int getLoadedTimeFieldId()
public final void setLoadedTime(Date val)
ISrvMonHeartbeatMessagesetLoadedTime in interface ISrvMonHeartbeatMessageval - The value to set.public final Date getLoadedTime()
ISrvMonHeartbeatMessagegetLoadedTime in interface ISrvMonHeartbeatMessagepublic final void setLoadedTimeAsTimestamp(long val)
ISrvMonHeartbeatMessagesetLoadedTimeAsTimestamp in interface ISrvMonHeartbeatMessageval - The date value in milliseconds from the epochpublic final long getLoadedTimeAsTimestamp()
ISrvMonHeartbeatMessage
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, ISrvMonHeartbeatMessage.hasLoadedTime()
should be called.
getLoadedTimeAsTimestamp in interface ISrvMonHeartbeatMessagepublic final Long getLoadedTimeAsTimestampObject()
ISrvMonHeartbeatMessagegetLoadedTimeAsTimestampObject in interface ISrvMonHeartbeatMessagepublic final void setLoadedTimeAsInstant(Instant val)
ISrvMonHeartbeatMessagesetLoadedTimeAsInstant in interface ISrvMonHeartbeatMessageval - The instant valuepublic final Instant getLoadedTimeAsInstant()
ISrvMonHeartbeatMessagegetLoadedTimeAsInstant in interface ISrvMonHeartbeatMessagepublic final void setLoadedTimeFrom(com.neeve.xbuf.XbufVariableDateField val)
public final com.neeve.xbuf.XbufVariableDateField getLoadedTimeField()
public final boolean hasLoadedTime()
ISrvMonHeartbeatMessagehasLoadedTime in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.getLoadedTime()public final void clearLoadedTime()
ISrvMonHeartbeatMessageclearLoadedTime in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.setLoadedTime(Date)public static final int getXvmHeaderFieldId()
public final void setXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)
ISrvMonHeartbeatMessagesetXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeadersetXvmHeader in interface ISrvMonHeartbeatMessageval - The value to set.public final void lendXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)
ISrvMonHeartbeatMessage
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.
lendXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeaderlendXvmHeader in interface ISrvMonHeartbeatMessageval - the value to 'lend' to lend.public final com.neeve.server.mon.common.SrvMonXvmHeader getXvmHeader()
ISrvMonHeartbeatMessagegetXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeadergetXvmHeader in interface ISrvMonHeartbeatMessagepublic final void getXvmHeaderTo(com.neeve.server.mon.common.SrvMonXvmHeader to)
ISrvMonHeartbeatMessageIF the value is not set, then the contents of the provided SrvMonXvmHeader are cleared.
getXvmHeaderTo in interface com.neeve.server.mon.common.IHasSrvMonXvmHeadergetXvmHeaderTo in interface ISrvMonHeartbeatMessageto - the value to copy intoSrvMonXvmHeader.copyInto(SrvMonXvmHeader)public final com.neeve.server.mon.common.SrvMonXvmHeader takeXvmHeader()
ISrvMonHeartbeatMessage
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.
takeXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeadertakeXvmHeader in interface ISrvMonHeartbeatMessagenull if the field is not set.public final boolean hasXvmHeader()
ISrvMonHeartbeatMessagehasXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeaderhasXvmHeader in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.getXvmHeader()public final void clearXvmHeader()
ISrvMonHeartbeatMessageclearXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeaderclearXvmHeader in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.setXvmHeader(SrvMonXvmHeader)public static final int getServerNameFieldId()
public final void setServerName(String val)
ISrvMonHeartbeatMessagesetServerName in interface ISrvMonHeartbeatMessageval - The value to set.public final String getServerName()
ISrvMonHeartbeatMessagegetServerName in interface ISrvMonHeartbeatMessagepublic final void lendServerName(XString val)
ISrvMonHeartbeatMessageThis method is equivalent to setServerName 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.
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.
lendServerName in interface ISrvMonHeartbeatMessageval - The value to set.public final void setServerNameFrom(long val)
ISrvMonHeartbeatMessage
NOTE:
This is the same as calling ISrvMonHeartbeatMessage.setServerName(String).
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setServerNameFrom in interface ISrvMonHeartbeatMessagepublic final <T extends XString> T getServerNameTo(XString.Factory<T> factory)
ISrvMonHeartbeatMessage
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;
getServerNameTo in interface ISrvMonHeartbeatMessagefactory - The factory from which to get the XString to copy into and returnnull.public final void setServerNameFrom(XString val)
ISrvMonHeartbeatMessage
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than ISrvMonHeartbeatMessage.setServerName(String)
because it avoids encoding the value into a String if the given XString is already encoded.
setServerNameFrom in interface ISrvMonHeartbeatMessagepublic final void getServerNameTo(XString val)
ISrvMonHeartbeatMessage
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than ISrvMonHeartbeatMessage.getServerName() bec
because it can avoid decoding the value into an String.
getServerNameTo in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.getServerName()public final XString getServerNameUnsafe()
ISrvMonHeartbeatMessage
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.
getServerNameUnsafe in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.getServerName()public final void setServerNameFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getServerNameField()
public final boolean hasServerName()
ISrvMonHeartbeatMessagehasServerName in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.getServerName()public final void clearServerName()
ISrvMonHeartbeatMessageclearServerName in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.setServerName(String)public static final int getServerHostNameFieldId()
public final void setServerHostName(String val)
ISrvMonHeartbeatMessagesetServerHostName in interface ISrvMonHeartbeatMessageval - The value to set.public final String getServerHostName()
ISrvMonHeartbeatMessagegetServerHostName in interface ISrvMonHeartbeatMessagepublic final void lendServerHostName(XString val)
ISrvMonHeartbeatMessageThis method is equivalent to setServerHostName 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.
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.
lendServerHostName in interface ISrvMonHeartbeatMessageval - The value to set.public final void setServerHostNameFrom(long val)
ISrvMonHeartbeatMessage
NOTE:
This is the same as calling ISrvMonHeartbeatMessage.setServerHostName(String).
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setServerHostNameFrom in interface ISrvMonHeartbeatMessagepublic final <T extends XString> T getServerHostNameTo(XString.Factory<T> factory)
ISrvMonHeartbeatMessage
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;
getServerHostNameTo in interface ISrvMonHeartbeatMessagefactory - The factory from which to get the XString to copy into and returnnull.public final void setServerHostNameFrom(XString val)
ISrvMonHeartbeatMessage
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than ISrvMonHeartbeatMessage.setServerHostName(String)
because it avoids encoding the value into a String if the given XString is already encoded.
setServerHostNameFrom in interface ISrvMonHeartbeatMessagepublic final void getServerHostNameTo(XString val)
ISrvMonHeartbeatMessage
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than ISrvMonHeartbeatMessage.getServerHostName() bec
because it can avoid decoding the value into an String.
getServerHostNameTo in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.getServerHostName()public final XString getServerHostNameUnsafe()
ISrvMonHeartbeatMessage
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.
getServerHostNameUnsafe in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.getServerHostName()public final void setServerHostNameFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getServerHostNameField()
public final boolean hasServerHostName()
ISrvMonHeartbeatMessagehasServerHostName in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.getServerHostName()public final void clearServerHostName()
ISrvMonHeartbeatMessageclearServerHostName in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.setServerHostName(String)public static final int getServerPidFieldId()
public final void setServerPid(String val)
ISrvMonHeartbeatMessagesetServerPid in interface ISrvMonHeartbeatMessageval - The value to set.public final String getServerPid()
ISrvMonHeartbeatMessagegetServerPid in interface ISrvMonHeartbeatMessagepublic final void lendServerPid(XString val)
ISrvMonHeartbeatMessageThis method is equivalent to setServerPid 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.
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.
lendServerPid in interface ISrvMonHeartbeatMessageval - The value to set.public final void setServerPidFrom(long val)
ISrvMonHeartbeatMessage
NOTE:
This is the same as calling ISrvMonHeartbeatMessage.setServerPid(String).
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setServerPidFrom in interface ISrvMonHeartbeatMessagepublic final <T extends XString> T getServerPidTo(XString.Factory<T> factory)
ISrvMonHeartbeatMessage
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;
getServerPidTo in interface ISrvMonHeartbeatMessagefactory - The factory from which to get the XString to copy into and returnnull.public final void setServerPidFrom(XString val)
ISrvMonHeartbeatMessage
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than ISrvMonHeartbeatMessage.setServerPid(String)
because it avoids encoding the value into a String if the given XString is already encoded.
setServerPidFrom in interface ISrvMonHeartbeatMessagepublic final void getServerPidTo(XString val)
ISrvMonHeartbeatMessage
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than ISrvMonHeartbeatMessage.getServerPid() bec
because it can avoid decoding the value into an String.
getServerPidTo in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.getServerPid()public final XString getServerPidUnsafe()
ISrvMonHeartbeatMessage
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.
getServerPidUnsafe in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.getServerPid()public final void setServerPidFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getServerPidField()
public final boolean hasServerPid()
ISrvMonHeartbeatMessagehasServerPid in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.getServerPid()public final void clearServerPid()
ISrvMonHeartbeatMessageclearServerPid in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.setServerPid(String)public static final int getSysStatsFieldId()
public final void setSysStats(SrvMonSysStats val)
ISrvMonHeartbeatMessagesetSysStats in interface ISrvMonHeartbeatMessageval - The value to set.public final void lendSysStats(SrvMonSysStats val)
ISrvMonHeartbeatMessage
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.
lendSysStats in interface ISrvMonHeartbeatMessageval - the value to 'lend' to lend.public final SrvMonSysStats getSysStats()
ISrvMonHeartbeatMessagegetSysStats in interface ISrvMonHeartbeatMessagepublic final void getSysStatsTo(SrvMonSysStats to)
ISrvMonHeartbeatMessageIF the value is not set, then the contents of the provided SrvMonSysStats are cleared.
getSysStatsTo in interface ISrvMonHeartbeatMessageto - the value to copy intoSrvMonSysStats.copyInto(SrvMonSysStats)public final SrvMonSysStats takeSysStats()
ISrvMonHeartbeatMessage
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.
takeSysStats in interface ISrvMonHeartbeatMessagenull if the field is not set.public final boolean hasSysStats()
ISrvMonHeartbeatMessagehasSysStats in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.getSysStats()public final void clearSysStats()
ISrvMonHeartbeatMessageclearSysStats in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.setSysStats(SrvMonSysStats)public static final int getPoolStatsFieldId()
public final void setPoolStats(SrvMonPoolStats[] val)
ISrvMonHeartbeatMessagesetPoolStats in interface ISrvMonHeartbeatMessageval - The value to set.public final void setPoolStatsFrom(XIterator<SrvMonPoolStats> val)
ISrvMonHeartbeatMessage
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.
NOTE:
Passing a null or empty list has the same affect as calling ISrvMonHeartbeatMessage.setPoolStats(SrvMonPoolStats[]) with
a value of null.
setPoolStatsFrom in interface ISrvMonHeartbeatMessageval - the values to set.public final void lendPoolStatsFrom(XIterator<SrvMonPoolStats> val)
ISrvMonHeartbeatMessage
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.
NOTE:
Passing a null or empty list has the same affect as calling ISrvMonHeartbeatMessage.setPoolStats(SrvMonPoolStats[]) with
a value of null.
lendPoolStatsFrom in interface ISrvMonHeartbeatMessageval - the values to set.public final void lendPoolStats(SrvMonPoolStats[] val)
ISrvMonHeartbeatMessage
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.
lendPoolStats in interface ISrvMonHeartbeatMessageval - the value to 'lend' to lend.public final void addPoolStats(SrvMonPoolStats val)
ISrvMonHeartbeatMessageThis 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.
addPoolStats in interface ISrvMonHeartbeatMessageval - the value to add.public final void lendPoolStats(SrvMonPoolStats val)
ISrvMonHeartbeatMessageLending 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.
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.
lendPoolStats in interface ISrvMonHeartbeatMessageval - the value to add.public final SrvMonPoolStats[] getPoolStats()
ISrvMonHeartbeatMessage
If the field is not set this method will return null.
getPoolStats in interface ISrvMonHeartbeatMessagenull.public final SrvMonPoolStats[] getPoolStatsEmptyIfNull()
ISrvMonHeartbeatMessagenull or not set.
getPoolStatsEmptyIfNull in interface ISrvMonHeartbeatMessagenull if not set.ISrvMonHeartbeatMessage.getPoolStats()public final XIterator<SrvMonPoolStats> getPoolStatsIterator()
ISrvMonHeartbeatMessageThis method will always return a non null iterator value. The returned iterator is not threadsafe, and the caller may not hold on to it beyond the pooling lifespan of this object. Depending on the implementation, the same iterator instance may be returned by this object on each call to avoid garbage. Each time this method is called the iterator is reset by calling its toFirst() method. Callers should therefore be especially careful about calling this method while iterating on the iterator returned by this method.
The elements returned by this iterator are owned by and pooled along with this object. The caller must call acquire() on each returned object that it intends to keep beyond the either the next call to next(), toFirst() or the lifespace of this object as each object returned by this iterator is disposed on a subsequent call to next() or when this object is disposed.
This method is zero garbage for Xbuf generated classes, and this method is optimized such that
passing the returned iterator to another object's setXXX(XIterator
getPoolStatsIterator in interface ISrvMonHeartbeatMessagepublic final SrvMonPoolStats[] takePoolStats()
ISrvMonHeartbeatMessage
NOTE:
A nested entity reference returned by ISrvMonHeartbeatMessage.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.
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.
takePoolStats in interface ISrvMonHeartbeatMessagenull if the field is not set.public final void clearPoolStats()
ISrvMonHeartbeatMessageclearPoolStats in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.setPoolStats(SrvMonPoolStats[])public static final int getAppsInfoFieldId()
public final void setAppsInfo(SrvMonAppInfo[] val)
ISrvMonHeartbeatMessagesetAppsInfo in interface ISrvMonHeartbeatMessageval - The value to set.public final void setAppsInfoFrom(XIterator<SrvMonAppInfo> val)
ISrvMonHeartbeatMessage
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.
NOTE:
Passing a null or empty list has the same affect as calling ISrvMonHeartbeatMessage.setAppsInfo(SrvMonAppInfo[]) with
a value of null.
setAppsInfoFrom in interface ISrvMonHeartbeatMessageval - the values to set.public final void lendAppsInfoFrom(XIterator<SrvMonAppInfo> val)
ISrvMonHeartbeatMessage
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.
NOTE:
Passing a null or empty list has the same affect as calling ISrvMonHeartbeatMessage.setAppsInfo(SrvMonAppInfo[]) with
a value of null.
lendAppsInfoFrom in interface ISrvMonHeartbeatMessageval - the values to set.public final void lendAppsInfo(SrvMonAppInfo[] val)
ISrvMonHeartbeatMessage
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.
lendAppsInfo in interface ISrvMonHeartbeatMessageval - the value to 'lend' to lend.public final void addAppsInfo(SrvMonAppInfo val)
ISrvMonHeartbeatMessageThis 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.
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.
addAppsInfo in interface ISrvMonHeartbeatMessageval - the value to add.public final void lendAppsInfo(SrvMonAppInfo val)
ISrvMonHeartbeatMessageLending 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.
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.
lendAppsInfo in interface ISrvMonHeartbeatMessageval - the value to add.public final SrvMonAppInfo[] getAppsInfo()
ISrvMonHeartbeatMessage
If the field is not set this method will return null.
getAppsInfo in interface ISrvMonHeartbeatMessagenull.public final SrvMonAppInfo[] getAppsInfoEmptyIfNull()
ISrvMonHeartbeatMessagenull or not set.
getAppsInfoEmptyIfNull in interface ISrvMonHeartbeatMessagenull if not set.ISrvMonHeartbeatMessage.getAppsInfo()public final XIterator<SrvMonAppInfo> getAppsInfoIterator()
ISrvMonHeartbeatMessageThis method will always return a non null iterator value. The returned iterator is not threadsafe, and the caller may not hold on to it beyond the pooling lifespan of this object. Depending on the implementation, the same iterator instance may be returned by this object on each call to avoid garbage. Each time this method is called the iterator is reset by calling its toFirst() method. Callers should therefore be especially careful about calling this method while iterating on the iterator returned by this method.
The elements returned by this iterator are owned by and pooled along with this object. The caller must call acquire() on each returned object that it intends to keep beyond the either the next call to next(), toFirst() or the lifespace of this object as each object returned by this iterator is disposed on a subsequent call to next() or when this object is disposed.
This method is zero garbage for Xbuf generated classes, and this method is optimized such that
passing the returned iterator to another object's setXXX(XIterator
getAppsInfoIterator in interface ISrvMonHeartbeatMessagepublic final SrvMonAppInfo[] takeAppsInfo()
ISrvMonHeartbeatMessage
NOTE:
A nested entity reference returned by ISrvMonHeartbeatMessage.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.
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.
takeAppsInfo in interface ISrvMonHeartbeatMessagenull if the field is not set.public final void clearAppsInfo()
ISrvMonHeartbeatMessageclearAppsInfo in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.setAppsInfo(SrvMonAppInfo[])public static final int getAppsStatsFieldId()
public final void setAppsStats(SrvMonAppStats[] val)
ISrvMonHeartbeatMessagesetAppsStats in interface ISrvMonHeartbeatMessageval - The value to set.public final void setAppsStatsFrom(XIterator<SrvMonAppStats> val)
ISrvMonHeartbeatMessage
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.
NOTE:
Passing a null or empty list has the same affect as calling ISrvMonHeartbeatMessage.setAppsStats(SrvMonAppStats[]) with
a value of null.
setAppsStatsFrom in interface ISrvMonHeartbeatMessageval - the values to set.public final void lendAppsStatsFrom(XIterator<SrvMonAppStats> val)
ISrvMonHeartbeatMessage
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.
NOTE:
Passing a null or empty list has the same affect as calling ISrvMonHeartbeatMessage.setAppsStats(SrvMonAppStats[]) with
a value of null.
lendAppsStatsFrom in interface ISrvMonHeartbeatMessageval - the values to set.public final void lendAppsStats(SrvMonAppStats[] val)
ISrvMonHeartbeatMessage
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.
lendAppsStats in interface ISrvMonHeartbeatMessageval - the value to 'lend' to lend.public final void addAppsStats(SrvMonAppStats val)
ISrvMonHeartbeatMessageThis 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.
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.
addAppsStats in interface ISrvMonHeartbeatMessageval - the value to add.public final void lendAppsStats(SrvMonAppStats val)
ISrvMonHeartbeatMessageLending 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.
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.
lendAppsStats in interface ISrvMonHeartbeatMessageval - the value to add.public final SrvMonAppStats[] getAppsStats()
ISrvMonHeartbeatMessage
If the field is not set this method will return null.
getAppsStats in interface ISrvMonHeartbeatMessagenull.public final SrvMonAppStats[] getAppsStatsEmptyIfNull()
ISrvMonHeartbeatMessagenull or not set.
getAppsStatsEmptyIfNull in interface ISrvMonHeartbeatMessagenull if not set.ISrvMonHeartbeatMessage.getAppsStats()public final XIterator<SrvMonAppStats> getAppsStatsIterator()
ISrvMonHeartbeatMessageThis method will always return a non null iterator value. The returned iterator is not threadsafe, and the caller may not hold on to it beyond the pooling lifespan of this object. Depending on the implementation, the same iterator instance may be returned by this object on each call to avoid garbage. Each time this method is called the iterator is reset by calling its toFirst() method. Callers should therefore be especially careful about calling this method while iterating on the iterator returned by this method.
The elements returned by this iterator are owned by and pooled along with this object. The caller must call acquire() on each returned object that it intends to keep beyond the either the next call to next(), toFirst() or the lifespace of this object as each object returned by this iterator is disposed on a subsequent call to next() or when this object is disposed.
This method is zero garbage for Xbuf generated classes, and this method is optimized such that
passing the returned iterator to another object's setXXX(XIterator
getAppsStatsIterator in interface ISrvMonHeartbeatMessagepublic final SrvMonAppStats[] takeAppsStats()
ISrvMonHeartbeatMessage
NOTE:
A nested entity reference returned by ISrvMonHeartbeatMessage.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.
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.
takeAppsStats in interface ISrvMonHeartbeatMessagenull if the field is not set.public final void clearAppsStats()
ISrvMonHeartbeatMessageclearAppsStats in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.setAppsStats(SrvMonAppStats[])public static final int getAdminClientStatsFieldId()
public final void setAdminClientStats(SrvMonAdminClientStats[] val)
ISrvMonHeartbeatMessagesetAdminClientStats in interface ISrvMonHeartbeatMessageval - The value to set.public final void setAdminClientStatsFrom(XIterator<SrvMonAdminClientStats> val)
ISrvMonHeartbeatMessage
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.
NOTE:
Passing a null or empty list has the same affect as calling ISrvMonHeartbeatMessage.setAdminClientStats(SrvMonAdminClientStats[]) with
a value of null.
setAdminClientStatsFrom in interface ISrvMonHeartbeatMessageval - the values to set.public final void lendAdminClientStatsFrom(XIterator<SrvMonAdminClientStats> val)
ISrvMonHeartbeatMessage
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 'adminClientStats' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling ISrvMonHeartbeatMessage.setAdminClientStats(SrvMonAdminClientStats[]) with
a value of null.
lendAdminClientStatsFrom in interface ISrvMonHeartbeatMessageval - the values to set.public final void lendAdminClientStats(SrvMonAdminClientStats[] val)
ISrvMonHeartbeatMessage
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.
lendAdminClientStats in interface ISrvMonHeartbeatMessageval - the value to 'lend' to lend.public final void addAdminClientStats(SrvMonAdminClientStats val)
ISrvMonHeartbeatMessageThis 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.
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.
addAdminClientStats in interface ISrvMonHeartbeatMessageval - the value to add.public final void lendAdminClientStats(SrvMonAdminClientStats val)
ISrvMonHeartbeatMessageLending 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 'adminClientStats' 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.
lendAdminClientStats in interface ISrvMonHeartbeatMessageval - the value to add.public final SrvMonAdminClientStats[] getAdminClientStats()
ISrvMonHeartbeatMessage
If the field is not set this method will return null.
getAdminClientStats in interface ISrvMonHeartbeatMessagenull.public final SrvMonAdminClientStats[] getAdminClientStatsEmptyIfNull()
ISrvMonHeartbeatMessagenull or not set.
getAdminClientStatsEmptyIfNull in interface ISrvMonHeartbeatMessagenull if not set.ISrvMonHeartbeatMessage.getAdminClientStats()public final XIterator<SrvMonAdminClientStats> getAdminClientStatsIterator()
ISrvMonHeartbeatMessageThis method will always return a non null iterator value. The returned iterator is not threadsafe, and the caller may not hold on to it beyond the pooling lifespan of this object. Depending on the implementation, the same iterator instance may be returned by this object on each call to avoid garbage. Each time this method is called the iterator is reset by calling its toFirst() method. Callers should therefore be especially careful about calling this method while iterating on the iterator returned by this method.
The elements returned by this iterator are owned by and pooled along with this object. The caller must call acquire() on each returned object that it intends to keep beyond the either the next call to next(), toFirst() or the lifespace of this object as each object returned by this iterator is disposed on a subsequent call to next() or when this object is disposed.
This method is zero garbage for Xbuf generated classes, and this method is optimized such that
passing the returned iterator to another object's setXXX(XIterator
getAdminClientStatsIterator in interface ISrvMonHeartbeatMessagepublic final SrvMonAdminClientStats[] takeAdminClientStats()
ISrvMonHeartbeatMessage
NOTE:
A nested entity reference returned by ISrvMonHeartbeatMessage.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.
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.
takeAdminClientStats in interface ISrvMonHeartbeatMessagenull if the field is not set.public final void clearAdminClientStats()
ISrvMonHeartbeatMessageclearAdminClientStats in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.setAdminClientStats(SrvMonAdminClientStats[])public static final int getSystemNameFieldId()
public final void setSystemName(String val)
ISrvMonHeartbeatMessagesetSystemName in interface ISrvMonHeartbeatMessageval - The value to set.public final String getSystemName()
ISrvMonHeartbeatMessagegetSystemName in interface ISrvMonHeartbeatMessagepublic final void lendSystemName(XString val)
ISrvMonHeartbeatMessageThis method is equivalent to setSystemName 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.
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.
lendSystemName in interface ISrvMonHeartbeatMessageval - The value to set.public final void setSystemNameFrom(long val)
ISrvMonHeartbeatMessage
NOTE:
This is the same as calling ISrvMonHeartbeatMessage.setSystemName(String).
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setSystemNameFrom in interface ISrvMonHeartbeatMessagepublic final <T extends XString> T getSystemNameTo(XString.Factory<T> factory)
ISrvMonHeartbeatMessage
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;
getSystemNameTo in interface ISrvMonHeartbeatMessagefactory - The factory from which to get the XString to copy into and returnnull.public final void setSystemNameFrom(XString val)
ISrvMonHeartbeatMessage
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than ISrvMonHeartbeatMessage.setSystemName(String)
because it avoids encoding the value into a String if the given XString is already encoded.
setSystemNameFrom in interface ISrvMonHeartbeatMessagepublic final void getSystemNameTo(XString val)
ISrvMonHeartbeatMessage
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than ISrvMonHeartbeatMessage.getSystemName() bec
because it can avoid decoding the value into an String.
getSystemNameTo in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.getSystemName()public final XString getSystemNameUnsafe()
ISrvMonHeartbeatMessage
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.
getSystemNameUnsafe in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.getSystemName()public final void setSystemNameFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getSystemNameField()
public final boolean hasSystemName()
ISrvMonHeartbeatMessagehasSystemName in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.getSystemName()public final void clearSystemName()
ISrvMonHeartbeatMessageclearSystemName in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.setSystemName(String)public static final int getSystemVersionFieldId()
public final void setSystemVersion(String val)
ISrvMonHeartbeatMessagesetSystemVersion in interface ISrvMonHeartbeatMessageval - The value to set.public final String getSystemVersion()
ISrvMonHeartbeatMessagegetSystemVersion in interface ISrvMonHeartbeatMessagepublic final void lendSystemVersion(XString val)
ISrvMonHeartbeatMessageThis method is equivalent to setSystemVersion 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.
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.
lendSystemVersion in interface ISrvMonHeartbeatMessageval - The value to set.public final void setSystemVersionFrom(long val)
ISrvMonHeartbeatMessage
NOTE:
This is the same as calling ISrvMonHeartbeatMessage.setSystemVersion(String).
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setSystemVersionFrom in interface ISrvMonHeartbeatMessagepublic final <T extends XString> T getSystemVersionTo(XString.Factory<T> factory)
ISrvMonHeartbeatMessage
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;
getSystemVersionTo in interface ISrvMonHeartbeatMessagefactory - The factory from which to get the XString to copy into and returnnull.public final void setSystemVersionFrom(XString val)
ISrvMonHeartbeatMessage
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than ISrvMonHeartbeatMessage.setSystemVersion(String)
because it avoids encoding the value into a String if the given XString is already encoded.
setSystemVersionFrom in interface ISrvMonHeartbeatMessagepublic final void getSystemVersionTo(XString val)
ISrvMonHeartbeatMessage
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than ISrvMonHeartbeatMessage.getSystemVersion() bec
because it can avoid decoding the value into an String.
getSystemVersionTo in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.getSystemVersion()public final XString getSystemVersionUnsafe()
ISrvMonHeartbeatMessage
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.
getSystemVersionUnsafe in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.getSystemVersion()public final void setSystemVersionFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getSystemVersionField()
public final boolean hasSystemVersion()
ISrvMonHeartbeatMessagehasSystemVersion in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.getSystemVersion()public final void clearSystemVersion()
ISrvMonHeartbeatMessageclearSystemVersion in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.setSystemVersion(String)public static final int getHeartbeatLoggerStatsFieldId()
public final void setHeartbeatLoggerStats(SrvMonAppMessageLoggerStats val)
ISrvMonHeartbeatMessagesetHeartbeatLoggerStats in interface ISrvMonHeartbeatMessageval - The value to set.public final void lendHeartbeatLoggerStats(SrvMonAppMessageLoggerStats val)
ISrvMonHeartbeatMessage
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.
lendHeartbeatLoggerStats in interface ISrvMonHeartbeatMessageval - the value to 'lend' to lend.public final SrvMonAppMessageLoggerStats getHeartbeatLoggerStats()
ISrvMonHeartbeatMessagegetHeartbeatLoggerStats in interface ISrvMonHeartbeatMessagepublic final void getHeartbeatLoggerStatsTo(SrvMonAppMessageLoggerStats to)
ISrvMonHeartbeatMessageIF the value is not set, then the contents of the provided SrvMonAppMessageLoggerStats are cleared.
getHeartbeatLoggerStatsTo in interface ISrvMonHeartbeatMessageto - the value to copy intoSrvMonAppMessageLoggerStats.copyInto(SrvMonAppMessageLoggerStats)public final SrvMonAppMessageLoggerStats takeHeartbeatLoggerStats()
ISrvMonHeartbeatMessage
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.
takeHeartbeatLoggerStats in interface ISrvMonHeartbeatMessagenull if the field is not set.public final boolean hasHeartbeatLoggerStats()
ISrvMonHeartbeatMessagehasHeartbeatLoggerStats in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.getHeartbeatLoggerStats()public final void clearHeartbeatLoggerStats()
ISrvMonHeartbeatMessageclearHeartbeatLoggerStats in interface ISrvMonHeartbeatMessageISrvMonHeartbeatMessage.setHeartbeatLoggerStats(SrvMonAppMessageLoggerStats)public final boolean isDirty()
public static final com.neeve.xbuf.XbufSchema createSchema()
public final byte[] serializeToByteArray()
MessageViewserializeToByteArray in interface MessageViewpublic final ByteBuffer serializeToByteBuffer()
MessageViewserializeToByteBuffer in interface MessageViewpublic final com.neeve.io.IOBuffer serializeToIOBuffer(boolean useNative)
MessageViewImplMessageView.serializeToIOBuffer(boolean)serializeToIOBuffer in interface MessageViewserializeToIOBuffer in class MessageViewImpluseNative - Whether the returned buffer should be native.public final PktPacket serializeToPacket()
MessageViewserializeToPacket in interface MessageViewpublic final SrvMonHeartbeatMessage deserializeFromByteArray(byte[] array)
MessageViewdeserializeFromByteArray in interface MessageViewarray - The array containing the serialized messagepublic final SrvMonHeartbeatMessage deserializeFromByteBuffer(ByteBuffer buffer)
MessageViewdeserializeFromByteBuffer in interface MessageViewbuffer - The buffer containing the serialized messagepublic final SrvMonHeartbeatMessage deserializeFromPacket(PktPacket packet)
MessageViewdeserializeFromPacket in interface MessageViewpacket - The packet containing the serialized messagepublic final void sync()
MessageViewsync in interface MessageViewpublic final SrvMonHeartbeatMessage copy()
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.
copy in interface IRogCopyableNode<ISrvMonHeartbeatMessage>copy in interface ISrvMonHeartbeatMessagecopy in interface CopyableMessageView<ISrvMonHeartbeatMessage>IRogCopyableNode,
CopyableMessageViewpublic final void copyInto(SrvMonHeartbeatMessage copy)
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.
copyInto in interface ISrvMonHeartbeatMessagecopy - The target to copy into which must not be null or read only.public final int desync(PktBuffer buffer, int pos, boolean frameOnly)
com.neeve.xbuf.IXbufDesyncerdesync in interface com.neeve.xbuf.IXbufDesyncerbuffer - The buffer to desync frompos - The position in the container's backing buffer to desync
fromframeOnly - Whether to frame the field on the underlying buffer.
See XbufField.desync(PktBuffer, int, boolean) for more
informationpublic boolean needsSync()
MessageReflectorneedsSync in interface MessageReflectorpublic final boolean fieldExists(Object message, String name)
MessageReflectorfieldExists in interface MessageReflectormessage - The message to check in.name - The field to check for.public final boolean isFieldReflectable(Object message, String name)
MessageReflectorisFieldReflectable in interface MessageReflectormessage - The message to check in.name - The field to check for.public final String getFieldValueAsString(Object message, String name)
MessageReflector
Note that this method is generally less efficient than its variant
MessageReflector.getFieldValueAsString(Object, String[]) since this method requires
splitting the supplied path name into its dot separated path components. In cases
where the caller intends to reuse the same path name often, it is better
for the caller to supply it in split form.
getFieldValueAsString in interface MessageReflectormessage - The message to introspect.name - The field whose value is to be retrieved specified as a bean pathMessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methodspublic final String getFieldValueAsString(Object message, String[] pathComponents)
MessageReflectorgetFieldValueAsString in interface MessageReflectormessage - The message to introspect.pathComponents - The path components to use to access the field.MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methodspublic final XString getFieldValueAsRawString(Object message, String name)
MessageReflector
Note that this method is generally less efficient than its variant
MessageReflector.getFieldValueAsString(Object, String[]) since this method requires
splitting the supplied path name into its dot separated path components. In cases
where the caller intends to reuse the same path name often, it is better
for the caller to supply it in split form.
getFieldValueAsRawString in interface MessageReflectormessage - The message to introspect.name - The field whose value is to be retrieved specified as a bean pathMessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methodspublic final XString getFieldValueAsRawString(Object message, String[] pathComponents)
MessageReflectorgetFieldValueAsRawString in interface MessageReflectormessage - The message to introspect.pathComponents - The path components to use to access the field.MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methodspublic final boolean appendFieldValueTo(Object message, String name, XString target)
com.neeve.rog.impl.RogNode
If this node has a non-null messageReflector as returned by RogNode.getMessageReflector(),
then this method will use that reflector to append the value of the field provided by
it if the field is reflectable and not null.
appendFieldValueTo in interface MessageReflectorappendFieldValueTo in class com.neeve.rog.impl.RogNodemessage - the node on which to reflect (which need not be this object).name - the bean path to the field on the provided object.target - The target XString into which to append the result.public final boolean appendFieldValueTo(Object node, String[] pathComponents, XString target)
com.neeve.rog.impl.RogNode
If this node has a non-null messageReflector as returned by RogNode.getMessageReflector(),
then this method will use that reflector to append the value of the field provided by
it if the field is reflectable and not null.
appendFieldValueTo in interface MessageReflectorappendFieldValueTo in class com.neeve.rog.impl.RogNodenode - the node on which to reflect (which need not be this object).pathComponents - the bean path to the field on the provided object split by its '.' separated components. .target - The target XString into which to append the result.public final IStoreObject.EncodingType getContentEncodingType()
IStoreObjectgetContentEncodingType in interface IStoreObjectpublic final PktPacket serialize()
IStoreObjectserialize in interface IStoreObjectpublic final SrvMonHeartbeatMessage deserialize(PktPacket packet)
IStoreObjectdeserialize in interface IStoreObjectpacket - The object in serialized form.public final IStoreObject setFieldValue(int id, Object val)
public final String toJsonString(boolean includeMetadata, String metadataObjectName, String payloadObjectName)
IRogJsonizabletoJsonString in interface IRogJsonizableincludeMetadata - Specify this parameter for the ROG entity
metadata to also be included in the JSON output. If included, the
entire ROG entity object is treated as a composite object containing
a nested metadata object and a nested data object. The next two
parameters metadataObjectName and dataObjectName
specify the names of the nested objects as they will appear in
the output JSON string.metadataObjectName - The name of the nested metadata object
as it will appear in the output JSON string. A value of null will
default to using 'metadata' as the nested object name.payloadObjectName - The name of the nested data object as it
will appear in the output JSON string. A value of null will default
to using 'data' as the nested object name.public final String toJsonString()
IRogJsonizabletoJsonString in interface IRogJsonizablepublic final String toString()
com.neeve.rog.impl.RogNodetoString in class com.neeve.rog.impl.RogNodeCopyright © 2019 Neeve Research, LLC. All Rights Reserved.