com.neeve.server.mon
Interface ISrvMonAppStateChangeMessage

All Superinterfaces:
CopyableMessageView<ISrvMonAppStateChangeMessage>, IRogCopyableNode<ISrvMonAppStateChangeMessage>, IRogMessage, IRogMetadata, IRogNode, IRogValidatable, IStoreObject, MapMessageView, MessageView, UtlReferenceTracker.HasReferenceTracker
All Known Implementing Classes:
SrvMonAppStateChangeMessage

@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 ISrvMonAppStateChangeMessage
extends IRogNode, IRogMessage, IRogCopyableNode<ISrvMonAppStateChangeMessage>

Emitted by a Talon Server to registered admin clients when an app's state has changed.


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 clearAppName()
          Clears the value of 'appName' Field Description The name of the app.
 void clearAppState()
          Clears the value of 'appState' Field Description The new app state.
 SrvMonAppStateChangeMessage copy()
          Creates a copy of this SrvMonAppStateChangeMessage.
 void copyInto(SrvMonAppStateChangeMessage target)
          Copies the contents of this SrvMonAppStateChangeMessage into the target.
 String getAppName()
          Gets the value of 'appName' Field Description The name of the app.
<T extends XString>
T
getAppNameTo(XString.Factory<T> factory)
          Copies the value of this String field into a new XString from the given factory.
 void getAppNameTo(XString val)
          Copies the value of 'appName' into the provided XString.
 XString getAppNameUnsafe()
          Gets the raw value of 'appName'.
 SrvMonAppState getAppState()
          Gets the value of 'appState' Field Description The new app state.
 boolean hasAppName()
          Checks for the presence of 'appName' Field Description The name of the app.
 boolean hasAppState()
          Checks for the presence of 'appState' Field Description The new app state.
 void lendAppName(XString val)
          Sets the value of 'appName' Field Description The name of the app.
 void setAppName(String val)
          Sets the value of 'appName' Field Description The name of the app.
 void setAppNameFrom(long val)
          Sets the value of this String field to the given numeric value.
 void setAppNameFrom(XString val)
          Copies the provided XString value into this object's 'appName'.
 void setAppState(SrvMonAppState val)
          Sets the value of 'appState' Field Description The new app state.
 
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

setAppState

void setAppState(SrvMonAppState val)
Sets the value of 'appState'

Field Description

The new app state.

Parameters:
val - The value to set.

getAppState

SrvMonAppState getAppState()
Gets the value of 'appState'

Field Description

The new app state.

Returns:
The new app state.

clearAppState

void clearAppState()
Clears the value of 'appState'

Field Description

The new app state.

See Also:
setAppState(SrvMonAppState)

hasAppState

boolean hasAppState()
Checks for the presence of 'appState'

Field Description

The new app state.

See Also:
getAppState()

setAppName

void setAppName(String val)
Sets the value of 'appName'

Field Description

The name of the app.

Parameters:
val - The value to set.

getAppName

String getAppName()
Gets the value of 'appName'

Field Description

The name of the app.

Returns:
The name of the app.

lendAppName

void lendAppName(XString val)
Sets the value of 'appName'

Field Description

The name of the app.

Parameters:
val - The value to set.

setAppNameFrom

void setAppNameFrom(long val)
Sets the value of this String field to the given numeric value.

Field Description

The name of the app.

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


getAppNameTo

<T extends XString> T getAppNameTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory.

Field Description

The name of the app.

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;

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.
Throws:
NullPointerException - if the provided factory is null

setAppNameFrom

void setAppNameFrom(XString val)
Copies the provided XString value into this object's 'appName'.

Field Description

The name of the app.

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


getAppNameTo

void getAppNameTo(XString val)
Copies the value of 'appName' into the provided XString.

Field Description

The name of the app.

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

See Also:
getAppName()

getAppNameUnsafe

XString getAppNameUnsafe()
Gets the raw value of 'appName'.

Field Description

The name of the app.

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.

Returns:
the field's raw value
See Also:
getAppName()

clearAppName

void clearAppName()
Clears the value of 'appName'

Field Description

The name of the app.

See Also:
setAppName(String)

hasAppName

boolean hasAppName()
Checks for the presence of 'appName'

Field Description

The name of the app.

See Also:
getAppName()

copy

SrvMonAppStateChangeMessage copy()
Creates a copy of this SrvMonAppStateChangeMessage.

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

The returned copy will be writeable even if this SrvMonAppStateChangeMessage 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<ISrvMonAppStateChangeMessage>
Specified by:
copy in interface IRogCopyableNode<ISrvMonAppStateChangeMessage>
Returns:
A copy of this SrvMonAppStateChangeMessage.
See Also:
IRogCopyableNode, CopyableMessageView

copyInto

void copyInto(SrvMonAppStateChangeMessage target)
Copies the contents of this SrvMonAppStateChangeMessage 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 SrvMonAppStateChangeMessage's embedded entity fields.

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


Copyright © 2016 Neeve Research, LLC. All Rights Reserved.