com.neeve.service.messages

Class Heartbeat

java.lang.Object

com.neeve.util.UtlListElement

com.neeve.sma.MessageViewImpl

com.neeve.rog.impl.RogNode

com.neeve.service.messages.Heartbeat

All Implemented Interfaces:

IStoreObject, IStoreObjectMetadata, IRogCopyableNode<IHeartbeat>, IRogJsonizable, IRogMessage, IRogMetadata, IRogNode, IRogValidatable, IHeartbeat, CopyableMessageView<IHeartbeat>, MapMessageView, MessageReflector, MessageView, UtlReferenceTracker.HasReferenceTracker

@Generated(value="com.neeve.adm.AdmJsonGenerator",
           date="Fri Dec 05 11:53:59 EST 2025")
 @AdmGenerated(encoding="Json",
              compatLevel="4.1.0",
              admVersion="Unknown Version",
              date="12/5/25 11:53 AM",
              buildInfo="nvx-eagle-2.9-SNAPSHOT Json Encoding")
 @AdmFactoryInfo(factoryClass=MessageFactory.class,
                vfid=132,
                ofid=132,
                typeId=6)
public final class Heartbeat
extends com.neeve.rog.impl.RogNode
implements IHeartbeat, IRogJsonizable, MessageReflector

The 'Heartbeat' type.

ADM Details

ADM Type	Message
Factory	MessageFactory

ADM Field Summary

Field	Type	Id	Description
agentInfo	AgentInfo	32736	No doc provided.
header	MessageHeader	32737	No doc provided.

Nested Class Summary

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

IRogNode.PoolingListener

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

IStoreObject.EncodingType

Field Summary

Fields

Modifier and Type	Field and Description
static Heartbeat[]	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, LAST_ROG_FID, readOnly, transactional

Fields inherited from class com.neeve.sma.MessageViewImpl

message, messageEncodingType, ownershipCount, type, vfid

Fields inherited from class com.neeve.util.UtlListElement

count, head, next, prev

Method Summary

Modifier and Type	Method and Description
boolean	appendFieldValueTo(Object node, String[] pathComponents, XString target)
boolean	appendFieldValueTo(Object message, String name, XString target)
void	clearAgentInfo() Clears the value of 'agentInfo'.
void	clearContent()
void	clearHeader() Clears the value of 'header'.
Heartbeat	copy() Creates a copy of this Heartbeat.
void	copyInto(Heartbeat copy) Copies the contents of this Heartbeat into the target.
static Heartbeat	create()
static Heartbeat	create(com.eaio.uuid.UUID id)
static Heartbeat	createFrom(byte[] serializedJson)
static Heartbeat	createFromJson(String json)
static Heartbeat	createFromRawJson(String json)
static Heartbeat	createFromSerializedJson(byte[] serializedJson)
static Heartbeat	createFromSerializedJson(ByteBuffer serializedJson)
Heartbeat	deserialize(PktPacket packet)
Heartbeat	deserializeFromByteArray(byte[] array)
Heartbeat	deserializeFromByteBuffer(ByteBuffer buffer)
Heartbeat	deserializeFromJson(String json)
Heartbeat	deserializeFromPacket(PktPacket packet)
Heartbeat	deserializeFromProtobuf(com.google.protobuf.Message message)
Heartbeat	deserializeFromRawJson(String json)
boolean	fieldExists(Object message, String name)
AgentInfo	getAgentInfo() Gets the value of 'agentInfo'.
static int	getAgentInfoFieldId()
void	getAgentInfoTo(AgentInfo to) Copies the value of AgentInfo into the provided value.
IStoreObject.EncodingType	getContentEncodingType()
XString	getFieldValueAsRawString(Object message, String name)
XString	getFieldValueAsRawString(Object message, String[] pathComponents)
String	getFieldValueAsString(Object message, String name)
String	getFieldValueAsString(Object message, String[] pathComponents)
MessageHeader	getHeader() Gets the value of 'header'.
static int	getHeaderFieldId()
void	getHeaderTo(MessageHeader to) Copies the value of MessageHeader into the provided value.
boolean	hasAgentInfo() Checks for the presence of 'agentInfo'.
boolean	hasHeader() Checks for the presence of 'header'.
boolean	isFieldReflectable(Object message, String name)
void	lendAgentInfo(AgentInfo val) 'Lends' a reference of the AgentInfo to the message for this field.
void	lendHeader(MessageHeader val) 'Lends' a reference of the MessageHeader to the message for this field.
boolean	needsSync()
PktPacket	serialize()
byte[]	serializeToByteArray()
ByteBuffer	serializeToByteBuffer()
String	serializeToJson()
PktPacket	serializeToPacket()
com.google.protobuf.Message	serializeToProtobuf()
String	serializeToRawJson()
void	setAgentInfo(AgentInfo val) Sets the value of 'agentInfo'.
void	setAsReadOnly()
IStoreObject	setFieldValue(int id, Object val)
void	setHeader(MessageHeader val) Sets the value of 'header'.
void	sync()
AgentInfo	takeAgentInfo() 'Takes' a reference to the agentInfo field from the message.
MessageHeader	takeHeader() 'Takes' a reference to the header field from the message.
String	toJsonString()
String	toJsonString(boolean includeMetadata, String metadataObjectName, String payloadObjectName)
String	toString()
protected void	visitFields(com.neeve.rog.impl.RogGraphVisitor visitor)

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

