@Generated(value="com.neeve.adm.AdmGenerator", date="Thu May 07 15:37:31 EDT 2020") @AdmGenerated(compatLevel="4.0.0", admVersion="nvx-rumi-adm v3.14 (build 29)", date="5/7/20 3:37 PM", buildInfo="nvx-talon-3.14.19 (nvx-codegen-plugin)") public interface ISrvMonMessageBusBindingReconnectedMessage extends IRogNode, IRogMessage, IRogCopyableNode<ISrvMonMessageBusBindingReconnectedMessage>, com.neeve.server.mon.common.ISrvMonAlertEvent
ADM Type | Message |
Factory | SrvMonAlertFactory |
ADM Field Summary |
---|
Field | Type | Id | Description |
---|---|---|---|
busName | String | 3 | No doc provided. |
eventSource | String | 6006 | The source of an event. |
eventTimestamp | Date | 6007 | The timestamp of an event. |
timestamp | Long | 1 | The timestamp at which this event occurred (millis since the epoch). |
xvmHeader | SrvMonXvmHeader | 6004 | Details about the message source. |
IRogNode.PoolingListener
IStoreObject.EncodingType
Modifier and Type | Method and Description |
---|---|
void |
clearBusName()
Clears the value of 'busName'.
|
void |
clearEventSource()
Clears the value of 'eventSource'.
|
void |
clearEventTimestamp()
Clears the value of 'eventTimestamp'.
|
void |
clearTimestamp()
Deprecated.
- Use eventTimestamp instead.
|
void |
clearXvmHeader()
Clears the value of 'xvmHeader'.
|
SrvMonMessageBusBindingReconnectedMessage |
copy()
Creates a copy of this SrvMonMessageBusBindingReconnectedMessage.
|
void |
copyInto(SrvMonMessageBusBindingReconnectedMessage target)
Copies the contents of this SrvMonMessageBusBindingReconnectedMessage into the target.
|
String |
getBusName()
Gets the value of 'busName'.
|
<T extends XString> |
getBusNameTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory.
|
void |
getBusNameTo(XString val)
Copies the value of 'busName' into the provided XString.
|
XString |
getBusNameUnsafe()
Gets the raw value of 'busName'.
|
String |
getEventSource()
Gets the value of 'eventSource'.
|
<T extends XString> |
getEventSourceTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory.
|
void |
getEventSourceTo(XString val)
Copies the value of 'eventSource' into the provided XString.
|
XString |
getEventSourceUnsafe()
Gets the raw value of 'eventSource'.
|
Date |
getEventTimestamp()
Gets the value of 'eventTimestamp'.
|
long |
getEventTimestampAsTimestamp()
Retrieves the date as a timestamp (a zero garbage operation for XBuf encoding).
|
long |
getTimestamp()
Deprecated.
- Use eventTimestamp instead.
|
com.neeve.server.mon.common.SrvMonXvmHeader |
getXvmHeader()
Gets the value of 'xvmHeader'.
|
void |
getXvmHeaderTo(com.neeve.server.mon.common.SrvMonXvmHeader val)
Copies the value of SrvMonXvmHeader into the provided value.
|
boolean |
hasBusName()
Checks for the presence of 'busName'.
|
boolean |
hasEventSource()
Checks for the presence of 'eventSource'.
|
boolean |
hasEventTimestamp()
Checks for the presence of 'eventTimestamp'.
|
boolean |
hasTimestamp()
Deprecated.
- Use eventTimestamp instead.
|
boolean |
hasXvmHeader()
Checks for the presence of 'xvmHeader'.
|
void |
lendBusName(XString val)
Lends the value of 'busName' to this object.
|
void |
lendEventSource(XString val)
Lends the value of 'eventSource' to this object.
|
void |
lendXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)
'Lends' a reference of the SrvMonXvmHeader to the message for this field.
|
void |
setBusName(String val)
Sets the value of 'busName'.
|
void |
setBusNameFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setBusNameFrom(XString val)
Copies the provided XString value into this object's 'busName'.
|
void |
setEventSource(String val)
Sets the value of 'eventSource'.
|
void |
setEventSourceFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setEventSourceFrom(XString val)
Copies the provided XString value into this object's 'eventSource'.
|
void |
setEventTimestamp(Date val)
Sets the value of 'eventTimestamp'.
|
void |
setEventTimestampAsTimestamp(long val)
Sets the date value as a timestamp.
|
void |
setTimestamp(long val)
Deprecated.
- Use eventTimestamp instead.
|
void |
setXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)
Sets the value of 'xvmHeader'.
|
com.neeve.server.mon.common.SrvMonXvmHeader |
takeXvmHeader()
'Takes' a reference to the xvmHeader field from the message.
|
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
acquire, deserialize, deserializeMetadata, deserializeMetadata, getContentEncodingType, getOwnershipCount, getSerializedMetadataLength, getStoreMetadata, serialize, serializeMetadata, setFieldValue
ensureId, getBinding, getCheckpointVersion, getCommittedDataSize, getId, getOfid, getStableTransactionId, getTransactionId, setBinding, setCheckpointVersion, setCommittedDataSize, setId, setStableTransactionId, setTransactionId
getMessageReflector
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
getValidationErrors, isValid
void setEventTimestamp(Date val)
setEventTimestamp
in interface com.neeve.server.mon.common.ISrvMonAlertEvent
setEventTimestamp
in interface com.neeve.server.mon.common.ISrvMonEvent
val
- The value to set.Date getEventTimestamp()
getEventTimestamp
in interface com.neeve.server.mon.common.ISrvMonAlertEvent
getEventTimestamp
in interface com.neeve.server.mon.common.ISrvMonEvent
void setEventTimestampAsTimestamp(long val)
setEventTimestampAsTimestamp
in interface com.neeve.server.mon.common.ISrvMonAlertEvent
setEventTimestampAsTimestamp
in interface com.neeve.server.mon.common.ISrvMonEvent
val
- The date value in milliseconds from the epochlong getEventTimestampAsTimestamp()
NOTE:
Note that a return value of -1 could also indicate 1 millisecond before the epoch.
In cases where a such an ambiguity is a practical concern, hasEventTimestamp()
should be called.
getEventTimestampAsTimestamp
in interface com.neeve.server.mon.common.ISrvMonAlertEvent
getEventTimestampAsTimestamp
in interface com.neeve.server.mon.common.ISrvMonEvent
void clearEventTimestamp()
clearEventTimestamp
in interface com.neeve.server.mon.common.ISrvMonAlertEvent
clearEventTimestamp
in interface com.neeve.server.mon.common.ISrvMonEvent
setEventTimestamp(Date)
boolean hasEventTimestamp()
hasEventTimestamp
in interface com.neeve.server.mon.common.ISrvMonAlertEvent
hasEventTimestamp
in interface com.neeve.server.mon.common.ISrvMonEvent
getEventTimestamp()
@Deprecated void setTimestamp(long val)
val
- The value to set.@Deprecated long getTimestamp()
@Deprecated void clearTimestamp()
setTimestamp(long)
@Deprecated boolean hasTimestamp()
getTimestamp()
void setXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)
setXvmHeader
in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader
setXvmHeader
in interface com.neeve.server.mon.common.ISrvMonAlertEvent
setXvmHeader
in interface com.neeve.server.mon.common.ISrvMonEvent
val
- The value to set.void lendXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)
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.
lendXvmHeader
in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader
lendXvmHeader
in interface com.neeve.server.mon.common.ISrvMonAlertEvent
lendXvmHeader
in interface com.neeve.server.mon.common.ISrvMonEvent
val
- the value to 'lend' to lend.com.neeve.server.mon.common.SrvMonXvmHeader getXvmHeader()
getXvmHeader
in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader
getXvmHeader
in interface com.neeve.server.mon.common.ISrvMonAlertEvent
getXvmHeader
in interface com.neeve.server.mon.common.ISrvMonEvent
void getXvmHeaderTo(com.neeve.server.mon.common.SrvMonXvmHeader val)
IF the value is not set, then the contents of the provided SrvMonXvmHeader are cleared.
getXvmHeaderTo
in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader
getXvmHeaderTo
in interface com.neeve.server.mon.common.ISrvMonAlertEvent
getXvmHeaderTo
in interface com.neeve.server.mon.common.ISrvMonEvent
val
- the value to copy intoSrvMonXvmHeader.copyInto(SrvMonXvmHeader)
com.neeve.server.mon.common.SrvMonXvmHeader takeXvmHeader()
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.
takeXvmHeader
in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader
takeXvmHeader
in interface com.neeve.server.mon.common.ISrvMonAlertEvent
takeXvmHeader
in interface com.neeve.server.mon.common.ISrvMonEvent
null
if the field is not set.boolean hasXvmHeader()
hasXvmHeader
in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader
hasXvmHeader
in interface com.neeve.server.mon.common.ISrvMonAlertEvent
hasXvmHeader
in interface com.neeve.server.mon.common.ISrvMonEvent
getXvmHeader()
void clearXvmHeader()
clearXvmHeader
in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader
clearXvmHeader
in interface com.neeve.server.mon.common.ISrvMonAlertEvent
clearXvmHeader
in interface com.neeve.server.mon.common.ISrvMonEvent
setXvmHeader(SrvMonXvmHeader)
void setEventSource(String val)
setEventSource
in interface com.neeve.server.mon.common.ISrvMonAlertEvent
setEventSource
in interface com.neeve.server.mon.common.ISrvMonEvent
val
- The value to set.String getEventSource()
getEventSource
in interface com.neeve.server.mon.common.ISrvMonAlertEvent
getEventSource
in interface com.neeve.server.mon.common.ISrvMonEvent
void lendEventSource(XString val)
This method is equivalent to setEventSource except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.
Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
lendEventSource
in interface com.neeve.server.mon.common.ISrvMonAlertEvent
lendEventSource
in interface com.neeve.server.mon.common.ISrvMonEvent
val
- The value to set.IllegalArgumentException
- If the value is mutable.void setEventSourceFrom(long val)
NOTE:
This is the same as calling setEventSource(String)
.
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setEventSourceFrom
in interface com.neeve.server.mon.common.ISrvMonAlertEvent
setEventSourceFrom
in interface com.neeve.server.mon.common.ISrvMonEvent
<T extends XString> T getEventSourceTo(XString.Factory<T> factory)
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;
getEventSourceTo
in interface com.neeve.server.mon.common.ISrvMonAlertEvent
getEventSourceTo
in interface com.neeve.server.mon.common.ISrvMonEvent
factory
- The factory from which to get the XString to copy into and returnnull
.NullPointerException
- if the provided factory is nullvoid setEventSourceFrom(XString val)
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than setEventSource(String)
because it avoids encoding the value into a String
if the given XString
is already encoded.
setEventSourceFrom
in interface com.neeve.server.mon.common.ISrvMonAlertEvent
setEventSourceFrom
in interface com.neeve.server.mon.common.ISrvMonEvent
void getEventSourceTo(XString val)
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than getEventSource()
bec
because it can avoid decoding the value into an String
.
getEventSourceTo
in interface com.neeve.server.mon.common.ISrvMonAlertEvent
getEventSourceTo
in interface com.neeve.server.mon.common.ISrvMonEvent
getEventSource()
XString getEventSourceUnsafe()
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.
getEventSourceUnsafe
in interface com.neeve.server.mon.common.ISrvMonAlertEvent
getEventSourceUnsafe
in interface com.neeve.server.mon.common.ISrvMonEvent
getEventSource()
void clearEventSource()
clearEventSource
in interface com.neeve.server.mon.common.ISrvMonAlertEvent
clearEventSource
in interface com.neeve.server.mon.common.ISrvMonEvent
setEventSource(String)
boolean hasEventSource()
hasEventSource
in interface com.neeve.server.mon.common.ISrvMonAlertEvent
hasEventSource
in interface com.neeve.server.mon.common.ISrvMonEvent
getEventSource()
void setBusName(String val)
val
- The value to set.String getBusName()
void lendBusName(XString val)
This method is equivalent to setBusName except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.
Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
val
- The value to set.IllegalArgumentException
- If the value is mutable.void setBusNameFrom(long val)
NOTE:
This is the same as calling setBusName(String)
.
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
<T extends XString> T getBusNameTo(XString.Factory<T> factory)
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;
factory
- The factory from which to get the XString to copy into and returnnull
.NullPointerException
- if the provided factory is nullvoid setBusNameFrom(XString val)
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than setBusName(String)
because it avoids encoding the value into a String
if the given XString
is already encoded.
void getBusNameTo(XString val)
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than getBusName()
bec
because it can avoid decoding the value into an String
.
getBusName()
XString getBusNameUnsafe()
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.
getBusName()
void clearBusName()
setBusName(String)
boolean hasBusName()
getBusName()
SrvMonMessageBusBindingReconnectedMessage copy()
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 SrvMonMessageBusBindingReconnectedMessage's embedded entity fields.
The returned copy will be writeable even if this SrvMonMessageBusBindingReconnectedMessage is read only.
No metadata is copied except as documented IRogCopyableNode
.
See IRogCopyableNode
for more detailed information on the semantics of this method.
copy
in interface CopyableMessageView<ISrvMonMessageBusBindingReconnectedMessage>
copy
in interface IRogCopyableNode<ISrvMonMessageBusBindingReconnectedMessage>
IRogCopyableNode
,
CopyableMessageView
void copyInto(SrvMonMessageBusBindingReconnectedMessage 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 SrvMonMessageBusBindingReconnectedMessage's embedded entity fields.
The returned copy will be writeable even if this SrvMonMessageBusBindingReconnectedMessage is read only.
No metadata is copied except as documented IRogCopyableNode
.
See IRogCopyableNode
for more detailed information on the semantics of this method.
target
- The target to copy into which must not be null or read only.Copyright © 2019 Neeve Research, LLC. All Rights Reserved.