com.neeve.server.mon
Class SrvMonHeartbeatMessage

java.lang.Object
  com.neeve.util.UtlListElement
      com.neeve.sma.MessageViewImpl
          com.neeve.rog.impl.RogNode
              com.neeve.server.mon.SrvMonHeartbeatMessage

All Implemented Interfaces:

com.neeve.link.ILnkMessage, IStoreObject, IRogCopyableNode<ISrvMonHeartbeatMessage>, IRogJsonizable, IRogMessage, IRogMetadata, IRogNode, IRogValidatable, ISrvMonHeartbeatMessage, CopyableMessageView<ISrvMonHeartbeatMessage>, MapMessageView, MessageReflector, MessageView, UtlReferenceTracker.HasReferenceTracker, com.neeve.xbuf.IXbufDesyncer

@Generated(value="com.neeve.adm.AdmXbufGenerator",
           date="Wed Mar 28 10:54:31 EDT 2018")
@AdmGenerated(encoding="Xbuf",
              compatLevel="3.8.0",
              admVersion="nvx-adm v3.7.265 (build 0)",
              date="3/28/18 10:54 AM",
              buildInfo="nvx-talon-3.7.265 (nvx-codegen-plugin)")
@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

Talon Server Heartbeat

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

Nested Class Summary

static class

SrvMonHeartbeatMessage.PacketBody The backing packet type for SrvMonHeartbeatMessage (used internally for serialization purposes).

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

IRogNode.PoolingListener

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

IStoreObject.EncodingType

Field Summary

static SrvMonHeartbeatMessage[]

EMPTY_ARRAY A preallocated empty array used to avoid garbage when returning empty arrays of this type.

Fields inherited from class com.neeve.rog.impl.RogNode

DATE_FORMAT

Fields inherited from class com.neeve.util.UtlListElement

count, head, next, prev

Method Summary