accept, deserializeMetadata, deserializeMetadata, dispose, dump, ensureId, getAppSendBeginTs, getAppSendDoneTs, getAttachment, getBinding, getCheckpointVersion, getCommittedDataSize, getCreateTs, getEnqueueTs, getEnqueueTsMicros, getFields, getGraphId, getId, getInMsgsInTransaction, getIsInboundMessage, getIsInternal, getIsLastTransaction, getIsLiveInboundMessage, getIsMessage, getIsOutboundMessage, getIsPriority, getIsReadOnly, getIsReplayedMessage, getLastFid, getMessageBus, getMessageBusAsRaw, getMessageChannel, getMessageChannelAsRaw, getMessageFlow, getMessageKey, getMessageKeyAsRaw, getMessageReflector, getMessageSender, getMessageSequenceNumber, getMessageTransportHeaders, getMetadata, getOfid, getOriginTs, getOutMsgsInTransaction, getOutTs, getOutTsMicros, getParent, getParentId, getPoolingListener, getPostDeserializeTs, getPostProcessingTs, getPostProcessingTsMicros, getPostSerializeTs, getPostWireSendTs, getPostWireTs, getPreDeserializeTs, getPreProcessingTs, getPreProcessingTsMicros, getPreSerializeTs, getPreWireTs, getReceiveTs, getSendStartTs, getSendTs, getSerializedMetadataLength, getStableTransactionId, getStoreMetadata, getTransactionId, getTransactionInSequenceNumber, getTransactionOutSequenceNumber, getTypeFromJson, getValidationErrors, isPossibleDuplicate, isValid, metadataToJsonString, metadataToJsonString, metadataToString, recordAsDirty, recordFieldUpdate, recordFieldUpdate, resolveMessageKeyWith, resolveMessageKeyWith, saveMemory, serializeMetadata, setAppSendBeginTs, setAppSendDoneTs, setAsInboundMessage, setAsInternal, setAsLastTransaction, setAsMessage, setAsOutboundMessage, setAsPriority, setAsReplayedMessage, setAttachment, setBinding, setCheckpointVersion, setCommittedDataSize, setCreateTs, setEnqueueTsMicros, setFieldValue, setGraphId, setId, setInMsgsInTransaction, setMessageBus, setMessageBusAsRaw, setMessageChannel, setMessageChannelAsRaw, setMessageFlow, setMessageKey, setMessageKeyAsRaw, setMessageReflector, setMessageSender, setMessageSequenceNumber, setMessageTransportHeaders, setOriginTs, setOutMsgsInTransaction, setOutTs, setOutTsMicros, setParentId, setPoolingListener, setPossibleDuplicate, setPostDeserializeTs, setPostProcessingTs, setPostProcessingTsMicros, setPostSerializeTs, setPostWireSendTs, setPostWireTs, setPreDeserializeTs, setPreProcessingTs, setPreProcessingTsMicros, setPreSerializeTs, setPreWireTs, setReceiveTs, setSendStartTs, setSendTs, setStableTransactionId, setTransactionId, setTransactionInSequenceNumber, setTransactionOutSequenceNumber, toDumpString, undispose, visitField, visitField

Methods inherited from class com.neeve.sma.MessageViewImpl

acquire, copyCopyableFieldsToCopy, deserializeFrom, deserializeFrom, deserializeFrom, deserializeFrom, deserializeFrom, deserializeFrom, getMessage, getMessageEncodingType, getOwnershipCount, getTag, getType, getVfid, isPooled, referenceTracker, serializeTo, serializeTo, serializeTo, serializeTo, serializeTo, serializeTo, serializeToIOBuffer, setMessage, setTag, undispose

