com.neeve.service.messages

Interface IPostMessageProcessingTimesRequest

All Superinterfaces:

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

All Known Implementing Classes:

PostMessageProcessingTimesRequest

@Generated(value="com.neeve.adm.AdmGenerator",
           date="Fri Dec 05 11:53:59 EST 2025")
 @AdmGenerated(compatLevel="4.1.0",
              admVersion="Unknown Version",
              date="12/5/25 11:53 AM",
              buildInfo="nvx-eagle-2.9-SNAPSHOT Json Encoding")
public interface IPostMessageProcessingTimesRequest
extends IRogNode, IRogMessage, IRogCopyableNode<IPostMessageProcessingTimesRequest>

The 'PostMessageProcessingTimesRequest' type.

ADM Details

ADM Type	Message
Factory	MessageFactory

ADM Field Summary

Field	Type	Id	Description
header	MessageHeader	32737	No doc provided.
times	MessageProcessingTime[]	32736	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

Method Summary

Modifier and Type	Method and Description
void	addTimes(MessageProcessingTime val) Adds the provided value to the list of 'times' values.
void	clearHeader() Clears the value of 'header'.
void	clearTimes() Clears the value of 'times'.
PostMessageProcessingTimesRequest	copy() Creates a copy of this PostMessageProcessingTimesRequest.
void	copyInto(PostMessageProcessingTimesRequest target) Copies the contents of this PostMessageProcessingTimesRequest into the target.
MessageHeader	getHeader() Gets the value of 'header'.
void	getHeaderTo(MessageHeader val) Copies the value of MessageHeader into the provided value.
MessageProcessingTime[]	getTimes() Gets the value of 'times'.
MessageProcessingTime[]	getTimesEmptyIfNull() Gets the value of 'times' or an empty array if the value is null or not set.
XIterator<MessageProcessingTime>	getTimesIterator() Gets the value of 'times' as iterator of values.
boolean	hasHeader() Checks for the presence of 'header'.
void	lendHeader(MessageHeader val) 'Lends' a reference of the MessageHeader to the message for this field.
void	lendTimes(MessageProcessingTime val) Adds the provided value to the list of 'times' values and acquires a reference to it.
void	lendTimes(MessageProcessingTime[] val) Lends the value of 'times'.
void	lendTimesFrom(XIterator<MessageProcessingTime> val) Sets the value of 'times' by lending the values from the provided iterator.
void	setHeader(MessageHeader val) Sets the value of 'header'.
void	setTimes(MessageProcessingTime[] val) Sets the value of 'times'.
void	setTimesFrom(XIterator<MessageProcessingTime> val) Sets the value of 'times' using the values from the provided iterator.
MessageHeader	takeHeader() 'Takes' a reference to the header field from the message.
MessageProcessingTime[]	takeTimes() Takes the value of 'times'.

Methods inherited from interface com.neeve.rog.IRogNode

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

Methods inherited from interface com.neeve.ods.IStoreObject

acquire, deserialize, deserializeMetadata, deserializeMetadata, getContentEncodingType, getOwnershipCount, getSerializedMetadataLength, getStoreMetadata, saveMemory, serialize, 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

Method Detail

setHeader

void setHeader(MessageHeader val)

Sets the value of 'header'.

Parameters:

val - The value to set.

lendHeader

void lendHeader(MessageHeader val)

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

Parameters:

val - the value to 'lend' to lend.

getHeader

MessageHeader getHeader()

Gets the value of 'header'.

Returns:

The value of 'header'

getHeaderTo

void getHeaderTo(MessageHeader val)

Copies the value of MessageHeader into the provided value.

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

Parameters:

val - the value to copy into

See Also:

MessageHeader.copyInto(MessageHeader)

takeHeader

MessageHeader takeHeader()

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

Returns:

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

hasHeader

boolean hasHeader()

Checks for the presence of 'header'.

See Also:

getHeader()

clearHeader

void clearHeader()

Clears the value of 'header'.

See Also:

setHeader(MessageHeader)

setTimes

void setTimes(MessageProcessingTime[] val)

Sets the value of 'times'.

Parameters:

val - The value to set.

setTimesFrom

void setTimesFrom(XIterator<MessageProcessingTime> val)

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

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

Parameters:

val - the values to set.

lendTimesFrom

void lendTimesFrom(XIterator<MessageProcessingTime> val)

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

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

Parameters:

val - the values to set.

addTimes

void addTimes(MessageProcessingTime val)

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

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

Parameters:

val - the value to add.

lendTimes

void lendTimes(MessageProcessingTime val)

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

Parameters:

val - the value to add.

lendTimes

void lendTimes(MessageProcessingTime[] val)

Lends the value of 'times'.

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

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

Parameters:

val - the value to 'lend' to lend.

getTimesIterator

XIterator<MessageProcessingTime> getTimesIterator()

Gets the value of 'times' 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 it intends to keep beyond the either the next call to next(), toFirst() or the lifespace of this object as each object returned by this iterator is disposed on a subsequent call to next() or when this object is disposed.

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

Returns:

An iterator containing this field values.

getTimes

MessageProcessingTime[] getTimes()

Gets the value of 'times'.

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

Returns:

The value of 'times' If the field is not set this method will return null.

getTimesEmptyIfNull

MessageProcessingTime[] getTimesEmptyIfNull()

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

Returns:

The value of 'times' or an empty array if null if not set.

See Also:

getTimes()

takeTimes

MessageProcessingTime[] takeTimes()

Takes the value of 'times'.

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

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

Returns:

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

clearTimes

void clearTimes()

Clears the value of 'times'.

See Also:

setTimes(MessageProcessingTime[])

copy

PostMessageProcessingTimesRequest copy()

Creates a copy of this PostMessageProcessingTimesRequest.

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

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

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

Specified by:

copy in interface CopyableMessageView<IPostMessageProcessingTimesRequest>

Specified by:

copy in interface IRogCopyableNode<IPostMessageProcessingTimesRequest>

Returns:

A copy of this PostMessageProcessingTimesRequest.

See Also:

IRogCopyableNode, CopyableMessageView

copyInto

void copyInto(PostMessageProcessingTimesRequest target)

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

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

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

Parameters:

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