com.neeve.server.mon.lifecycle
Interface ISrvMonAppMessagingStartedMessage

All Superinterfaces:

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

All Known Implementing Classes:

SrvMonAppMessagingStartedMessage

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

Event notifying an AEP application that its messaging has been started.

This event is dispatched to an application to notify it that the AEP engine has started its messaging machinery. This event is dispatched after the engine has attempted to establish the application's message bus bindings and join any configured channels. For bindings that were successfully established, the application would have received the coresponding channel up events before this event is dispatched.

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	clearStatus() Clears the value of 'status' Field Description This field will be unset for a successful startup, otherwise it will contain a string representation of the error.
void	clearTimestamp() Clears the value of 'timestamp' Field Description The timestamp at which this event occurred (millis since the epoch).
SrvMonAppMessagingStartedMessage	copy() Creates a copy of this SrvMonAppMessagingStartedMessage.
void	copyInto(SrvMonAppMessagingStartedMessage target) Copies the contents of this SrvMonAppMessagingStartedMessage into the target.
String	getStatus() Gets the value of 'status' Field Description This field will be unset for a successful startup, otherwise it will contain a string representation of the error.
<T extends XString> T	getStatusTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getStatusTo(XString val) Copies the value of 'status' into the provided XString.
XString	getStatusUnsafe() Gets the raw value of 'status'.
long	getTimestamp() Gets the value of 'timestamp' Field Description The timestamp at which this event occurred (millis since the epoch).
boolean	hasStatus() Checks for the presence of 'status' Field Description This field will be unset for a successful startup, otherwise it will contain a string representation of the error.
boolean	hasTimestamp() Checks for the presence of 'timestamp' Field Description The timestamp at which this event occurred (millis since the epoch).
void	lendStatus(XString val) Sets the value of 'status' Field Description This field will be unset for a successful startup, otherwise it will contain a string representation of the error.
void	setStatus(String val) Sets the value of 'status' Field Description This field will be unset for a successful startup, otherwise it will contain a string representation of the error.
void	setStatusFrom(long val) Sets the value of this String field to the given numeric value.
void	setStatusFrom(XString val) Copies the provided XString value into this object's 'status'.
void	setTimestamp(long val) Sets the value of 'timestamp' Field Description The timestamp at which this event occurred (millis since the epoch).

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

setTimestamp

void setTimestamp(long val)

Sets the value of 'timestamp'

Field Description

The timestamp at which this event occurred (millis since the epoch).

Parameters:

val - The value to set.

getTimestamp

long getTimestamp()

Gets the value of 'timestamp'

Field Description

The timestamp at which this event occurred (millis since the epoch).

Returns:

The timestamp at which this event occurred (millis since the epoch).

clearTimestamp

void clearTimestamp()

Clears the value of 'timestamp'

Field Description

The timestamp at which this event occurred (millis since the epoch).

See Also:

setTimestamp(long)

hasTimestamp

boolean hasTimestamp()

Checks for the presence of 'timestamp'

Field Description

The timestamp at which this event occurred (millis since the epoch).

See Also:

getTimestamp()

setStatus

void setStatus(String val)

Sets the value of 'status'

Field Description

This field will be unset for a successful startup, otherwise it will contain a string representation of the error.

Parameters:

val - The value to set.

getStatus

String getStatus()

Gets the value of 'status'

Field Description

This field will be unset for a successful startup, otherwise it will contain a string representation of the error.

Returns:

This field will be unset for a successful startup, otherwise it will contain a string representation of the error.

lendStatus

void lendStatus(XString val)

Sets the value of 'status'

Field Description

This field will be unset for a successful startup, otherwise it will contain a string representation of the error.

Parameters:

val - The value to set.

setStatusFrom

void setStatusFrom(long val)

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

Field Description

This field will be unset for a successful startup, otherwise it will contain a string representation of the error.

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

getStatusTo

<T extends XString> T getStatusTo(XString.Factory<T> factory)

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

Field Description

This field will be unset for a successful startup, otherwise it will contain a string representation of the error.

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

setStatusFrom

void setStatusFrom(XString val)

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

Field Description

This field will be unset for a successful startup, otherwise it will contain a string representation of the error.

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

getStatusTo

void getStatusTo(XString val)

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

Field Description

This field will be unset for a successful startup, otherwise it will contain a string representation of the error.

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

See Also:

getStatus()

getStatusUnsafe

XString getStatusUnsafe()

Gets the raw value of 'status'.

Field Description

This field will be unset for a successful startup, otherwise it will contain a string representation of the error.

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:

getStatus()

clearStatus

void clearStatus()

Clears the value of 'status'

Field Description

This field will be unset for a successful startup, otherwise it will contain a string representation of the error.

See Also:

setStatus(String)

hasStatus

boolean hasStatus()

Checks for the presence of 'status'

Field Description

This field will be unset for a successful startup, otherwise it will contain a string representation of the error.

See Also:

getStatus()

copy

SrvMonAppMessagingStartedMessage copy()

Creates a copy of this SrvMonAppMessagingStartedMessage.

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

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

Specified by:

copy in interface IRogCopyableNode<ISrvMonAppMessagingStartedMessage>

Returns:

A copy of this SrvMonAppMessagingStartedMessage.

See Also:

IRogCopyableNode, CopyableMessageView

copyInto

void copyInto(SrvMonAppMessagingStartedMessage target)

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

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