void	addAdminClientStats(SrvMonAdminClientStats val) Adds the provided value to the list of 'adminClientStats' values.
void	addAppsInfo(SrvMonAppInfo val) Adds the provided value to the list of 'appsInfo' values.
void	addAppsStats(SrvMonAppStats val) Adds the provided value to the list of 'appsStats' values.
void	addPoolStats(SrvMonPoolStats val) Adds the provided value to the list of 'poolStats' values.
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' Field Description Collects stats related to the admin client connections
void	clearAppsInfo() Clears the value of 'appsInfo' Field Description Information about the apps configured for this server
void	clearAppsStats() Clears the value of 'appsStats' Field Description Platform and user stats for loaded applications
void	clearCollectionEndTime() Clears the value of 'collectionEndTime' Field Description The collection end time in nanoseconds (e.g.
void	clearCollectionStartTime() Clears the value of 'collectionStartTime' Field Description The collection start time in nanoseconds (e.g.
void	clearCollectionStartWallTime() Clears the value of 'collectionStartWallTime' Field Description The collection start time in milliseconds since the Epoch (e.g.
void	clearContent()
void	clearLoadedTime() Clears the value of 'loadedTime' Field Description The time at which the server loaded
void	clearPoolStats() Clears the value of 'poolStats' Field Description Collects process wide pooling stats
void	clearServerHostName() Clears the value of 'serverHostName' Field Description The server's hostname
void	clearServerName() Clears the value of 'serverName' Field Description The name of the server
void	clearServerPid() Clears the value of 'serverPid' Field Description The server process id
void	clearSysStats() Clears the value of 'sysStats' Field Description Collects System System level stats such process or memory usage.
void	clearSystemName() Clears the value of 'systemName' Field Description The name of the system to which the server belongs.
void	clearSystemVersion() Clears the value of 'systemVersion' Field Description The version of the system to which the server belongs.
void	clearXRogType()
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)
void	desyncFieldBitmask()
int	dispose() Default implementation of MessageView.dispose() This is the default implementation of the dispose method.
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' If the field is not set this method will return null.
SrvMonAdminClientStats[]	getAdminClientStatsEmptyIfNull() Gets the value of 'adminClientStats' or an empty array if the value is null or not set.
static int	getAdminClientStatsFieldId() Get the field id for 'adminClientStats' This method can be used to set field interests.
XIterator<SrvMonAdminClientStats>	getAdminClientStatsIterator() Gets the value of 'adminClientStats' as iterator of values.
SrvMonAppInfo[]	getAppsInfo() Gets the value of 'appsInfo' If the field is not set this method will return null.
SrvMonAppInfo[]	getAppsInfoEmptyIfNull() Gets the value of 'appsInfo' or an empty array if the value is null or not set.
static int	getAppsInfoFieldId() Get the field id for 'appsInfo' This method can be used to set field interests.
XIterator<SrvMonAppInfo>	getAppsInfoIterator() Gets the value of 'appsInfo' as iterator of values.
SrvMonAppStats[]	getAppsStats() Gets the value of 'appsStats' If the field is not set this method will return null.
SrvMonAppStats[]	getAppsStatsEmptyIfNull() Gets the value of 'appsStats' or an empty array if the value is null or not set.
static int	getAppsStatsFieldId() Get the field id for 'appsStats' This method can be used to set field interests.
XIterator<SrvMonAppStats>	getAppsStatsIterator() Gets the value of 'appsStats' as iterator of values.
PktBuffer	getBackingBuffer()
long	getCollectionEndTime() Gets the value of 'collectionEndTime' Field Description The collection end time in nanoseconds (e.g.
com.neeve.xbuf.XbufVariableLongField	getCollectionEndTimeField()
static int	getCollectionEndTimeFieldId() Get the field id for 'collectionEndTime' This method can be used to set field interests.
long	getCollectionStartTime() Gets the value of 'collectionStartTime' Field Description The collection start time in nanoseconds (e.g.
com.neeve.xbuf.XbufVariableLongField	getCollectionStartTimeField()
static int	getCollectionStartTimeFieldId() Get the field id for 'collectionStartTime' This method can be used to set field interests.
long	getCollectionStartWallTime() Gets the value of 'collectionStartWallTime' Field Description The collection start time in milliseconds since the Epoch (e.g.
com.neeve.xbuf.XbufVariableLongField	getCollectionStartWallTimeField()
static int	getCollectionStartWallTimeFieldId() Get the field id for 'collectionStartWallTime' This method can be used to set field interests.
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.
Date	getLoadedTime() Gets the value of 'loadedTime' Field Description The time at which the server loaded
long	getLoadedTimeAsTimestamp() Retrieves the date as a timestamp (a zero garbage operation for XBuf encoding).
com.neeve.xbuf.XbufVariableDateField	getLoadedTimeField()
static int	getLoadedTimeFieldId() Get the field id for 'loadedTime' This method can be used to set field interests.
PktPacket	getPacket()
SrvMonPoolStats[]	getPoolStats() Gets the value of 'poolStats' If the field is not set this method will return null.
SrvMonPoolStats[]	getPoolStatsEmptyIfNull() Gets the value of 'poolStats' or an empty array if the value is null or not set.
static int	getPoolStatsFieldId() Get the field id for 'poolStats' This method can be used to set field interests.
XIterator<SrvMonPoolStats>	getPoolStatsIterator() Gets the value of 'poolStats' as iterator of values.
String	getServerHostName() Gets the value of 'serverHostName' Field Description The server's hostname
com.neeve.xbuf.XbufStringField	getServerHostNameField()
static int	getServerHostNameFieldId() Get the field id for 'serverHostName' This method can be used to set field interests.
<T extends XString> T	getServerHostNameTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getServerHostNameTo(XString val) Copies the value of 'serverHostName' into the provided XString.
XString	getServerHostNameUnsafe() Gets the raw value of 'serverHostName'.
String	getServerName() Gets the value of 'serverName' Field Description The name of the server
com.neeve.xbuf.XbufStringField	getServerNameField()
static int	getServerNameFieldId() Get the field id for 'serverName' This method can be used to set field interests.
<T extends XString> T	getServerNameTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getServerNameTo(XString val) Copies the value of 'serverName' into the provided XString.
XString	getServerNameUnsafe() Gets the raw value of 'serverName'.
String	getServerPid() Gets the value of 'serverPid' Field Description The server process id
com.neeve.xbuf.XbufStringField	getServerPidField()
static int	getServerPidFieldId() Get the field id for 'serverPid' This method can be used to set field interests.
<T extends XString> T	getServerPidTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getServerPidTo(XString val) Copies the value of 'serverPid' into the provided XString.
XString	getServerPidUnsafe() Gets the raw value of 'serverPid'.
SrvMonSysStats	getSysStats() Gets the value of 'sysStats' Field Description Collects System System level stats such process or memory usage.
static int	getSysStatsFieldId() Get the field id for 'sysStats' This method can be used to set field interests.
void	getSysStatsTo(SrvMonSysStats to) Copies the value of SrvMonSysStats into the provided value.
String	getSystemName() Gets the value of 'systemName' Field Description The name of the system to which the server belongs.
com.neeve.xbuf.XbufStringField	getSystemNameField()
static int	getSystemNameFieldId() Get the field id for 'systemName' This method can be used to set field interests.
<T extends XString> T	getSystemNameTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getSystemNameTo(XString val) Copies the value of 'systemName' into the provided XString.
XString	getSystemNameUnsafe() Gets the raw value of 'systemName'.
String	getSystemVersion() Gets the value of 'systemVersion' Field Description The version of the system to which the server belongs.
com.neeve.xbuf.XbufStringField	getSystemVersionField()
static int	getSystemVersionFieldId() Get the field id for 'systemVersion' This method can be used to set field interests.
<T extends XString> T	getSystemVersionTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getSystemVersionTo(XString val) Copies the value of 'systemVersion' into the provided XString.
XString	getSystemVersionUnsafe() Gets the raw value of 'systemVersion'.
short	getXRogType()
com.neeve.xbuf.XbufVariableShortField	getXRogTypeField()
static int	getXRogTypeFieldId() Get the field id for 'xRogType' This method can be used to set field interests.
boolean	hasCollectionEndTime() Checks for the presence of 'collectionEndTime' Field Description The collection end time in nanoseconds (e.g.
boolean	hasCollectionStartTime() Checks for the presence of 'collectionStartTime' Field Description The collection start time in nanoseconds (e.g.
boolean	hasCollectionStartWallTime() Checks for the presence of 'collectionStartWallTime' Field Description The collection start time in milliseconds since the Epoch (e.g.
boolean	hasLoadedTime() Checks for the presence of 'loadedTime' Field Description The time at which the server loaded
boolean	hasServerHostName() Checks for the presence of 'serverHostName' Field Description The server's hostname
boolean	hasServerName() Checks for the presence of 'serverName' Field Description The name of the server
boolean	hasServerPid() Checks for the presence of 'serverPid' Field Description The server process id
boolean	hasSysStats() Checks for the presence of 'sysStats' Field Description Collects System System level stats such process or memory usage.
boolean	hasSystemName() Checks for the presence of 'systemName' Field Description The name of the system to which the server belongs.
boolean	hasSystemVersion() Checks for the presence of 'systemVersion' Field Description The version of the system to which the server belongs.
boolean	hasXRogType()
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' Field Description Collects stats related to the admin client connections NOTE: It is illegal to hold onto an entity 'set' on a message post the disposal of the container message.
void	lendAdminClientStatsFrom(XIterator<SrvMonAdminClientStats> val) Sets the value of 'adminClientStats' by lending the values from the provided iterator.
void	lendAppsInfo(SrvMonAppInfo val) Adds the provided value to the list of 'appsInfo' values and acquires a reference to it.
void	lendAppsInfo(SrvMonAppInfo[] val) Lends the value of 'appsInfo' Field Description Information about the apps configured for this server NOTE: It is illegal to hold onto an entity 'set' on a message post the disposal of the container message.
void	lendAppsInfoFrom(XIterator<SrvMonAppInfo> val) Sets the value of 'appsInfo' by lending the values from the provided iterator.
void	lendAppsStats(SrvMonAppStats val) Adds the provided value to the list of 'appsStats' values and acquires a reference to it.
void	lendAppsStats(SrvMonAppStats[] val) Lends the value of 'appsStats' Field Description Platform and user stats for loaded applications NOTE: It is illegal to hold onto an entity 'set' on a message post the disposal of the container message.
void	lendAppsStatsFrom(XIterator<SrvMonAppStats> val) Sets the value of 'appsStats' by lending the values from the provided iterator.
void	lendPoolStats(SrvMonPoolStats val) Adds the provided value to the list of 'poolStats' values and acquires a reference to it.
void	lendPoolStats(SrvMonPoolStats[] val) Lends the value of 'poolStats' Field Description Collects process wide pooling stats NOTE: It is illegal to hold onto an entity 'set' on a message post the disposal of the container message.
void	lendPoolStatsFrom(XIterator<SrvMonPoolStats> val) Sets the value of 'poolStats' by lending the values from the provided iterator.
void	lendServerHostName(XString val) Sets the value of 'serverHostName' Field Description The server's hostname
void	lendServerName(XString val) Sets the value of 'serverName' Field Description The name of the server
void	lendServerPid(XString val) Sets the value of 'serverPid' Field Description The server process id
void	lendSysStats(SrvMonSysStats val) 'Lends' a reference of the SrvMonSysStats to the message for this field.
void	lendSystemName(XString val) Sets the value of 'systemName' Field Description The name of the system to which the server belongs.
void	lendSystemVersion(XString val) Sets the value of 'systemVersion' Field Description The version of the system to which the server belongs.
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) Serializes the MessageView to an IOBuffer.
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' Field Description Collects stats related to the admin client connections
void	setAdminClientStatsFrom(XIterator<SrvMonAdminClientStats> val) Sets the value of 'adminClientStats' using the values from the provided iterator.
void	setAppsInfo(SrvMonAppInfo[] val) Sets the value of 'appsInfo' Field Description Information about the apps configured for this server
void	setAppsInfoFrom(XIterator<SrvMonAppInfo> val) Sets the value of 'appsInfo' using the values from the provided iterator.
void	setAppsStats(SrvMonAppStats[] val) Sets the value of 'appsStats' Field Description Platform and user stats for loaded applications
void	setAppsStatsFrom(XIterator<SrvMonAppStats> val) Sets the value of 'appsStats' using the values from the provided iterator.
void	setAsReadOnly() Set whether a node is read only Note: This read-only flag only applies to data, not metadata
void	setCollectionEndTime(long val) Sets the value of 'collectionEndTime' Field Description The collection end time in nanoseconds (e.g.
void	setCollectionEndTimeFrom(com.neeve.xbuf.XbufVariableLongField val)
void	setCollectionStartTime(long val) Sets the value of 'collectionStartTime' Field Description The collection start time in nanoseconds (e.g.
void	setCollectionStartTimeFrom(com.neeve.xbuf.XbufVariableLongField val)
void	setCollectionStartWallTime(long val) Sets the value of 'collectionStartWallTime' Field Description The collection start time in milliseconds since the Epoch (e.g.
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) Set the value of an object field.
void	setLoadedTime(Date val) Sets the value of 'loadedTime' Field Description The time at which the server loaded
void	setLoadedTimeAsTimestamp(long val) Sets the date value as a timestamp.
void	setLoadedTimeFrom(com.neeve.xbuf.XbufVariableDateField val)
void	setPoolStats(SrvMonPoolStats[] val) Sets the value of 'poolStats' Field Description Collects process wide pooling stats
void	setPoolStatsFrom(XIterator<SrvMonPoolStats> val) Sets the value of 'poolStats' using the values from the provided iterator.
void	setServerHostName(String val) Sets the value of 'serverHostName' Field Description The server's hostname
void	setServerHostNameFrom(long val) Sets the value of this String field to the given numeric value.
void	setServerHostNameFrom(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' Field Description The name of the server
void	setServerNameFrom(long val) Sets the value of this String field to the given numeric value.
void	setServerNameFrom(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' Field Description The server process id
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' Field Description Collects System System level stats such process or memory usage.
void	setSystemName(String val) Sets the value of 'systemName' Field Description The name of the system to which the server belongs.
void	setSystemNameFrom(long val) Sets the value of this String field to the given numeric value.
void	setSystemNameFrom(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' Field Description The version of the system to which the server belongs.
void	setSystemVersionFrom(long val) Sets the value of this String field to the given numeric value.
void	setSystemVersionFrom(com.neeve.xbuf.XbufStringField val)
void	setSystemVersionFrom(XString val) Copies the provided XString value into this object's 'systemVersion'.
void	setXRogType(short val)
void	setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)
void	sync() Ensure a view's backing message is prepared and ready for transport
void	syncFieldBitmask()
SrvMonAdminClientStats[]	takeAdminClientStats() Takes the value of 'adminClientStats' Field Description Collects stats related to the admin client connections 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.
SrvMonAppInfo[]	takeAppsInfo() Takes the value of 'appsInfo' Field Description Information about the apps configured for this server 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.
SrvMonAppStats[]	takeAppsStats() Takes the value of 'appsStats' Field Description Platform and user stats for loaded applications 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.
SrvMonPoolStats[]	takePoolStats() Takes the value of 'poolStats' Field Description Collects process wide pooling stats 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.
SrvMonSysStats	takeSysStats() 'Takes' a reference to the sysStats 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 this object
void	undispose(com.eaio.uuid.UUID id)

Methods inherited from class com.neeve.rog.impl.RogNode

accept, deserializeMetadata, deserializeMetadata, dump, ensureId, getAppSendBeginTs, getAppSendDoneTs, getAttachment, getBinding, getCheckpointVersion, getCreateTs, getEnqueueTs, getEnqueueTsMicros, getFields, getGraphId, getId, getInMsgsInTransaction, getIsInboundMessage, getIsInternal, getIsLastTransaction, getIsMessage, getIsOutboundMessage, getIsPriority, getIsReadOnly, getIsReplayedMessage, getMessageBus, getMessageBusAsRaw, getMessageChannel, getMessageChannelAsRaw, getMessageFlow, getMessageKey, getMessageKeyAsRaw, getMessageReflector, getMessageSender, getMessageSequenceNumber, 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, getTransactionId, getTransactionInSequenceNumber, getTransactionOutSequenceNumber, getTypeFromJson, getValidationErrors, isPossibleDuplicate, isValid, metadataToJsonString, metadataToJsonString, metadataToString, serializeMetadata, setAppSendBeginTs, setAppSendDoneTs, setAsInboundMessage, setAsInternal, setAsLastTransaction, setAsMessage, setAsOutboundMessage, setAsPriority, setAsReplayedMessage, setAttachment, setBinding, setCheckpointVersion, setCreateTs, setEnqueueTsMicros, setId, setInMsgsInTransaction, setMessageBus, setMessageBusAsRaw, setMessageChannel, setMessageChannelAsRaw, setMessageFlow, setMessageKey, setMessageKeyAsRaw, setMessageSender, setMessageSequenceNumber, setOriginTs, setOutMsgsInTransaction, setOutTs, setOutTsMicros, setParentId, setPoolingListener, setPossibleDuplicate, setPostDeserializeTs, setPostProcessingTs, setPostProcessingTsMicros, setPostSerializeTs, setPostWireSendTs, setPostWireTs, setPreDeserializeTs, setPreProcessingTs, setPreProcessingTsMicros, setPreSerializeTs, setPreWireTs, setReceiveTs, setSendStartTs, setSendTs, setStableTransactionId, setTransactionId, setTransactionInSequenceNumber, setTransactionOutSequenceNumber

Methods inherited from class com.neeve.sma.MessageViewImpl

acquire, getMessage, getMessageEncodingType, getOwnershipCount, getTag, getType, getVfid, referenceTracker, setTag

Methods inherited from class com.neeve.util.UtlListElement

count, insertAfter, insertBefore, isLinked, next, previous, unlink, wipe

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.neeve.rog.IRogNode

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

Methods inherited from interface com.neeve.ods.IStoreObject

acquire, deserializeMetadata, deserializeMetadata, ensureId, getBinding, getCheckpointVersion, getId, getOfid, getOwnershipCount, getSerializedMetadataLength, getStableTransactionId, getTransactionId, serializeMetadata, setBinding, setCheckpointVersion, setId, setStableTransactionId, setTransactionId

Methods inherited from interface com.neeve.sma.MapMessageView

getMessageReflector

Methods inherited from interface com.neeve.rog.IRogMetadata

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

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Field Detail

EMPTY_ARRAY

public static final SrvMonHeartbeatMessage[] EMPTY_ARRAY

A preallocated empty array used to avoid garbage when returning empty arrays of this type.

Method Detail

create

public static SrvMonHeartbeatMessage create()

create

public static SrvMonHeartbeatMessage create(com.eaio.uuid.UUID id)

createFromXbufContainerPacket

public static SrvMonHeartbeatMessage createFromXbufContainerPacket(PktPacket packet)

createFromSerializedXbufContainerPacket

public static SrvMonHeartbeatMessage createFromSerializedXbufContainerPacket(ByteBuffer serializedPacket)

createFromSerializedXbufContainerPacket

public static SrvMonHeartbeatMessage createFromSerializedXbufContainerPacket(byte[] serializedPacket)

createFromSerializedXbufContainer

public static SrvMonHeartbeatMessage createFromSerializedXbufContainer(ByteBuffer serializedContainer)

createFromSerializedXbufContainer

public static SrvMonHeartbeatMessage createFromSerializedXbufContainer(byte[] serializedContainer)

createFromRawJson

public static SrvMonHeartbeatMessage createFromRawJson(String json)

createFromJson

public static SrvMonHeartbeatMessage createFromJson(String json)

createFrom

public static SrvMonHeartbeatMessage createFrom(ByteBuffer serializedContainer)

createFrom

public static SrvMonHeartbeatMessage createFrom(byte[] serializedContainer)

setDesyncPolicy

public static final void setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)

getDesyncPolicy

public static final com.neeve.xbuf.XbufDesyncPolicy getDesyncPolicy()

setFieldInterest

public static final void setFieldInterest(List<Integer> fieldIds)

clearContent

public final void clearContent()

syncFieldBitmask

public final void syncFieldBitmask()

desyncFieldBitmask

public final void desyncFieldBitmask()

getBackingBuffer

public final PktBuffer getBackingBuffer()

optimizeFor

public static final void optimizeFor(int val)

getPacket

public final PktPacket getPacket()

Specified by:

getPacket in interface com.neeve.link.ILnkMessage

serializeToProtobuf

public final com.google.protobuf.Message serializeToProtobuf()

Description copied from interface: IRogNode

Serialize a node's data to a proto message.

Specified by:

serializeToProtobuf in interface IRogNode

serializeToRawJson

public final String serializeToRawJson()

serializeToJson

public final String serializeToJson()

Description copied from interface: MessageView

Serialize a view's backing message to JSON.

Serializing/deserializing a message to/from JSON is an optional operation

Specified by:

serializeToJson in interface MessageView

deserializeFromProtobuf

public final SrvMonHeartbeatMessage deserializeFromProtobuf(com.google.protobuf.Message message)

Description copied from interface: IRogNode

Deserialize a node's data from a protobuf message.

Specified by:

deserializeFromProtobuf in interface IRogNode

Parameters:

message - The protobuf message

deserializeFromRawJson

public final SrvMonHeartbeatMessage deserializeFromRawJson(String json)

deserializeFromJson

public final SrvMonHeartbeatMessage deserializeFromJson(String json)

Description copied from interface: MessageView

Deserialize a view's backing message from a json string

Specified by:

deserializeFromJson in interface MessageView

Parameters:

json - The view's backing message serialized as a json string.

Serializing/deserializing a message to/from JSON is an optional operation

setAsReadOnly

public final void setAsReadOnly()

Description copied from interface: IRogNode

Set whether a node is read only

Note: This read-only flag only applies to data, not metadata

Specified by:

setAsReadOnly in interface IRogNode

Overrides:

setAsReadOnly in class com.neeve.rog.impl.RogNode

dispose

public int dispose()

Description copied from class: MessageViewImpl

Default implementation of MessageView.dispose()

This is the default implementation of the dispose method. The implementation just decrements the ownership count. Implementations that implement view object pooling or other such functionality should override this method but invoke this method to decrement the object reference count.

Specified by:

dispose in interface IStoreObject

Specified by:

dispose in interface IRogNode

Specified by:

dispose in interface MessageView

Overrides:

dispose in class com.neeve.rog.impl.RogNode

Returns:

The reference count after the dispose completed.

undispose

public void undispose(com.eaio.uuid.UUID id)

Overrides:

undispose in class com.neeve.rog.impl.RogNode

getXRogTypeFieldId

public static final int getXRogTypeFieldId()

Get the field id for 'xRogType'

This method can be used to set field interests.

See Also:

getXRogType()

setXRogType

public final void setXRogType(short val)

getXRogType

public final short getXRogType()

setXRogTypeFrom

public final void setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)

getXRogTypeField

public final com.neeve.xbuf.XbufVariableShortField getXRogTypeField()

hasXRogType

public final boolean hasXRogType()

clearXRogType

public final void clearXRogType()

getCollectionStartWallTimeFieldId

public static final int getCollectionStartWallTimeFieldId()

Get the field id for 'collectionStartWallTime'

This method can be used to set field interests.

See Also:

getCollectionStartWallTime()

setCollectionStartWallTime

public final void setCollectionStartWallTime(long val)

Description copied from interface: ISrvMonHeartbeatMessage

Sets the value of 'collectionStartWallTime'

Field Description

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

Specified by:

setCollectionStartWallTime in interface ISrvMonHeartbeatMessage

Parameters:

val - The value to set.

getCollectionStartWallTime

public final long getCollectionStartWallTime()

Description copied from interface: ISrvMonHeartbeatMessage

Gets the value of 'collectionStartWallTime'

Field Description

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

Specified by:

getCollectionStartWallTime in interface ISrvMonHeartbeatMessage

Returns:

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

setCollectionStartWallTimeFrom

public final void setCollectionStartWallTimeFrom(com.neeve.xbuf.XbufVariableLongField val)

getCollectionStartWallTimeField

public final com.neeve.xbuf.XbufVariableLongField getCollectionStartWallTimeField()

hasCollectionStartWallTime

public final boolean hasCollectionStartWallTime()

Description copied from interface: ISrvMonHeartbeatMessage

Checks for the presence of 'collectionStartWallTime'

Field Description

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

Specified by:

hasCollectionStartWallTime in interface ISrvMonHeartbeatMessage

See Also:

ISrvMonHeartbeatMessage.getCollectionStartWallTime()

clearCollectionStartWallTime

public final void clearCollectionStartWallTime()

Description copied from interface: ISrvMonHeartbeatMessage

Clears the value of 'collectionStartWallTime'

Field Description

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

Specified by:

clearCollectionStartWallTime in interface ISrvMonHeartbeatMessage

See Also:

ISrvMonHeartbeatMessage.setCollectionStartWallTime(long)

getCollectionStartTimeFieldId

public static final int getCollectionStartTimeFieldId()

Get the field id for 'collectionStartTime'

This method can be used to set field interests.

See Also:

getCollectionStartTime()

setCollectionStartTime

public final void setCollectionStartTime(long val)

Description copied from interface: ISrvMonHeartbeatMessage

Sets the value of 'collectionStartTime'

Field Description

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

Specified by:

setCollectionStartTime in interface ISrvMonHeartbeatMessage

Parameters:

val - The value to set.

getCollectionStartTime

public final long getCollectionStartTime()

Description copied from interface: ISrvMonHeartbeatMessage

Gets the value of 'collectionStartTime'

Field Description

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

Specified by:

getCollectionStartTime in interface ISrvMonHeartbeatMessage

Returns:

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

setCollectionStartTimeFrom

public final void setCollectionStartTimeFrom(com.neeve.xbuf.XbufVariableLongField val)

getCollectionStartTimeField

public final com.neeve.xbuf.XbufVariableLongField getCollectionStartTimeField()

hasCollectionStartTime

public final boolean hasCollectionStartTime()

Description copied from interface: ISrvMonHeartbeatMessage

Checks for the presence of 'collectionStartTime'

Field Description

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

Specified by:

hasCollectionStartTime in interface ISrvMonHeartbeatMessage

See Also:

ISrvMonHeartbeatMessage.getCollectionStartTime()

clearCollectionStartTime

public final void clearCollectionStartTime()

Description copied from interface: ISrvMonHeartbeatMessage

Clears the value of 'collectionStartTime'

Field Description

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

Specified by:

clearCollectionStartTime in interface ISrvMonHeartbeatMessage

See Also:

ISrvMonHeartbeatMessage.setCollectionStartTime(long)

getCollectionEndTimeFieldId

public static final int getCollectionEndTimeFieldId()

Get the field id for 'collectionEndTime'

This method can be used to set field interests.

See Also:

getCollectionEndTime()

setCollectionEndTime

public final void setCollectionEndTime(long val)

Description copied from interface: ISrvMonHeartbeatMessage

Sets the value of 'collectionEndTime'

Field Description

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

Specified by:

setCollectionEndTime in interface ISrvMonHeartbeatMessage

Parameters:

val - The value to set.

getCollectionEndTime

public final long getCollectionEndTime()

Description copied from interface: ISrvMonHeartbeatMessage

Gets the value of 'collectionEndTime'

Field Description

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

Specified by:

getCollectionEndTime in interface ISrvMonHeartbeatMessage

Returns:

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

setCollectionEndTimeFrom

public final void setCollectionEndTimeFrom(com.neeve.xbuf.XbufVariableLongField val)

getCollectionEndTimeField

public final com.neeve.xbuf.XbufVariableLongField getCollectionEndTimeField()

hasCollectionEndTime

public final boolean hasCollectionEndTime()

Description copied from interface: ISrvMonHeartbeatMessage

Checks for the presence of 'collectionEndTime'

Field Description

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

Specified by:

hasCollectionEndTime in interface ISrvMonHeartbeatMessage

See Also:

ISrvMonHeartbeatMessage.getCollectionEndTime()

clearCollectionEndTime

public final void clearCollectionEndTime()

Description copied from interface: ISrvMonHeartbeatMessage

Clears the value of 'collectionEndTime'

Field Description

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

Specified by:

clearCollectionEndTime in interface ISrvMonHeartbeatMessage

See Also:

ISrvMonHeartbeatMessage.setCollectionEndTime(long)

getLoadedTimeFieldId

public static final int getLoadedTimeFieldId()

Get the field id for 'loadedTime'

This method can be used to set field interests.

See Also:

getLoadedTime()

setLoadedTime

public final void setLoadedTime(Date val)

Description copied from interface: ISrvMonHeartbeatMessage

Sets the value of 'loadedTime'

Field Description

The time at which the server loaded

Specified by:

setLoadedTime in interface ISrvMonHeartbeatMessage

Parameters:

val - The value to set.

getLoadedTime

public final Date getLoadedTime()

Description copied from interface: ISrvMonHeartbeatMessage

Gets the value of 'loadedTime'

Field Description

The time at which the server loaded

Specified by:

getLoadedTime in interface ISrvMonHeartbeatMessage

Returns:

The time at which the server loaded

setLoadedTimeAsTimestamp

public final void setLoadedTimeAsTimestamp(long val)

Description copied from interface: ISrvMonHeartbeatMessage

Sets the date value as a timestamp.

Field Description

The time at which the server loaded

Specified by:

setLoadedTimeAsTimestamp in interface ISrvMonHeartbeatMessage

Parameters:

val - The date value in milliseconds from the epoch

getLoadedTimeAsTimestamp

public final long getLoadedTimeAsTimestamp()

Description copied from interface: ISrvMonHeartbeatMessage

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

Field Description

The time at which the server loaded

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

Specified by:

getLoadedTimeAsTimestamp in interface ISrvMonHeartbeatMessage

Returns:

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

setLoadedTimeFrom

public final void setLoadedTimeFrom(com.neeve.xbuf.XbufVariableDateField val)

getLoadedTimeField

public final com.neeve.xbuf.XbufVariableDateField getLoadedTimeField()

hasLoadedTime

public final boolean hasLoadedTime()

Description copied from interface: ISrvMonHeartbeatMessage

Checks for the presence of 'loadedTime'

Field Description

The time at which the server loaded

Specified by:

hasLoadedTime in interface ISrvMonHeartbeatMessage

See Also:

ISrvMonHeartbeatMessage.getLoadedTime()

clearLoadedTime

public final void clearLoadedTime()

Description copied from interface: ISrvMonHeartbeatMessage

Clears the value of 'loadedTime'

Field Description

The time at which the server loaded

Specified by:

clearLoadedTime in interface ISrvMonHeartbeatMessage

See Also:

ISrvMonHeartbeatMessage.setLoadedTime(Date)

getServerNameFieldId

public static final int getServerNameFieldId()

Get the field id for 'serverName'

This method can be used to set field interests.

See Also:

getServerName()

setServerName

public final void setServerName(String val)

Description copied from interface: ISrvMonHeartbeatMessage

Sets the value of 'serverName'

Field Description

The name of the server

Specified by:

setServerName in interface ISrvMonHeartbeatMessage

Parameters:

val - The value to set.

getServerName

public final String getServerName()

Description copied from interface: ISrvMonHeartbeatMessage

Gets the value of 'serverName'

Field Description

The name of the server

Specified by:

getServerName in interface ISrvMonHeartbeatMessage

Returns:

The name of the server

lendServerName

public final void lendServerName(XString val)

Description copied from interface: ISrvMonHeartbeatMessage

Sets the value of 'serverName'

Field Description

The name of the server

Specified by:

lendServerName in interface ISrvMonHeartbeatMessage

Parameters:

val - The value to set.

setServerNameFrom

public final void setServerNameFrom(long val)

Description copied from interface: ISrvMonHeartbeatMessage

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

Field Description

The name of the server

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

Specified by:

setServerNameFrom in interface ISrvMonHeartbeatMessage

getServerNameTo

public final <T extends XString> T getServerNameTo(XString.Factory<T> factory)

Description copied from interface: ISrvMonHeartbeatMessage

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

Field Description

The name of the server

If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);

This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;

Specified by:

getServerNameTo in interface ISrvMonHeartbeatMessage

Parameters:

factory - The factory from which to get the XString to copy into and return

Returns:

a new XString from the provided factory if this field is set or null.

setServerNameFrom

public final void setServerNameFrom(XString val)

Description copied from interface: ISrvMonHeartbeatMessage

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

Field Description

The name of the server

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

Specified by:

setServerNameFrom in interface ISrvMonHeartbeatMessage

getServerNameTo

public final void getServerNameTo(XString val)

Description copied from interface: ISrvMonHeartbeatMessage

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

Field Description

The name of the server

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

Specified by:

getServerNameTo in interface ISrvMonHeartbeatMessage

See Also:

ISrvMonHeartbeatMessage.getServerName()

getServerNameUnsafe

public final XString getServerNameUnsafe()

Description copied from interface: ISrvMonHeartbeatMessage

Gets the raw value of 'serverName'.

Field Description

The name of the server

NOTE:
This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.

However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.

Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.

Specified by:

getServerNameUnsafe in interface ISrvMonHeartbeatMessage

Returns:

the field's raw value

See Also:

ISrvMonHeartbeatMessage.getServerName()

setServerNameFrom

public final void setServerNameFrom(com.neeve.xbuf.XbufStringField val)

getServerNameField

public final com.neeve.xbuf.XbufStringField getServerNameField()

hasServerName

public final boolean hasServerName()

Description copied from interface: ISrvMonHeartbeatMessage

Checks for the presence of 'serverName'

Field Description

The name of the server

Specified by:

hasServerName in interface ISrvMonHeartbeatMessage

See Also:

ISrvMonHeartbeatMessage.getServerName()

clearServerName

public final void clearServerName()

Description copied from interface: ISrvMonHeartbeatMessage

Clears the value of 'serverName'

Field Description

The name of the server

Specified by:

clearServerName in interface ISrvMonHeartbeatMessage

See Also:

ISrvMonHeartbeatMessage.setServerName(String)

getServerHostNameFieldId

public static final int getServerHostNameFieldId()

Get the field id for 'serverHostName'

This method can be used to set field interests.

See Also:

getServerHostName()

setServerHostName

public final void setServerHostName(String val)

Description copied from interface: ISrvMonHeartbeatMessage

Sets the value of 'serverHostName'

Field Description

The server's hostname

Specified by:

setServerHostName in interface ISrvMonHeartbeatMessage

Parameters:

val - The value to set.

getServerHostName

public final String getServerHostName()

Description copied from interface: ISrvMonHeartbeatMessage

Gets the value of 'serverHostName'

Field Description

The server's hostname

Specified by:

getServerHostName in interface ISrvMonHeartbeatMessage

Returns:

The server's hostname

lendServerHostName

public final void lendServerHostName(XString val)

Description copied from interface: ISrvMonHeartbeatMessage

Sets the value of 'serverHostName'

Field Description

The server's hostname

Specified by:

lendServerHostName in interface ISrvMonHeartbeatMessage

Parameters:

val - The value to set.

setServerHostNameFrom

public final void setServerHostNameFrom(long val)

Description copied from interface: ISrvMonHeartbeatMessage

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

Field Description

The server's hostname

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

Specified by:

setServerHostNameFrom in interface ISrvMonHeartbeatMessage

getServerHostNameTo

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

Description copied from interface: ISrvMonHeartbeatMessage

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

Field Description

The server's hostname

If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);

This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;

Specified by:

getServerHostNameTo in interface ISrvMonHeartbeatMessage

Parameters:

factory - The factory from which to get the XString to copy into and return

Returns:

a new XString from the provided factory if this field is set or null.

setServerHostNameFrom

public final void setServerHostNameFrom(XString val)

Description copied from interface: ISrvMonHeartbeatMessage

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

Field Description

The server's hostname

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

Specified by:

setServerHostNameFrom in interface ISrvMonHeartbeatMessage

getServerHostNameTo

public final void getServerHostNameTo(XString val)

Description copied from interface: ISrvMonHeartbeatMessage

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

Field Description

The server's hostname

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

Specified by:

getServerHostNameTo in interface ISrvMonHeartbeatMessage

See Also:

ISrvMonHeartbeatMessage.getServerHostName()

getServerHostNameUnsafe

public final XString getServerHostNameUnsafe()

Description copied from interface: ISrvMonHeartbeatMessage

Gets the raw value of 'serverHostName'.

Field Description

The server's hostname

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.

Specified by:

getServerHostNameUnsafe in interface ISrvMonHeartbeatMessage

Returns:

the field's raw value

See Also:

ISrvMonHeartbeatMessage.getServerHostName()

setServerHostNameFrom

public final void setServerHostNameFrom(com.neeve.xbuf.XbufStringField val)

getServerHostNameField

public final com.neeve.xbuf.XbufStringField getServerHostNameField()

hasServerHostName

public final boolean hasServerHostName()

Description copied from interface: ISrvMonHeartbeatMessage

Checks for the presence of 'serverHostName'

Field Description

The server's hostname

Specified by:

hasServerHostName in interface ISrvMonHeartbeatMessage

See Also:

ISrvMonHeartbeatMessage.getServerHostName()

clearServerHostName

public final void clearServerHostName()

Description copied from interface: ISrvMonHeartbeatMessage

Clears the value of 'serverHostName'

Field Description

The server's hostname

Specified by:

clearServerHostName in interface ISrvMonHeartbeatMessage

See Also:

ISrvMonHeartbeatMessage.setServerHostName(String)

getServerPidFieldId

public static final int getServerPidFieldId()

Get the field id for 'serverPid'

This method can be used to set field interests.

See Also:

getServerPid()

setServerPid

public final void setServerPid(String val)

Description copied from interface: ISrvMonHeartbeatMessage

Sets the value of 'serverPid'

Field Description

The server process id

Specified by:

setServerPid in interface ISrvMonHeartbeatMessage

Parameters:

val - The value to set.

getServerPid

public final String getServerPid()

Description copied from interface: ISrvMonHeartbeatMessage

Gets the value of 'serverPid'

Field Description

The server process id

Specified by:

getServerPid in interface ISrvMonHeartbeatMessage

Returns:

The server process id

lendServerPid

public final void lendServerPid(XString val)

Description copied from interface: ISrvMonHeartbeatMessage

Sets the value of 'serverPid'

Field Description

The server process id

Specified by:

lendServerPid in interface ISrvMonHeartbeatMessage

Parameters:

val - The value to set.

setServerPidFrom

public final void setServerPidFrom(long val)

Description copied from interface: ISrvMonHeartbeatMessage

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

Field Description

The server process id

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

Specified by:

setServerPidFrom in interface ISrvMonHeartbeatMessage

getServerPidTo

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

Description copied from interface: ISrvMonHeartbeatMessage

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

Field Description

The server process id

If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);

This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;

Specified by:

getServerPidTo in interface ISrvMonHeartbeatMessage

Parameters:

factory - The factory from which to get the XString to copy into and return

Returns:

a new XString from the provided factory if this field is set or null.

setServerPidFrom

public final void setServerPidFrom(XString val)

Description copied from interface: ISrvMonHeartbeatMessage

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

Field Description

The server process id

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

Specified by:

setServerPidFrom in interface ISrvMonHeartbeatMessage

getServerPidTo

public final void getServerPidTo(XString val)

Description copied from interface: ISrvMonHeartbeatMessage

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

Field Description

The server process id

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

Specified by:

getServerPidTo in interface ISrvMonHeartbeatMessage

See Also:

ISrvMonHeartbeatMessage.getServerPid()

getServerPidUnsafe

public final XString getServerPidUnsafe()

Description copied from interface: ISrvMonHeartbeatMessage

Gets the raw value of 'serverPid'.

Field Description

The server process id

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.

Specified by:

getServerPidUnsafe in interface ISrvMonHeartbeatMessage

Returns:

the field's raw value

See Also:

ISrvMonHeartbeatMessage.getServerPid()

setServerPidFrom

public final void setServerPidFrom(com.neeve.xbuf.XbufStringField val)

getServerPidField

public final com.neeve.xbuf.XbufStringField getServerPidField()

hasServerPid

public final boolean hasServerPid()

Description copied from interface: ISrvMonHeartbeatMessage

Checks for the presence of 'serverPid'

Field Description

The server process id

Specified by:

hasServerPid in interface ISrvMonHeartbeatMessage

See Also:

ISrvMonHeartbeatMessage.getServerPid()

clearServerPid

public final void clearServerPid()

Description copied from interface: ISrvMonHeartbeatMessage

Clears the value of 'serverPid'

Field Description

The server process id

Specified by:

clearServerPid in interface ISrvMonHeartbeatMessage

See Also:

ISrvMonHeartbeatMessage.setServerPid(String)

getSysStatsFieldId

public static final int getSysStatsFieldId()

Get the field id for 'sysStats'

This method can be used to set field interests.

See Also:

getSysStats()

setSysStats

public final void setSysStats(SrvMonSysStats val)

Description copied from interface: ISrvMonHeartbeatMessage

Sets the value of 'sysStats'

Field Description

Collects System System level stats such process or memory usage.

Specified by:

setSysStats in interface ISrvMonHeartbeatMessage

Parameters:

val - The value to set.

lendSysStats

public final void lendSysStats(SrvMonSysStats val)

Description copied from interface: ISrvMonHeartbeatMessage

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

Field Description

Collects System System level stats such process or memory usage.

NOTE:
It is illegal to hold onto an entity 'set' on a message post the disposal of the container message. This is true even if a reference to the entity is explicitly 'acquired' by the application via acquire().

To hold onto the reference of an entity beyond the lifecycle of its container message, an application must own a reference to the entity (via, for example, 'taking' the entity off an inbound message) and then 'lend' the entity to the message for sending. The act of 'lending' an entity to a message implies that the application continues to own the entity even though the message is holding a reference to it for the duration of the send.

Specified by:

lendSysStats in interface ISrvMonHeartbeatMessage

Parameters:

val - the value to 'lend' to lend.

getSysStats

public final SrvMonSysStats getSysStats()

Description copied from interface: ISrvMonHeartbeatMessage

Gets the value of 'sysStats'

Field Description

Collects System System level stats such process or memory usage.

Specified by:

getSysStats in interface ISrvMonHeartbeatMessage

Returns:

Collects System System level stats such process or memory usage.

getSysStatsTo

public final void getSysStatsTo(SrvMonSysStats to)

Description copied from interface: ISrvMonHeartbeatMessage

Copies the value of SrvMonSysStats into the provided value.

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

Specified by:

getSysStatsTo in interface ISrvMonHeartbeatMessage

Parameters:

to - the value to copy into

See Also:

SrvMonSysStats.copyInto(SrvMonSysStats)

takeSysStats

public final SrvMonSysStats takeSysStats()

Description copied from interface: ISrvMonHeartbeatMessage

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

Field Description

Collects System System level stats such process or memory usage.

NOTE:
A nested entity reference returned by getXXX() is only valid until the entity is disposed i.e. the act of getting an entity does not transfer ownership of the entity to the application A message disposes of its reference to its contained entities when it is disposed itself.

An AEP engine disposes a message on return from its message handler. Therefore, applications working with AEP engines that wish to hold onto a nested entity reference post return from its containing message's handler must either acquire a reference to the container message or 'take' the nested entity itself from the container message. The act of 'taking' an entity differs from 'getting' an entity in that 'take' does what is necessary to ensure that the entity contents are not cleared and the entity not disposed when the message itself is disposed. For a taken entity to be disposed, the application must explicitly dispose it when done working with it.

Specified by:

takeSysStats in interface ISrvMonHeartbeatMessage

Returns:

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

hasSysStats

public final boolean hasSysStats()

Description copied from interface: ISrvMonHeartbeatMessage

Checks for the presence of 'sysStats'

Field Description

Collects System System level stats such process or memory usage.

Specified by:

hasSysStats in interface ISrvMonHeartbeatMessage

See Also:

ISrvMonHeartbeatMessage.getSysStats()

clearSysStats

public final void clearSysStats()

Description copied from interface: ISrvMonHeartbeatMessage

Clears the value of 'sysStats'

Field Description

Collects System System level stats such process or memory usage.

Specified by:

clearSysStats in interface ISrvMonHeartbeatMessage

See Also:

ISrvMonHeartbeatMessage.setSysStats(SrvMonSysStats)

getPoolStatsFieldId

public static final int getPoolStatsFieldId()

Get the field id for 'poolStats'

This method can be used to set field interests.

See Also:

getPoolStats()

setPoolStats

public final void setPoolStats(SrvMonPoolStats[] val)

Description copied from interface: ISrvMonHeartbeatMessage

Sets the value of 'poolStats'

Field Description

Collects process wide pooling stats

Specified by:

setPoolStats in interface ISrvMonHeartbeatMessage

Parameters:

val - The value to set.

setPoolStatsFrom

public final void setPoolStatsFrom(XIterator<SrvMonPoolStats> val)

Description copied from interface: ISrvMonHeartbeatMessage

Sets the value of 'poolStats' using the values from the provided iterator.

This method will call XIterator.toFirst() before and after setting the values, meaning that all values from the iterator will be set and the iterator will be reset on return.

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

Field Description

Collects process wide pooling stats

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

Specified by:

setPoolStatsFrom in interface ISrvMonHeartbeatMessage

Parameters:

val - the values to set.

lendPoolStatsFrom

public final void lendPoolStatsFrom(XIterator<SrvMonPoolStats> val)

Description copied from interface: ISrvMonHeartbeatMessage

Sets the value of 'poolStats' by lending the values from the provided iterator.

This method will call XIterator.toFirst() before and after setting the values, meaning that all values from the iterator will be set and the iterator will be reset on return.

This method will acquire references to each non null value in the provided iterator making it suitable for cases where the values come from another message that may be disposed.

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

Field Description

Collects process wide pooling stats

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

Specified by:

lendPoolStatsFrom in interface ISrvMonHeartbeatMessage

Parameters:

val - the values to set.

lendPoolStats

public final void lendPoolStats(SrvMonPoolStats[] val)

Description copied from interface: ISrvMonHeartbeatMessage

Lends the value of 'poolStats'

Field Description

Collects process wide pooling stats

NOTE:
It is illegal to hold onto an entity 'set' on a message post the disposal of the container message. 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.

Specified by:

lendPoolStats in interface ISrvMonHeartbeatMessage

Parameters:

val - the value to 'lend' to lend.

addPoolStats

public final void addPoolStats(SrvMonPoolStats val)

Description copied from interface: ISrvMonHeartbeatMessage

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

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

For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.

Field Description

Collects process wide pooling stats

Specified by:

addPoolStats in interface ISrvMonHeartbeatMessage

Parameters:

val - the value to add.

lendPoolStats

public final void lendPoolStats(SrvMonPoolStats val)

Description copied from interface: ISrvMonHeartbeatMessage

Adds the provided value to the list of 'poolStats' values and acquires a reference to it.

Lending of an added value is useful in cases where a field is being added from a source message to provide dispose of the source value when the source message is disposed.

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

For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.

Field Description

Collects process wide pooling stats

Specified by:

lendPoolStats in interface ISrvMonHeartbeatMessage

Parameters:

val - the value to add.

getPoolStats

public final SrvMonPoolStats[] getPoolStats()

Description copied from interface: ISrvMonHeartbeatMessage

Gets the value of 'poolStats'

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

Field Description

Collects process wide pooling stats

Specified by:

getPoolStats in interface ISrvMonHeartbeatMessage

Returns:

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

getPoolStatsEmptyIfNull

public final SrvMonPoolStats[] getPoolStatsEmptyIfNull()

Description copied from interface: ISrvMonHeartbeatMessage

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

Field Description

Collects process wide pooling stats

Specified by:

getPoolStatsEmptyIfNull in interface ISrvMonHeartbeatMessage

Returns:

Collects process wide pooling stats or an empty array if null if not set.

See Also:

ISrvMonHeartbeatMessage.getPoolStats()

getPoolStatsIterator

public final XIterator<SrvMonPoolStats> getPoolStatsIterator()

Description copied from interface: ISrvMonHeartbeatMessage

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

This method will always return a non null iterator value. The returned iterator is not threadsafe, and the caller may not hold on to it beyond the pooling lifespan of this object. Depending on the implementation, the same iterator instance may be returned by this object on each call to avoid garbage. Each time this method is called the iterator is reset by calling its toFirst() method. Callers should therefore be especially careful about calling this method while iterating on the iterator returned by this method.

The elements returned by this iterator are owned by and pooled along with this object. The caller. must call acquire() on each returned object that this object intends to keep beyond the lifespan. of this object (unless the element is lent to another object in which that object will acquire it then).

This method is zero garbage for Xbuf generated classes, and this method is optimized such that passing the returned iterator to another object's setXXX(XIterator method can perform a direct copy of the underlying values without iteration.

Field Description

Collects process wide pooling stats

Specified by:

getPoolStatsIterator in interface ISrvMonHeartbeatMessage

Returns:

An iterator containing this field values.

takePoolStats

public final SrvMonPoolStats[] takePoolStats()

Description copied from interface: ISrvMonHeartbeatMessage

Takes the value of 'poolStats'

Field Description

Collects process wide pooling stats

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.

Specified by:

takePoolStats in interface ISrvMonHeartbeatMessage

Returns:

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

clearPoolStats

public final void clearPoolStats()

Description copied from interface: ISrvMonHeartbeatMessage

Clears the value of 'poolStats'

Field Description

Collects process wide pooling stats

Specified by:

clearPoolStats in interface ISrvMonHeartbeatMessage

See Also:

ISrvMonHeartbeatMessage.setPoolStats(SrvMonPoolStats[])

getAppsInfoFieldId

public static final int getAppsInfoFieldId()

Get the field id for 'appsInfo'

This method can be used to set field interests.

See Also:

getAppsInfo()

setAppsInfo

public final void setAppsInfo(SrvMonAppInfo[] val)

Description copied from interface: ISrvMonHeartbeatMessage

Sets the value of 'appsInfo'

Field Description

Information about the apps configured for this server

Specified by:

setAppsInfo in interface ISrvMonHeartbeatMessage

Parameters:

val - The value to set.

setAppsInfoFrom

public final void setAppsInfoFrom(XIterator<SrvMonAppInfo> val)

Description copied from interface: ISrvMonHeartbeatMessage

Sets the value of 'appsInfo' using the values from the provided iterator.

This method will call XIterator.toFirst() before and after setting the values, meaning that all values from the iterator will be set and the iterator will be reset on return.

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

Field Description

Information about the apps configured for this server

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

Specified by:

setAppsInfoFrom in interface ISrvMonHeartbeatMessage

Parameters:

val - the values to set.

lendAppsInfoFrom

public final void lendAppsInfoFrom(XIterator<SrvMonAppInfo> val)

Description copied from interface: ISrvMonHeartbeatMessage

Sets the value of 'appsInfo' by lending the values from the provided iterator.

This method will call XIterator.toFirst() before and after setting the values, meaning that all values from the iterator will be set and the iterator will be reset on return.

This method will acquire references to each non null value in the provided iterator making it suitable for cases where the values come from another message that may be disposed.

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

Field Description

Information about the apps configured for this server

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

Specified by:

lendAppsInfoFrom in interface ISrvMonHeartbeatMessage

Parameters:

val - the values to set.

lendAppsInfo

public final void lendAppsInfo(SrvMonAppInfo[] val)

Description copied from interface: ISrvMonHeartbeatMessage

Lends the value of 'appsInfo'

Field Description

Information about the apps configured for this server

NOTE:
It is illegal to hold onto an entity 'set' on a message post the disposal of the container message. 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.

Specified by:

lendAppsInfo in interface ISrvMonHeartbeatMessage

Parameters:

val - the value to 'lend' to lend.

addAppsInfo

public final void addAppsInfo(SrvMonAppInfo val)

Description copied from interface: ISrvMonHeartbeatMessage

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

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

For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.

Field Description

Information about the apps configured for this server

Specified by:

addAppsInfo in interface ISrvMonHeartbeatMessage

Parameters:

val - the value to add.

lendAppsInfo

public final void lendAppsInfo(SrvMonAppInfo val)

Description copied from interface: ISrvMonHeartbeatMessage

Adds the provided value to the list of 'appsInfo' values and acquires a reference to it.

Lending of an added value is useful in cases where a field is being added from a source message to provide dispose of the source value when the source message is disposed.

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

For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.

Field Description

Information about the apps configured for this server

Specified by:

lendAppsInfo in interface ISrvMonHeartbeatMessage

Parameters:

val - the value to add.

getAppsInfo

public final SrvMonAppInfo[] getAppsInfo()

Description copied from interface: ISrvMonHeartbeatMessage

Gets the value of 'appsInfo'

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

Field Description

Information about the apps configured for this server

Specified by:

getAppsInfo in interface ISrvMonHeartbeatMessage

Returns:

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

getAppsInfoEmptyIfNull

public final SrvMonAppInfo[] getAppsInfoEmptyIfNull()

Description copied from interface: ISrvMonHeartbeatMessage

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

Field Description

Information about the apps configured for this server

Specified by:

getAppsInfoEmptyIfNull in interface ISrvMonHeartbeatMessage

Returns:

Information about the apps configured for this server or an empty array if null if not set.

See Also:

ISrvMonHeartbeatMessage.getAppsInfo()

getAppsInfoIterator

public final XIterator<SrvMonAppInfo> getAppsInfoIterator()

Description copied from interface: ISrvMonHeartbeatMessage

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

This method will always return a non null iterator value. The returned iterator is not threadsafe, and the caller may not hold on to it beyond the pooling lifespan of this object. Depending on the implementation, the same iterator instance may be returned by this object on each call to avoid garbage. Each time this method is called the iterator is reset by calling its toFirst() method. Callers should therefore be especially careful about calling this method while iterating on the iterator returned by this method.

The elements returned by this iterator are owned by and pooled along with this object. The caller. must call acquire() on each returned object that this object intends to keep beyond the lifespan. of this object (unless the element is lent to another object in which that object will acquire it then).

This method is zero garbage for Xbuf generated classes, and this method is optimized such that passing the returned iterator to another object's setXXX(XIterator method can perform a direct copy of the underlying values without iteration.

Field Description

Information about the apps configured for this server

Specified by:

getAppsInfoIterator in interface ISrvMonHeartbeatMessage

Returns:

An iterator containing this field values.

takeAppsInfo

public final SrvMonAppInfo[] takeAppsInfo()

Description copied from interface: ISrvMonHeartbeatMessage

Takes the value of 'appsInfo'

Field Description

Information about the apps configured for this server

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.

Specified by:

takeAppsInfo in interface ISrvMonHeartbeatMessage

Returns:

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

clearAppsInfo

public final void clearAppsInfo()

Description copied from interface: ISrvMonHeartbeatMessage

Clears the value of 'appsInfo'

Field Description

Information about the apps configured for this server

Specified by:

clearAppsInfo in interface ISrvMonHeartbeatMessage

See Also:

ISrvMonHeartbeatMessage.setAppsInfo(SrvMonAppInfo[])

getAppsStatsFieldId

public static final int getAppsStatsFieldId()

Get the field id for 'appsStats'

This method can be used to set field interests.

See Also:

getAppsStats()

setAppsStats

public final void setAppsStats(SrvMonAppStats[] val)

Description copied from interface: ISrvMonHeartbeatMessage

Sets the value of 'appsStats'

Field Description

Platform and user stats for loaded applications

Specified by:

setAppsStats in interface ISrvMonHeartbeatMessage

Parameters:

val - The value to set.

setAppsStatsFrom

public final void setAppsStatsFrom(XIterator<SrvMonAppStats> val)

Description copied from interface: ISrvMonHeartbeatMessage

Sets the value of 'appsStats' using the values from the provided iterator.

This method will call XIterator.toFirst() before and after setting the values, meaning that all values from the iterator will be set and the iterator will be reset on return.

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

Field Description

Platform and user stats for loaded applications

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

Specified by:

setAppsStatsFrom in interface ISrvMonHeartbeatMessage

Parameters:

val - the values to set.

lendAppsStatsFrom

public final void lendAppsStatsFrom(XIterator<SrvMonAppStats> val)

Description copied from interface: ISrvMonHeartbeatMessage

Sets the value of 'appsStats' by lending the values from the provided iterator.

This method will call XIterator.toFirst() before and after setting the values, meaning that all values from the iterator will be set and the iterator will be reset on return.

This method will acquire references to each non null value in the provided iterator making it suitable for cases where the values come from another message that may be disposed.

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

Field Description

Platform and user stats for loaded applications

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

Specified by:

lendAppsStatsFrom in interface ISrvMonHeartbeatMessage

Parameters:

val - the values to set.

lendAppsStats

public final void lendAppsStats(SrvMonAppStats[] val)

Description copied from interface: ISrvMonHeartbeatMessage

Lends the value of 'appsStats'

Field Description

Platform and user stats for loaded applications

NOTE:
It is illegal to hold onto an entity 'set' on a message post the disposal of the container message. 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.

Specified by:

lendAppsStats in interface ISrvMonHeartbeatMessage

Parameters:

val - the value to 'lend' to lend.

addAppsStats

public final void addAppsStats(SrvMonAppStats val)

Description copied from interface: ISrvMonHeartbeatMessage

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

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

For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.

Field Description

Platform and user stats for loaded applications

Specified by:

addAppsStats in interface ISrvMonHeartbeatMessage

Parameters:

val - the value to add.

lendAppsStats

public final void lendAppsStats(SrvMonAppStats val)

Description copied from interface: ISrvMonHeartbeatMessage

Adds the provided value to the list of 'appsStats' values and acquires a reference to it.

Lending of an added value is useful in cases where a field is being added from a source message to provide dispose of the source value when the source message is disposed.

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

For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.

Field Description

Platform and user stats for loaded applications

Specified by:

lendAppsStats in interface ISrvMonHeartbeatMessage

Parameters:

val - the value to add.

getAppsStats

public final SrvMonAppStats[] getAppsStats()

Description copied from interface: ISrvMonHeartbeatMessage

Gets the value of 'appsStats'

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

Field Description

Platform and user stats for loaded applications

Specified by:

getAppsStats in interface ISrvMonHeartbeatMessage

Returns:

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

getAppsStatsEmptyIfNull

public final SrvMonAppStats[] getAppsStatsEmptyIfNull()

Description copied from interface: ISrvMonHeartbeatMessage

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

Field Description

Platform and user stats for loaded applications

Specified by:

getAppsStatsEmptyIfNull in interface ISrvMonHeartbeatMessage

Returns:

Platform and user stats for loaded applications or an empty array if null if not set.

See Also:

ISrvMonHeartbeatMessage.getAppsStats()

getAppsStatsIterator

public final XIterator<SrvMonAppStats> getAppsStatsIterator()

Description copied from interface: ISrvMonHeartbeatMessage

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

This method will always return a non null iterator value. The returned iterator is not threadsafe, and the caller may not hold on to it beyond the pooling lifespan of this object. Depending on the implementation, the same iterator instance may be returned by this object on each call to avoid garbage. Each time this method is called the iterator is reset by calling its toFirst() method. Callers should therefore be especially careful about calling this method while iterating on the iterator returned by this method.

The elements returned by this iterator are owned by and pooled along with this object. The caller. must call acquire() on each returned object that this object intends to keep beyond the lifespan. of this object (unless the element is lent to another object in which that object will acquire it then).

This method is zero garbage for Xbuf generated classes, and this method is optimized such that passing the returned iterator to another object's setXXX(XIterator method can perform a direct copy of the underlying values without iteration.

Field Description

Platform and user stats for loaded applications

Specified by:

getAppsStatsIterator in interface ISrvMonHeartbeatMessage

Returns:

An iterator containing this field values.

takeAppsStats

public final SrvMonAppStats[] takeAppsStats()

Description copied from interface: ISrvMonHeartbeatMessage

Takes the value of 'appsStats'

Field Description

Platform and user stats for loaded applications

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.

Specified by:

takeAppsStats in interface ISrvMonHeartbeatMessage

Returns:

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

clearAppsStats

public final void clearAppsStats()

Description copied from interface: ISrvMonHeartbeatMessage

Clears the value of 'appsStats'

Field Description

Platform and user stats for loaded applications

Specified by:

clearAppsStats in interface ISrvMonHeartbeatMessage

See Also:

ISrvMonHeartbeatMessage.setAppsStats(SrvMonAppStats[])

getAdminClientStatsFieldId

public static final int getAdminClientStatsFieldId()

Get the field id for 'adminClientStats'

This method can be used to set field interests.

See Also:

getAdminClientStats()

setAdminClientStats

public final void setAdminClientStats(SrvMonAdminClientStats[] val)

Description copied from interface: ISrvMonHeartbeatMessage

Sets the value of 'adminClientStats'

Field Description

Collects stats related to the admin client connections

Specified by:

setAdminClientStats in interface ISrvMonHeartbeatMessage

Parameters:

val - The value to set.

setAdminClientStatsFrom

public final void setAdminClientStatsFrom(XIterator<SrvMonAdminClientStats> val)

Description copied from interface: ISrvMonHeartbeatMessage

Sets the value of 'adminClientStats' using the values from the provided iterator.

This method will call XIterator.toFirst() before and after setting the values, meaning that all values from the iterator will be set and the iterator will be reset on return.

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

Field Description

Collects stats related to the admin client connections

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

Specified by:

setAdminClientStatsFrom in interface ISrvMonHeartbeatMessage

Parameters:

val - the values to set.

lendAdminClientStatsFrom

public final void lendAdminClientStatsFrom(XIterator<SrvMonAdminClientStats> val)

Description copied from interface: ISrvMonHeartbeatMessage

Sets the value of 'adminClientStats' by lending the values from the provided iterator.

This method will call XIterator.toFirst() before and after setting the values, meaning that all values from the iterator will be set and the iterator will be reset on return.

This method will acquire references to each non null value in the provided iterator making it suitable for cases where the values come from another message that may be disposed.

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

Field Description

Collects stats related to the admin client connections

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

Specified by:

lendAdminClientStatsFrom in interface ISrvMonHeartbeatMessage

Parameters:

val - the values to set.

lendAdminClientStats

public final void lendAdminClientStats(SrvMonAdminClientStats[] val)

Description copied from interface: ISrvMonHeartbeatMessage

Lends the value of 'adminClientStats'

Field Description

Collects stats related to the admin client connections

NOTE:
It is illegal to hold onto an entity 'set' on a message post the disposal of the container message. 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.

Specified by:

lendAdminClientStats in interface ISrvMonHeartbeatMessage

Parameters:

val - the value to 'lend' to lend.

addAdminClientStats

public final void addAdminClientStats(SrvMonAdminClientStats val)

Description copied from interface: ISrvMonHeartbeatMessage

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

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.

Field Description

Collects stats related to the admin client connections

Specified by:

addAdminClientStats in interface ISrvMonHeartbeatMessage

Parameters:

val - the value to add.

lendAdminClientStats

public final void lendAdminClientStats(SrvMonAdminClientStats val)

Description copied from interface: ISrvMonHeartbeatMessage

Adds the provided value to the list of 'adminClientStats' values and acquires a reference to it.

Lending of an added value is useful in cases where a field is being added from a source message to provide dispose of the source value when the source message is disposed.

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.

Field Description

Collects stats related to the admin client connections

Specified by:

lendAdminClientStats in interface ISrvMonHeartbeatMessage

Parameters:

val - the value to add.

getAdminClientStats

public final SrvMonAdminClientStats[] getAdminClientStats()

Description copied from interface: ISrvMonHeartbeatMessage

Gets the value of 'adminClientStats'

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

Field Description

Collects stats related to the admin client connections

Specified by:

getAdminClientStats in interface ISrvMonHeartbeatMessage

Returns:

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

getAdminClientStatsEmptyIfNull

public final SrvMonAdminClientStats[] getAdminClientStatsEmptyIfNull()

Description copied from interface: ISrvMonHeartbeatMessage

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

Field Description

Collects stats related to the admin client connections

Specified by:

getAdminClientStatsEmptyIfNull in interface ISrvMonHeartbeatMessage

Returns:

Collects stats related to the admin client connections or an empty array if null if not set.

See Also:

ISrvMonHeartbeatMessage.getAdminClientStats()

getAdminClientStatsIterator

public final XIterator<SrvMonAdminClientStats> getAdminClientStatsIterator()

Description copied from interface: ISrvMonHeartbeatMessage

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

This method will always return a non null iterator value. The returned iterator is not threadsafe, and the caller may not hold on to it beyond the pooling lifespan of this object. Depending on the implementation, the same iterator instance may be returned by this object on each call to avoid garbage. Each time this method is called the iterator is reset by calling its toFirst() method. Callers should therefore be especially careful about calling this method while iterating on the iterator returned by this method.

The elements returned by this iterator are owned by and pooled along with this object. The caller. must call acquire() on each returned object that this object intends to keep beyond the lifespan. of this object (unless the element is lent to another object in which that object will acquire it then).

This method is zero garbage for Xbuf generated classes, and this method is optimized such that passing the returned iterator to another object's setXXX(XIterator method can perform a direct copy of the underlying values without iteration.

Field Description

Collects stats related to the admin client connections

Specified by:

getAdminClientStatsIterator in interface ISrvMonHeartbeatMessage

Returns:

An iterator containing this field values.

takeAdminClientStats

public final SrvMonAdminClientStats[] takeAdminClientStats()

Description copied from interface: ISrvMonHeartbeatMessage

Takes the value of 'adminClientStats'

Field Description

Collects stats related to the admin client connections

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.

Specified by:

takeAdminClientStats in interface ISrvMonHeartbeatMessage

Returns:

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

clearAdminClientStats

public final void clearAdminClientStats()

Description copied from interface: ISrvMonHeartbeatMessage

Clears the value of 'adminClientStats'

Field Description

Collects stats related to the admin client connections

Specified by:

clearAdminClientStats in interface ISrvMonHeartbeatMessage

See Also:

ISrvMonHeartbeatMessage.setAdminClientStats(SrvMonAdminClientStats[])

getSystemNameFieldId

public static final int getSystemNameFieldId()

Get the field id for 'systemName'

This method can be used to set field interests.

See Also:

getSystemName()

setSystemName

public final void setSystemName(String val)

Description copied from interface: ISrvMonHeartbeatMessage

Sets the value of 'systemName'

Field Description

The name of the system to which the server belongs.

Specified by:

setSystemName in interface ISrvMonHeartbeatMessage

Parameters:

val - The value to set.

getSystemName

public final String getSystemName()

Description copied from interface: ISrvMonHeartbeatMessage

Gets the value of 'systemName'

Field Description

The name of the system to which the server belongs.

Specified by:

getSystemName in interface ISrvMonHeartbeatMessage

Returns:

The name of the system to which the server belongs.

lendSystemName

public final void lendSystemName(XString val)

Description copied from interface: ISrvMonHeartbeatMessage

Sets the value of 'systemName'

Field Description

The name of the system to which the server belongs.

Specified by:

lendSystemName in interface ISrvMonHeartbeatMessage

Parameters:

val - The value to set.

setSystemNameFrom

public final void setSystemNameFrom(long val)

Description copied from interface: ISrvMonHeartbeatMessage

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

Field Description

The name of the system to which the server belongs.

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

Specified by:

setSystemNameFrom in interface ISrvMonHeartbeatMessage

getSystemNameTo

public final <T extends XString> T getSystemNameTo(XString.Factory<T> factory)

Description copied from interface: ISrvMonHeartbeatMessage

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

Field Description

The name of the system to which the server belongs.

If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);

This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;

Specified by:

getSystemNameTo in interface ISrvMonHeartbeatMessage

Parameters:

factory - The factory from which to get the XString to copy into and return

Returns:

a new XString from the provided factory if this field is set or null.

setSystemNameFrom

public final void setSystemNameFrom(XString val)

Description copied from interface: ISrvMonHeartbeatMessage

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

Field Description

The name of the system to which the server belongs.

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

Specified by:

setSystemNameFrom in interface ISrvMonHeartbeatMessage

getSystemNameTo

public final void getSystemNameTo(XString val)

Description copied from interface: ISrvMonHeartbeatMessage

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

Field Description

The name of the system to which the server belongs.

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

Specified by:

getSystemNameTo in interface ISrvMonHeartbeatMessage

See Also:

ISrvMonHeartbeatMessage.getSystemName()

getSystemNameUnsafe

public final XString getSystemNameUnsafe()

Description copied from interface: ISrvMonHeartbeatMessage

Gets the raw value of 'systemName'.

Field Description

The name of the system to which the server belongs.

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.

Specified by:

getSystemNameUnsafe in interface ISrvMonHeartbeatMessage

Returns:

the field's raw value

See Also:

ISrvMonHeartbeatMessage.getSystemName()

setSystemNameFrom

public final void setSystemNameFrom(com.neeve.xbuf.XbufStringField val)

getSystemNameField

public final com.neeve.xbuf.XbufStringField getSystemNameField()

hasSystemName

public final boolean hasSystemName()

Description copied from interface: ISrvMonHeartbeatMessage

Checks for the presence of 'systemName'

Field Description

The name of the system to which the server belongs.

Specified by:

hasSystemName in interface ISrvMonHeartbeatMessage

See Also:

ISrvMonHeartbeatMessage.getSystemName()

clearSystemName

public final void clearSystemName()

Description copied from interface: ISrvMonHeartbeatMessage

Clears the value of 'systemName'

Field Description

The name of the system to which the server belongs.

Specified by:

clearSystemName in interface ISrvMonHeartbeatMessage

See Also:

ISrvMonHeartbeatMessage.setSystemName(String)

getSystemVersionFieldId

public static final int getSystemVersionFieldId()

Get the field id for 'systemVersion'

This method can be used to set field interests.

See Also:

getSystemVersion()

setSystemVersion

public final void setSystemVersion(String val)

Description copied from interface: ISrvMonHeartbeatMessage

Sets the value of 'systemVersion'

Field Description

The version of the system to which the server belongs.

Specified by:

setSystemVersion in interface ISrvMonHeartbeatMessage

Parameters:

val - The value to set.

getSystemVersion

public final String getSystemVersion()

Description copied from interface: ISrvMonHeartbeatMessage

Gets the value of 'systemVersion'

Field Description

The version of the system to which the server belongs.

Specified by:

getSystemVersion in interface ISrvMonHeartbeatMessage

Returns:

The version of the system to which the server belongs.

lendSystemVersion

public final void lendSystemVersion(XString val)

Description copied from interface: ISrvMonHeartbeatMessage

Sets the value of 'systemVersion'

Field Description

The version of the system to which the server belongs.

Specified by:

lendSystemVersion in interface ISrvMonHeartbeatMessage

Parameters:

val - The value to set.

setSystemVersionFrom

public final void setSystemVersionFrom(long val)

Description copied from interface: ISrvMonHeartbeatMessage

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

Field Description

The version of the system to which the server belongs.

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

Specified by:

setSystemVersionFrom in interface ISrvMonHeartbeatMessage

getSystemVersionTo

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

Description copied from interface: ISrvMonHeartbeatMessage

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

Field Description

The version of the system to which the server belongs.

If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);

This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;

Specified by:

getSystemVersionTo in interface ISrvMonHeartbeatMessage

Parameters:

factory - The factory from which to get the XString to copy into and return

Returns:

a new XString from the provided factory if this field is set or null.

setSystemVersionFrom

public final void setSystemVersionFrom(XString val)

Description copied from interface: ISrvMonHeartbeatMessage

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

Field Description

The version of the system to which the server belongs.

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

Specified by:

setSystemVersionFrom in interface ISrvMonHeartbeatMessage

getSystemVersionTo

public final void getSystemVersionTo(XString val)

Description copied from interface: ISrvMonHeartbeatMessage

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

Field Description

The version of the system to which the server belongs.

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

Specified by:

getSystemVersionTo in interface ISrvMonHeartbeatMessage

See Also:

ISrvMonHeartbeatMessage.getSystemVersion()

getSystemVersionUnsafe

public final XString getSystemVersionUnsafe()

Description copied from interface: ISrvMonHeartbeatMessage

Gets the raw value of 'systemVersion'.

Field Description

The version of the system to which the server belongs.

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.

Specified by:

getSystemVersionUnsafe in interface ISrvMonHeartbeatMessage

Returns:

the field's raw value

See Also:

ISrvMonHeartbeatMessage.getSystemVersion()

setSystemVersionFrom

public final void setSystemVersionFrom(com.neeve.xbuf.XbufStringField val)

getSystemVersionField

public final com.neeve.xbuf.XbufStringField getSystemVersionField()

hasSystemVersion

public final boolean hasSystemVersion()

Description copied from interface: ISrvMonHeartbeatMessage

Checks for the presence of 'systemVersion'

Field Description

The version of the system to which the server belongs.

Specified by:

hasSystemVersion in interface ISrvMonHeartbeatMessage

See Also:

ISrvMonHeartbeatMessage.getSystemVersion()

clearSystemVersion

public final void clearSystemVersion()

Description copied from interface: ISrvMonHeartbeatMessage

Clears the value of 'systemVersion'

Field Description

The version of the system to which the server belongs.

Specified by:

clearSystemVersion in interface ISrvMonHeartbeatMessage

See Also:

ISrvMonHeartbeatMessage.setSystemVersion(String)

isDirty

public final boolean isDirty()

createSchema

public static final com.neeve.xbuf.XbufSchema createSchema()

serializeToByteArray

public final byte[] serializeToByteArray()

Description copied from interface: MessageView

Serialize a view's backing message to a byte array.

Specified by:

serializeToByteArray in interface MessageView

serializeToByteBuffer

public final ByteBuffer serializeToByteBuffer()

Description copied from interface: MessageView

Serialize a view's backing message to a byte buffer.

Specified by:

serializeToByteBuffer in interface MessageView

serializeToIOBuffer

public final com.neeve.io.IOBuffer serializeToIOBuffer(boolean useNative)

Description copied from interface: MessageView

Serializes the MessageView to an IOBuffer.

Ownership of the returned IOBuffer is given to the caller which should dispose of it when done.

The buffer backing the IOBuffer should be flipped (ready for read) upon return.

Specified by:

serializeToIOBuffer in interface MessageView

Overrides:

serializeToIOBuffer in class MessageViewImpl

Parameters:

useNative - Whether the returned buffer should be native.

Returns:

The MessageView serialized to an IOBuffer.

serializeToPacket

public final PktPacket serializeToPacket()

Description copied from interface: MessageView

Serialize a view's backing message to a packet.

Specified by:

serializeToPacket in interface MessageView

deserializeFromByteArray

public final SrvMonHeartbeatMessage deserializeFromByteArray(byte[] array)

Description copied from interface: MessageView

Deserialize a view's backing message from a byte array.

Specified by:

deserializeFromByteArray in interface MessageView

Parameters:

array - The view's backing message serialized as a byte array.

deserializeFromByteBuffer

public final SrvMonHeartbeatMessage deserializeFromByteBuffer(ByteBuffer buffer)

Description copied from interface: MessageView

Deserialize a view's backing message from a byte buffer.

Specified by:

deserializeFromByteBuffer in interface MessageView

Parameters:

buffer - The view's backing message serialized as a byte buffer.

deserializeFromPacket

public final SrvMonHeartbeatMessage deserializeFromPacket(PktPacket packet)

Description copied from interface: MessageView

Deserialize a view's backing message from a packet.

Specified by:

deserializeFromPacket in interface MessageView

Parameters:

packet - The view's backing message serialized as a packet.

sync

public final void sync()

Description copied from interface: MessageView

Ensure a view's backing message is prepared and ready for transport

Specified by:

sync in interface MessageView

copy

public final SrvMonHeartbeatMessage copy()

Creates a copy of this SrvMonHeartbeatMessage.

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

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

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

Xbuf Pass-through Fields

When backed by a buffer, this operation copies the underlying buffer which means that if the message was deserialized from with unrecognized fields, such fields will be preserved in the copy as well.

Specified by:

copy in interface IRogCopyableNode<ISrvMonHeartbeatMessage>

Specified by:

copy in interface ISrvMonHeartbeatMessage

Specified by:

copy in interface CopyableMessageView<ISrvMonHeartbeatMessage>

Returns:

A copy of this SrvMonHeartbeatMessage.

See Also:

IRogCopyableNode, CopyableMessageView

copyInto

public final void copyInto(SrvMonHeartbeatMessage copy)

Copies the contents of this SrvMonHeartbeatMessage into the target.

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

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

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

Xbuf Pass-through Fields

When backed by a buffer, this operation copies the underlying buffer which means that if the message was deserialized from with unrecognized fields, such fields will be preserved in the copy as well.

Specified by:

copyInto in interface ISrvMonHeartbeatMessage

Parameters:

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

desync

public final int desync(PktBuffer buffer,
                        int pos,
                        boolean frameOnly)

Specified by:

desync in interface com.neeve.xbuf.IXbufDesyncer

needsSync

public boolean needsSync()

Description copied from interface: MessageReflector

Check if a view needs to be sync'd for reflection.

Specified by:

needsSync in interface MessageReflector

fieldExists

public final boolean fieldExists(Object message,
                                 String name)

Description copied from interface: MessageReflector

Check if a field of the supplied name exists in a message.

Specified by:

fieldExists in interface MessageReflector

Parameters:

message - The message to check in.

name - The field to check for.

isFieldReflectable

public final boolean isFieldReflectable(Object message,
                                        String name)

Description copied from interface: MessageReflector

Check if a field of the supplied name is reflectable.

Specified by:

isFieldReflectable in interface MessageReflector

Parameters:

message - The message to check in.

name - The field to check for.

Returns:

Returns null if a field of the supplied name is either not present in the message or is of a type that makes it non-reflectable.

getFieldValueAsString

public final String getFieldValueAsString(Object message,
                                          String name)

Description copied from interface: MessageReflector

Get the value of a reflectable field in a message as a string.

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.

Specified by:

getFieldValueAsString in interface MessageReflector

Parameters:

message - The message to introspect.

name - The field whose value is to be retrieved specified as a bean path

Returns:

Returns null if a field of the supplied name is not in the message or the field is of a type that is not reflectable or the field value is null. The caller should differentiate between these various cases through the use of the MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methods

getFieldValueAsString

public final String getFieldValueAsString(Object message,
                                          String[] pathComponents)

Description copied from interface: MessageReflector

Get the value of a reflectable field in a message as a string.

Specified by:

getFieldValueAsString in interface MessageReflector

Parameters:

message - The message to introspect.

pathComponents - The path components to use to access the field.

Returns:

Returns null if a field of the supplied pathComponents is not in the message or the field is of a type that is not reflectable or the field value is null. The caller should differentiate between these various cases through the use of the MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methods

getFieldValueAsRawString

public final XString getFieldValueAsRawString(Object message,
                                              String name)

Description copied from interface: MessageReflector

Get the value of a reflectable field in a message as a string.

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.

Specified by:

getFieldValueAsRawString in interface MessageReflector

Parameters:

message - The message to introspect.

name - The field whose value is to be retrieved specified as a bean path

Returns:

Returns null if a field of the supplied name is not in the message or the field is of a type that is not reflectable or the field value is null. The caller should differentiate between these various cases through the use of the MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methods

getFieldValueAsRawString

public final XString getFieldValueAsRawString(Object message,
                                              String[] pathComponents)

Description copied from interface: MessageReflector

Get the value of a reflectable field in a message as a string.

Specified by:

getFieldValueAsRawString in interface MessageReflector

Parameters:

message - The message to introspect.

pathComponents - The path components to use to access the field.

Returns:

Returns null if a field of the supplied pathComponents is not in the message or the field is of a type that is not reflectable or the field value is null. The caller should differentiate between these various cases through the use of the MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methods

appendFieldValueTo

public final boolean appendFieldValueTo(Object message,
                                        String name,
                                        XString target)

Description copied from interface: MessageReflector

Appends a reflected field value as a string into the given XString.

If the field is reflectable and has a non null value, then it will be appended otherwise, this method must return false.

Specified by:

appendFieldValueTo in interface MessageReflector

Overrides:

appendFieldValueTo in class com.neeve.rog.impl.RogNode

Parameters:

message - the node on which to reflect (which need not be this object).

name - the bean path to the field.

target - The target XString into which to append the result.

Returns:

true if the field was reflectable and had a value which could be appended, false otherwise.

appendFieldValueTo

public final boolean appendFieldValueTo(Object node,
                                        String[] pathComponents,
                                        XString target)

Description copied from interface: MessageReflector

Appends a reflected field value as a string into the given XString.

If the field is reflectable and has a non null value, then it will be appended otherwise, this method must return false.

Specified by:

appendFieldValueTo in interface MessageReflector

Overrides:

appendFieldValueTo in class com.neeve.rog.impl.RogNode

Parameters:

node - 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.

Returns:

true if the field was reflectable and had a value which could be appended, false otherwise.

getContentEncodingType

public final IStoreObject.EncodingType getContentEncodingType()

Description copied from interface: IStoreObject

Get an object's content data encoding type.

Specified by:

getContentEncodingType in interface IStoreObject

serialize

public final PktPacket serialize()

Description copied from interface: IStoreObject

Serialize an object's data.

Specified by:

serialize in interface IStoreObject

deserialize

public final SrvMonHeartbeatMessage deserialize(PktPacket packet)

Description copied from interface: IStoreObject

Deserialize an object's data.

Specified by:

deserialize in interface IStoreObject

Parameters:

packet - The object in serialized form.

Returns:

Returns 'this' object for invocation chaining.

setFieldValue

public final IStoreObject setFieldValue(int id,
                                        Object val)

Description copied from interface: IStoreObject

Set the value of an object field.

Specified by:

setFieldValue in interface IStoreObject

Overrides:

setFieldValue in class com.neeve.rog.impl.RogNode

Returns:

Returns this object for invocation chaining.

This method is invoked during the rollback process to restore field values.

toJsonString

public final String toJsonString(boolean includeMetadata,
                                 String metadataObjectName,
                                 String payloadObjectName)

Description copied from interface: IRogJsonizable

Get a full JSON representation of an ROG entity

Specified by:

toJsonString in interface IRogJsonizable

Parameters:

includeMetadata - 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.

toJsonString

public final String toJsonString()

Description copied from interface: IRogJsonizable

Get a JSON representation of an ROG entity

Specified by:

toJsonString in interface IRogJsonizable

toString

public final String toString()

Description copied from class: MessageViewImpl

Return a string representation of this object

Overrides:

toString in class com.neeve.rog.impl.RogNode