com.neeve.server.mon
Interface ISrvMonAppLoadedMessage

All Superinterfaces:

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

All Known Implementing Classes:

SrvMonAppLoadedMessage

@Generated(value="com.neeve.adm.AdmGenerator",
           date="Wed Mar 28 10:54:31 EDT 2018")
@AdmGenerated(compatLevel="3.8.0",
              admVersion="nvx-adm v3.7.265 (build 0)",
              date="3/28/18 10:54 AM",
              buildInfo="nvx-talon-3.7.265 (nvx-codegen-plugin)")
public interface ISrvMonAppLoadedMessage
extends IRogNode, IRogMessage, IRogCopyableNode<ISrvMonAppLoadedMessage>

Emitted by a Talon Server to registered admin clients when an app has been loaded.

Nested Class Summary

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

IRogNode.PoolingListener

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

IStoreObject.EncodingType

Method Summary

void	clearAppInfo() Clears the value of 'appInfo' Field Description Holds information about the newly created app.
SrvMonAppLoadedMessage	copy() Creates a copy of this SrvMonAppLoadedMessage.
void	copyInto(SrvMonAppLoadedMessage target) Copies the contents of this SrvMonAppLoadedMessage into the target.
SrvMonAppInfo	getAppInfo() Gets the value of 'appInfo' Field Description Holds information about the newly created app.
void	getAppInfoTo(SrvMonAppInfo val) Copies the value of SrvMonAppInfo into the provided value.
boolean	hasAppInfo() Checks for the presence of 'appInfo' Field Description Holds information about the newly created app.
void	lendAppInfo(SrvMonAppInfo val) 'Lends' a reference of the SrvMonAppInfo to the message for this field.
void	setAppInfo(SrvMonAppInfo val) Sets the value of 'appInfo' Field Description Holds information about the newly created app.
SrvMonAppInfo	takeAppInfo() 'Takes' a reference to the appInfo field from the message.

Methods inherited from interface com.neeve.rog.IRogNode

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

Methods inherited from interface com.neeve.ods.IStoreObject

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

Methods inherited from interface com.neeve.sma.MapMessageView

getMessageReflector

Methods inherited from interface com.neeve.rog.IRogMetadata

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

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

setAppInfo

void setAppInfo(SrvMonAppInfo val)

Sets the value of 'appInfo'

Field Description

Holds information about the newly created app.

Parameters:

val - The value to set.

lendAppInfo

void lendAppInfo(SrvMonAppInfo val)

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

Field Description

Holds information about the newly created app.

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.

getAppInfo

SrvMonAppInfo getAppInfo()

Gets the value of 'appInfo'

Field Description

Holds information about the newly created app.

Returns:

Holds information about the newly created app.

getAppInfoTo

void getAppInfoTo(SrvMonAppInfo val)

Copies the value of SrvMonAppInfo into the provided value.

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

Parameters:

val - the value to copy into

See Also:

SrvMonAppInfo.copyInto(SrvMonAppInfo)

takeAppInfo

SrvMonAppInfo takeAppInfo()

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

Field Description

Holds information about the newly created app.

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.

hasAppInfo

boolean hasAppInfo()

Checks for the presence of 'appInfo'

Field Description

Holds information about the newly created app.

See Also:

getAppInfo()

clearAppInfo

void clearAppInfo()

Clears the value of 'appInfo'

Field Description

Holds information about the newly created app.

See Also:

setAppInfo(SrvMonAppInfo)

copy

SrvMonAppLoadedMessage copy()

Creates a copy of this SrvMonAppLoadedMessage.

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

The returned copy will be writeable even if this SrvMonAppLoadedMessage 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<ISrvMonAppLoadedMessage>

Specified by:

copy in interface IRogCopyableNode<ISrvMonAppLoadedMessage>

Returns:

A copy of this SrvMonAppLoadedMessage.

See Also:

IRogCopyableNode, CopyableMessageView

copyInto

void copyInto(SrvMonAppLoadedMessage target)

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

The returned copy will be writeable even if this SrvMonAppLoadedMessage 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.