Methods inherited from class com.neeve.util.UtlListElement

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.neeve.rog.IRogNode

dispose, dump, getAttachment, getIsLiveInboundMessage, 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, getOwnershipCount, getSerializedMetadataLength, getStoreMetadata, saveMemory, serializeMetadata, setFieldValue

Methods inherited from interface com.neeve.ods.IStoreObjectMetadata

ensureId, getBinding, getCheckpointVersion, getCommittedDataSize, getId, getOfid, getStableTransactionId, getTransactionId, setBinding, setCheckpointVersion, setCommittedDataSize, 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, getMessageTransportHeaders, 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 Heartbeat[] EMPTY_ARRAY

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

Method Detail

create

public static Heartbeat create()

create

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

createFromRawJson

public static Heartbeat createFromRawJson(String json)

createFromJson

public static Heartbeat createFromJson(String json)

createFromSerializedJson

public static Heartbeat createFromSerializedJson(ByteBuffer serializedJson)

createFromSerializedJson

public static Heartbeat createFromSerializedJson(byte[] serializedJson)

createFrom

public static Heartbeat createFrom(byte[] serializedJson)

clearContent

public final void clearContent()

serializeToProtobuf

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

Specified by:

serializeToProtobuf in interface IRogNode

serializeToRawJson

public final String serializeToRawJson()

serializeToJson

public final String serializeToJson()

Specified by:

serializeToJson in interface MessageView

deserializeFromProtobuf

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

Specified by:

deserializeFromProtobuf in interface IRogNode

deserializeFromRawJson

public final Heartbeat deserializeFromRawJson(String json)

deserializeFromJson

public final Heartbeat deserializeFromJson(String json)

Specified by:

deserializeFromJson in interface MessageView

setAsReadOnly

public final void setAsReadOnly()

Specified by:

setAsReadOnly in interface IRogNode

Overrides:

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

getHeaderFieldId

public static final int getHeaderFieldId()

setHeader

public final void setHeader(MessageHeader val)

Description copied from interface: IHeartbeat

Sets the value of 'header'.

Specified by:

setHeader in interface IHeartbeat

Parameters:

val - The value to set.

lendHeader

public final void lendHeader(MessageHeader val)

Description copied from interface: IHeartbeat

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

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:

lendHeader in interface IHeartbeat

Parameters:

val - the value to 'lend' to lend.

getHeader

public final MessageHeader getHeader()

Description copied from interface: IHeartbeat

Gets the value of 'header'.

Specified by:

getHeader in interface IHeartbeat

Returns:

The value of 'header'

getHeaderTo

public final void getHeaderTo(MessageHeader to)

Description copied from interface: IHeartbeat

Copies the value of MessageHeader into the provided value.

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

Specified by:

getHeaderTo in interface IHeartbeat

Parameters:

to - the value to copy into

See Also:

MessageHeader.copyInto(MessageHeader)

takeHeader

public final MessageHeader takeHeader()

Description copied from interface: IHeartbeat

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

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:

takeHeader in interface IHeartbeat

Returns:

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

clearHeader

public final void clearHeader()

Description copied from interface: IHeartbeat

Clears the value of 'header'.

Specified by:

clearHeader in interface IHeartbeat

See Also:

IHeartbeat.setHeader(MessageHeader)

hasHeader

public final boolean hasHeader()

Description copied from interface: IHeartbeat

Checks for the presence of 'header'.

Specified by:

hasHeader in interface IHeartbeat

See Also:

IHeartbeat.getHeader()

getAgentInfoFieldId

public static final int getAgentInfoFieldId()

setAgentInfo

public final void setAgentInfo(AgentInfo val)

Description copied from interface: IHeartbeat

Sets the value of 'agentInfo'.

Specified by:

setAgentInfo in interface IHeartbeat

Parameters:

val - The value to set.

lendAgentInfo

public final void lendAgentInfo(AgentInfo val)

Description copied from interface: IHeartbeat

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

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:

lendAgentInfo in interface IHeartbeat

Parameters:

val - the value to 'lend' to lend.

getAgentInfo

public final AgentInfo getAgentInfo()

Description copied from interface: IHeartbeat

Gets the value of 'agentInfo'.

Specified by:

getAgentInfo in interface IHeartbeat

Returns:

The value of 'agentInfo'

getAgentInfoTo

public final void getAgentInfoTo(AgentInfo to)

Description copied from interface: IHeartbeat

Copies the value of AgentInfo into the provided value.

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

Specified by:

getAgentInfoTo in interface IHeartbeat

Parameters:

to - the value to copy into

See Also:

AgentInfo.copyInto(AgentInfo)

takeAgentInfo

public final AgentInfo takeAgentInfo()

Description copied from interface: IHeartbeat

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

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:

takeAgentInfo in interface IHeartbeat

Returns:

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

clearAgentInfo

public final void clearAgentInfo()

Description copied from interface: IHeartbeat

Clears the value of 'agentInfo'.

Specified by:

clearAgentInfo in interface IHeartbeat

See Also:

IHeartbeat.setAgentInfo(AgentInfo)

hasAgentInfo

public final boolean hasAgentInfo()

Description copied from interface: IHeartbeat

Checks for the presence of 'agentInfo'.

Specified by:

hasAgentInfo in interface IHeartbeat

See Also:

IHeartbeat.getAgentInfo()

serializeToByteArray

public final byte[] serializeToByteArray()

Specified by:

serializeToByteArray in interface MessageView

serializeToByteBuffer

public final ByteBuffer serializeToByteBuffer()

Specified by:

serializeToByteBuffer in interface MessageView

serializeToPacket

public final PktPacket serializeToPacket()

Specified by:

serializeToPacket in interface MessageView

deserializeFromByteArray

public final Heartbeat deserializeFromByteArray(byte[] array)

Specified by:

deserializeFromByteArray in interface MessageView

deserializeFromByteBuffer

public final Heartbeat deserializeFromByteBuffer(ByteBuffer buffer)

Specified by:

deserializeFromByteBuffer in interface MessageView

deserializeFromPacket

public final Heartbeat deserializeFromPacket(PktPacket packet)

Specified by:

deserializeFromPacket in interface MessageView

sync

public final void sync()

Specified by:

sync in interface MessageView

copy

public final Heartbeat copy()

Description copied from interface: IHeartbeat

Creates a copy of this Heartbeat.

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 Heartbeat's embedded entity fields.

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

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

Specified by:

copy in interface IRogCopyableNode<IHeartbeat>

Specified by:

copy in interface IHeartbeat

Specified by:

copy in interface CopyableMessageView<IHeartbeat>

Returns:

A copy of this Heartbeat.

See Also:

IRogCopyableNode, CopyableMessageView

copyInto

public final void copyInto(Heartbeat copy)

Description copied from interface: IHeartbeat

Copies the contents of this Heartbeat 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 Heartbeat's embedded entity fields.

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

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

Specified by:

copyInto in interface IHeartbeat

Parameters:

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

needsSync

public boolean needsSync()

Specified by:

needsSync in interface MessageReflector

fieldExists

public final boolean fieldExists(Object message,
                                 String name)

Specified by:

fieldExists in interface MessageReflector

isFieldReflectable

public final boolean isFieldReflectable(Object message,
                                        String name)

Specified by:

isFieldReflectable in interface MessageReflector

getFieldValueAsString

public final String getFieldValueAsString(Object message,
                                          String name)

Specified by:

getFieldValueAsString in interface MessageReflector

getFieldValueAsString

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

Specified by:

getFieldValueAsString in interface MessageReflector

getFieldValueAsRawString

public final XString getFieldValueAsRawString(Object message,
                                              String name)

Specified by:

getFieldValueAsRawString in interface MessageReflector

getFieldValueAsRawString

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

Specified by:

getFieldValueAsRawString in interface MessageReflector

appendFieldValueTo

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

Specified by:

appendFieldValueTo in interface MessageReflector

Overrides:

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

appendFieldValueTo

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

Specified by:

appendFieldValueTo in interface MessageReflector

Overrides:

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

getContentEncodingType

public final IStoreObject.EncodingType getContentEncodingType()

Specified by:

getContentEncodingType in interface IStoreObject

serialize

public final PktPacket serialize()

Specified by:

serialize in interface IStoreObject

deserialize

public final Heartbeat deserialize(PktPacket packet)

Specified by:

deserialize in interface IStoreObject

setFieldValue

public final IStoreObject setFieldValue(int id,
                                        Object val)

toJsonString

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

Specified by:

toJsonString in interface IRogJsonizable

toJsonString

public final String toJsonString()

Specified by:

toJsonString in interface IRogJsonizable

visitFields

protected final void visitFields(com.neeve.rog.impl.RogGraphVisitor visitor)

Overrides:

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

toString

public final String toString()

Overrides:

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