@Generated(value="com.neeve.adm.AdmXbufGenerator", date="Thu May 07 15:37:31 EDT 2020") @AdmGenerated(encoding="Xbuf", 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)") @AdmFactoryInfo(factoryClass=SrvMonLifecycleFactory.class, vfid=34, ofid=34, typeId=13) public final class SrvMonAppMessagingStartedMessage extends com.neeve.rog.impl.RogNode implements ISrvMonAppMessagingStartedMessage, com.neeve.link.ILnkMessage, MessageReflector, com.neeve.xbuf.IXbufDesyncer, IRogJsonizable
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.
ADM Type | Message |
Factory | SrvMonLifecycleFactory |
ADM Field Summary |
---|
Field | Type | Id | Description |
---|---|---|---|
eventSource | String | 6021 | The source of an event. |
eventTimestamp | Date | 6022 | The timestamp of an event. |
status | String | 24 | This field will be unset for a successful startup, otherwise it will contain a string representation of the error. |
timestamp | Long | 16 | The timestamp at which this event occurred (millis since the epoch). |
xvmHeader | SrvMonXvmHeader | 6019 | Details about the message source. |
Modifier and Type | Class and Description |
---|---|
static class |
SrvMonAppMessagingStartedMessage.PacketBody
The backing packet type for SrvMonAppMessagingStartedMessage (used internally for serialization purposes).
|
IRogNode.PoolingListener
IStoreObject.EncodingType
Modifier and Type | Field and Description |
---|---|
static SrvMonAppMessagingStartedMessage[] |
EMPTY_ARRAY
A preallocated empty array used to avoid garbage when returning empty arrays of this type.
|
count, head, next, prev
Modifier and Type | Method and Description |
---|---|
boolean |
appendFieldValueTo(Object node,
String[] pathComponents,
XString target)
Appends a reflected field value as a string into the given XString.
|
boolean |
appendFieldValueTo(Object message,
String name,
XString target)
Appends a reflected field value as a string into the given XString.
|
void |
clearContent() |
void |
clearEventSource()
Clears the value of 'eventSource'.
|
void |
clearEventTimestamp()
Clears the value of 'eventTimestamp'.
|
void |
clearStatus()
Clears the value of 'status'.
|
void |
clearTimestamp()
Deprecated.
- Use eventTimestamp instead.
|
void |
clearXRogType() |
void |
clearXvmHeader()
Clears the value of 'xvmHeader'.
|
SrvMonAppMessagingStartedMessage |
copy()
Creates a copy of this SrvMonAppMessagingStartedMessage.
|
void |
copyInto(SrvMonAppMessagingStartedMessage copy)
Copies the contents of this SrvMonAppMessagingStartedMessage into the target.
|
static SrvMonAppMessagingStartedMessage |
create() |
static SrvMonAppMessagingStartedMessage |
create(com.eaio.uuid.UUID id) |
static SrvMonAppMessagingStartedMessage |
createFrom(byte[] serializedContainer) |
static SrvMonAppMessagingStartedMessage |
createFrom(ByteBuffer serializedContainer) |
static SrvMonAppMessagingStartedMessage |
createFromJson(String json) |
static SrvMonAppMessagingStartedMessage |
createFromRawJson(String json) |
static SrvMonAppMessagingStartedMessage |
createFromSerializedXbufContainer(byte[] serializedContainer) |
static SrvMonAppMessagingStartedMessage |
createFromSerializedXbufContainer(ByteBuffer serializedContainer) |
static SrvMonAppMessagingStartedMessage |
createFromSerializedXbufContainerPacket(byte[] serializedPacket) |
static SrvMonAppMessagingStartedMessage |
createFromSerializedXbufContainerPacket(ByteBuffer serializedPacket) |
static SrvMonAppMessagingStartedMessage |
createFromXbufContainerPacket(PktPacket packet) |
static com.neeve.xbuf.XbufSchema |
createSchema() |
SrvMonAppMessagingStartedMessage |
deserialize(PktPacket packet)
Deserialize an object's data.
|
SrvMonAppMessagingStartedMessage |
deserializeFromByteArray(byte[] array)
Deserialize a view's backing message from a byte array.
|
SrvMonAppMessagingStartedMessage |
deserializeFromByteBuffer(ByteBuffer buffer)
Deserialize a view's backing message from a byte buffer.
|
SrvMonAppMessagingStartedMessage |
deserializeFromJson(String json)
Deserialize a view's backing message from a json string
|
SrvMonAppMessagingStartedMessage |
deserializeFromPacket(PktPacket packet)
Deserialize a view's backing message from a packet.
|
SrvMonAppMessagingStartedMessage |
deserializeFromProtobuf(com.google.protobuf.Message message)
Deserialize a node's data from a protobuf message.
|
SrvMonAppMessagingStartedMessage |
deserializeFromRawJson(String json) |
int |
desync(PktBuffer buffer,
int pos,
boolean frameOnly)
Desync fields from a buffer
|
void |
desyncFieldBitmask() |
int |
dispose()
Implementation of
IRogNode.dispose()
ROG nodes piggyback on packet pooling to perform node pooling. |
boolean |
fieldExists(Object message,
String name)
Check if a field of the supplied name exists in a message.
|
PktBuffer |
getBackingBuffer() |
IStoreObject.EncodingType |
getContentEncodingType()
Get an object's content data encoding type.
|
static com.neeve.xbuf.XbufDesyncPolicy |
getDesyncPolicy() |
String |
getEventSource()
Gets the value of 'eventSource'.
|
com.neeve.xbuf.XbufStringField |
getEventSourceField() |
static int |
getEventSourceFieldId() |
<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).
|
com.neeve.xbuf.XbufVariableDateField |
getEventTimestampField() |
static int |
getEventTimestampFieldId() |
XString |
getFieldValueAsRawString(Object message,
String name)
Get the value of a reflectable field in a message as a string.
|
XString |
getFieldValueAsRawString(Object message,
String[] pathComponents)
Get the value of a reflectable field in a message as a string.
|
String |
getFieldValueAsString(Object message,
String name)
Get the value of a reflectable field in a message as a string.
|
String |
getFieldValueAsString(Object message,
String[] pathComponents)
Get the value of a reflectable field in a message as a string.
|
PktPacket |
getPacket()
Return the packet tied to this message.
|
String |
getStatus()
Gets the value of 'status'.
|
com.neeve.xbuf.XbufStringField |
getStatusField() |
static int |
getStatusFieldId() |
<T extends XString> |
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()
Deprecated.
- Use eventTimestamp instead.
|
com.neeve.xbuf.XbufVariableLongField |
getTimestampField()
Deprecated.
- Use eventTimestamp instead.
|
static int |
getTimestampFieldId() |
short |
getXRogType() |
com.neeve.xbuf.XbufVariableShortField |
getXRogTypeField() |
static int |
getXRogTypeFieldId() |
com.neeve.server.mon.common.SrvMonXvmHeader |
getXvmHeader()
Gets the value of 'xvmHeader'.
|
static int |
getXvmHeaderFieldId() |
void |
getXvmHeaderTo(com.neeve.server.mon.common.SrvMonXvmHeader to)
Copies the value of SrvMonXvmHeader into the provided value.
|
boolean |
hasEventSource()
Checks for the presence of 'eventSource'.
|
boolean |
hasEventTimestamp()
Checks for the presence of 'eventTimestamp'.
|
boolean |
hasStatus()
Checks for the presence of 'status'.
|
boolean |
hasTimestamp()
Deprecated.
- Use eventTimestamp instead.
|
boolean |
hasXRogType() |
boolean |
hasXvmHeader()
Checks for the presence of 'xvmHeader'.
|
boolean |
isDirty() |
boolean |
isFieldReflectable(Object message,
String name)
Check if a field of the supplied name is reflectable.
|
void |
lendEventSource(XString val)
Lends the value of 'eventSource' to this object.
|
void |
lendStatus(XString val)
Lends the value of 'status' to this object.
|
void |
lendXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)
'Lends' a reference of the SrvMonXvmHeader to the message for this field.
|
boolean |
needsSync()
Check if a view needs to be sync'd for reflection.
|
static void |
optimizeFor(int val) |
PktPacket |
serialize()
Serialize an object's data.
|
byte[] |
serializeToByteArray()
Serialize a view's backing message to a byte array.
|
ByteBuffer |
serializeToByteBuffer()
Serialize a view's backing message to a byte buffer.
|
com.neeve.io.IOBuffer |
serializeToIOBuffer(boolean useNative)
Serializes the
MessageView to an IOBuffer. |
String |
serializeToJson()
Serialize a view's backing message to JSON.
|
PktPacket |
serializeToPacket()
Serialize a view's backing message to a packet.
|
com.google.protobuf.Message |
serializeToProtobuf()
Serialize a node's data to a proto message.
|
String |
serializeToRawJson() |
void |
setAsReadOnly()
Implementation of
IRogNode.setAsReadOnly() |
static void |
setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val) |
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(com.neeve.xbuf.XbufStringField val) |
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 |
setEventTimestampFrom(com.neeve.xbuf.XbufVariableDateField val) |
static void |
setFieldInterest(List<Integer> fieldIds) |
IStoreObject |
setFieldValue(int id,
Object val) |
void |
setPreserializedFields(PktBuffer buffer) |
void |
setStatus(String val)
Sets the value of 'status'.
|
void |
setStatusFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setStatusFrom(com.neeve.xbuf.XbufStringField val) |
void |
setStatusFrom(XString val)
Copies the provided XString value into this object's 'status'.
|
void |
setTimestamp(long val)
Deprecated.
- Use eventTimestamp instead.
|
void |
setTimestampFrom(com.neeve.xbuf.XbufVariableLongField val)
Deprecated.
- Use eventTimestamp instead.
|
void |
setXRogType(short val) |
void |
setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val) |
void |
setXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)
Sets the value of 'xvmHeader'.
|
void |
sync()
Ensure a view's backing message is prepared and ready for transport
|
void |
syncFieldBitmask() |
com.neeve.server.mon.common.SrvMonXvmHeader |
takeXvmHeader()
'Takes' a reference to the xvmHeader field from the message.
|
String |
toJsonString()
Get a JSON representation of an ROG entity
|
String |
toJsonString(boolean includeMetadata,
String metadataObjectName,
String payloadObjectName)
Get a full JSON representation of an ROG entity
|
String |
toString()
Return a string representation of an ROG node.
|
void |
undispose(com.eaio.uuid.UUID id)
Recuscitate a disposed node.
|
accept, deserializeMetadata, deserializeMetadata, dump, ensureId, getAppSendBeginTs, getAppSendDoneTs, getAttachment, getBinding, getCheckpointVersion, getCommittedDataSize, getCreateTs, getEnqueueTs, getEnqueueTsMicros, getFields, getGraphId, getId, getInMsgsInTransaction, getIsInboundMessage, getIsInternal, getIsLastTransaction, getIsLiveInboundMessage, getIsMessage, getIsOutboundMessage, getIsPriority, getIsReadOnly, getIsReplayedMessage, getMessageBus, getMessageBusAsRaw, getMessageChannel, getMessageChannelAsRaw, getMessageFlow, getMessageKey, getMessageKeyAsRaw, getMessageReflector, getMessageSender, getMessageSequenceNumber, getMessageTransportHeaders, getMetadata, getOfid, getOriginTs, getOutMsgsInTransaction, getOutTs, getOutTsMicros, getParent, getParentId, getPoolingListener, getPostDeserializeTs, getPostProcessingTs, getPostProcessingTsMicros, getPostSerializeTs, getPostWireSendTs, getPostWireTs, getPreDeserializeTs, getPreProcessingTs, getPreProcessingTsMicros, getPreSerializeTs, getPreWireTs, getReceiveTs, getSendStartTs, getSendTs, getSerializedMetadataLength, getStableTransactionId, getStoreMetadata, getTransactionId, getTransactionInSequenceNumber, getTransactionOutSequenceNumber, getTypeFromJson, getValidationErrors, isPossibleDuplicate, isValid, metadataToJsonString, metadataToJsonString, metadataToString, resolveMessageKeyWith, resolveMessageKeyWith, saveMemory, serializeMetadata, setAppSendBeginTs, setAppSendDoneTs, setAsInboundMessage, setAsInternal, setAsLastTransaction, setAsMessage, setAsOutboundMessage, setAsPriority, setAsReplayedMessage, setAttachment, setBinding, setCheckpointVersion, setCommittedDataSize, setCreateTs, setEnqueueTsMicros, setFieldValue, setGraphId, setId, setInMsgsInTransaction, setMessageBus, setMessageBusAsRaw, setMessageChannel, setMessageChannelAsRaw, setMessageFlow, setMessageKey, setMessageKeyAsRaw, setMessageSender, setMessageSequenceNumber, setMessageTransportHeaders, setOriginTs, setOutMsgsInTransaction, setOutTs, setOutTsMicros, setParentId, setPoolingListener, setPossibleDuplicate, setPostDeserializeTs, setPostProcessingTs, setPostProcessingTsMicros, setPostSerializeTs, setPostWireSendTs, setPostWireTs, setPreDeserializeTs, setPreProcessingTs, setPreProcessingTsMicros, setPreSerializeTs, setPreWireTs, setReceiveTs, setSendStartTs, setSendTs, setStableTransactionId, setTransactionId, setTransactionInSequenceNumber, setTransactionOutSequenceNumber
acquire, getMessage, getMessageEncodingType, getOwnershipCount, getTag, getType, getVfid, referenceTracker, setTag
count, insertAfter, insertBefore, isLinked, next, previous, unlink, wipe
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
dump, getAttachment, getIsLiveInboundMessage, getIsPriority, getIsReadOnly, getMetadata, getParent, getPoolingListener, getType, metadataToJsonString, setAsInboundMessage, setAsInternal, setAsLastTransaction, setAsMessage, setAsOutboundMessage, setAsPriority, setAsReplayedMessage, setAttachment, setInMsgsInTransaction, setOutMsgsInTransaction, setParentId, setPoolingListener, setTransactionInSequenceNumber, setTransactionOutSequenceNumber
acquire, deserializeMetadata, deserializeMetadata, getOwnershipCount, getSerializedMetadataLength, getStoreMetadata, 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
public static final SrvMonAppMessagingStartedMessage[] EMPTY_ARRAY
public static SrvMonAppMessagingStartedMessage create()
public static SrvMonAppMessagingStartedMessage create(com.eaio.uuid.UUID id)
public static SrvMonAppMessagingStartedMessage createFromXbufContainerPacket(PktPacket packet)
public static SrvMonAppMessagingStartedMessage createFromSerializedXbufContainerPacket(ByteBuffer serializedPacket)
public static SrvMonAppMessagingStartedMessage createFromSerializedXbufContainerPacket(byte[] serializedPacket)
public static SrvMonAppMessagingStartedMessage createFromSerializedXbufContainer(ByteBuffer serializedContainer)
public static SrvMonAppMessagingStartedMessage createFromSerializedXbufContainer(byte[] serializedContainer)
public static SrvMonAppMessagingStartedMessage createFromRawJson(String json)
public static SrvMonAppMessagingStartedMessage createFromJson(String json)
public static SrvMonAppMessagingStartedMessage createFrom(ByteBuffer serializedContainer)
public static SrvMonAppMessagingStartedMessage createFrom(byte[] serializedContainer)
public static final void setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
public static final com.neeve.xbuf.XbufDesyncPolicy getDesyncPolicy()
public final void clearContent()
public final void syncFieldBitmask()
public final void desyncFieldBitmask()
public final PktBuffer getBackingBuffer()
public static final void optimizeFor(int val)
public final PktPacket getPacket()
com.neeve.link.ILnkMessage
getPacket
in interface com.neeve.link.ILnkMessage
public final com.google.protobuf.Message serializeToProtobuf()
IRogNode
serializeToProtobuf
in interface IRogNode
public final String serializeToRawJson()
public final String serializeToJson()
MessageView
Serializing/deserializing a message to/from JSON is an optional operation
serializeToJson
in interface MessageView
public final SrvMonAppMessagingStartedMessage deserializeFromProtobuf(com.google.protobuf.Message message)
IRogNode
deserializeFromProtobuf
in interface IRogNode
message
- The protobuf messagepublic final SrvMonAppMessagingStartedMessage deserializeFromRawJson(String json)
public final SrvMonAppMessagingStartedMessage deserializeFromJson(String json)
MessageView
deserializeFromJson
in interface MessageView
json
- The view's backing message serialized as a json string.
Serializing/deserializing a message to/from JSON is an optional operation
public final void setAsReadOnly()
com.neeve.rog.impl.RogNode
IRogNode.setAsReadOnly()
setAsReadOnly
in interface IRogNode
setAsReadOnly
in class com.neeve.rog.impl.RogNode
public int dispose()
com.neeve.rog.impl.RogNode
IRogNode.dispose()
ROG nodes piggyback on packet pooling to perform node pooling. When this
disposed, nodes release their reference to their backing packet (if a
node is not backed by a packet, the this method does nothing and the
node is released for garbage collection). The reference release will
cause the packet to ultimately enter into its pool (if a poolable
packet type). Since nodes are tagged to packets (via TAG_ROG_ENVELOPE),
nodes implictly also get pooled. To resuscitate a disposed node, the
user should get the node from its packet and invoke RogNode.undispose(com.eaio.uuid.UUID)
dispose
in interface IStoreObject
dispose
in interface IRogNode
dispose
in interface MessageView
dispose
in class com.neeve.rog.impl.RogNode
public void undispose(com.eaio.uuid.UUID id)
com.neeve.rog.impl.RogNode
undispose
in class com.neeve.rog.impl.RogNode
id
- The resuscitated node's id.
This method should be called to resuscitate a disposed node. Since the caller must release all references to a disposed node, the only place a disposed node can be obtained from is its pooled backing packet container. Upon retrieving a packet from a pool, the user should obtain the node from the TAG_ROG_ENVELOPE packet tag. If the tag is non-null, then it refers to an ROG node object. The user should invoke this method on the node before using the node.
public final void setPreserializedFields(PktBuffer buffer)
public static final int getXRogTypeFieldId()
public final void setXRogType(short val)
public final short getXRogType()
public final void setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)
public final com.neeve.xbuf.XbufVariableShortField getXRogTypeField()
public final boolean hasXRogType()
public final void clearXRogType()
public static final int getEventTimestampFieldId()
public final void setEventTimestamp(Date val)
ISrvMonAppMessagingStartedMessage
setEventTimestamp
in interface com.neeve.server.mon.common.ISrvMonEvent
setEventTimestamp
in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent
setEventTimestamp
in interface ISrvMonAppMessagingStartedMessage
val
- The value to set.public final Date getEventTimestamp()
ISrvMonAppMessagingStartedMessage
getEventTimestamp
in interface com.neeve.server.mon.common.ISrvMonEvent
getEventTimestamp
in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent
getEventTimestamp
in interface ISrvMonAppMessagingStartedMessage
public final void setEventTimestampAsTimestamp(long val)
ISrvMonAppMessagingStartedMessage
setEventTimestampAsTimestamp
in interface com.neeve.server.mon.common.ISrvMonEvent
setEventTimestampAsTimestamp
in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent
setEventTimestampAsTimestamp
in interface ISrvMonAppMessagingStartedMessage
val
- The date value in milliseconds from the epochpublic final long getEventTimestampAsTimestamp()
ISrvMonAppMessagingStartedMessage
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, ISrvMonAppMessagingStartedMessage.hasEventTimestamp()
should be called.
getEventTimestampAsTimestamp
in interface com.neeve.server.mon.common.ISrvMonEvent
getEventTimestampAsTimestamp
in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent
getEventTimestampAsTimestamp
in interface ISrvMonAppMessagingStartedMessage
public final void setEventTimestampFrom(com.neeve.xbuf.XbufVariableDateField val)
public final com.neeve.xbuf.XbufVariableDateField getEventTimestampField()
public final boolean hasEventTimestamp()
ISrvMonAppMessagingStartedMessage
hasEventTimestamp
in interface com.neeve.server.mon.common.ISrvMonEvent
hasEventTimestamp
in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent
hasEventTimestamp
in interface ISrvMonAppMessagingStartedMessage
ISrvMonAppMessagingStartedMessage.getEventTimestamp()
public final void clearEventTimestamp()
ISrvMonAppMessagingStartedMessage
clearEventTimestamp
in interface com.neeve.server.mon.common.ISrvMonEvent
clearEventTimestamp
in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent
clearEventTimestamp
in interface ISrvMonAppMessagingStartedMessage
ISrvMonAppMessagingStartedMessage.setEventTimestamp(Date)
public static final int getTimestampFieldId()
@Deprecated public final void setTimestamp(long val)
ISrvMonAppMessagingStartedMessage
setTimestamp
in interface ISrvMonAppMessagingStartedMessage
val
- The value to set.@Deprecated public final long getTimestamp()
ISrvMonAppMessagingStartedMessage
getTimestamp
in interface ISrvMonAppMessagingStartedMessage
@Deprecated public final void setTimestampFrom(com.neeve.xbuf.XbufVariableLongField val)
@Deprecated public final com.neeve.xbuf.XbufVariableLongField getTimestampField()
@Deprecated public final boolean hasTimestamp()
ISrvMonAppMessagingStartedMessage
hasTimestamp
in interface ISrvMonAppMessagingStartedMessage
ISrvMonAppMessagingStartedMessage.getTimestamp()
@Deprecated public final void clearTimestamp()
ISrvMonAppMessagingStartedMessage
clearTimestamp
in interface ISrvMonAppMessagingStartedMessage
ISrvMonAppMessagingStartedMessage.setTimestamp(long)
public static final int getXvmHeaderFieldId()
public final void setXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)
ISrvMonAppMessagingStartedMessage
setXvmHeader
in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader
setXvmHeader
in interface com.neeve.server.mon.common.ISrvMonEvent
setXvmHeader
in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent
setXvmHeader
in interface ISrvMonAppMessagingStartedMessage
val
- The value to set.public final void lendXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)
ISrvMonAppMessagingStartedMessage
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.ISrvMonEvent
lendXvmHeader
in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent
lendXvmHeader
in interface ISrvMonAppMessagingStartedMessage
val
- the value to 'lend' to lend.public final com.neeve.server.mon.common.SrvMonXvmHeader getXvmHeader()
ISrvMonAppMessagingStartedMessage
getXvmHeader
in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader
getXvmHeader
in interface com.neeve.server.mon.common.ISrvMonEvent
getXvmHeader
in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent
getXvmHeader
in interface ISrvMonAppMessagingStartedMessage
public final void getXvmHeaderTo(com.neeve.server.mon.common.SrvMonXvmHeader to)
ISrvMonAppMessagingStartedMessage
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.ISrvMonEvent
getXvmHeaderTo
in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent
getXvmHeaderTo
in interface ISrvMonAppMessagingStartedMessage
to
- the value to copy intoSrvMonXvmHeader.copyInto(SrvMonXvmHeader)
public final com.neeve.server.mon.common.SrvMonXvmHeader takeXvmHeader()
ISrvMonAppMessagingStartedMessage
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.ISrvMonEvent
takeXvmHeader
in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent
takeXvmHeader
in interface ISrvMonAppMessagingStartedMessage
null
if the field is not set.public final boolean hasXvmHeader()
ISrvMonAppMessagingStartedMessage
hasXvmHeader
in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader
hasXvmHeader
in interface com.neeve.server.mon.common.ISrvMonEvent
hasXvmHeader
in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent
hasXvmHeader
in interface ISrvMonAppMessagingStartedMessage
ISrvMonAppMessagingStartedMessage.getXvmHeader()
public final void clearXvmHeader()
ISrvMonAppMessagingStartedMessage
clearXvmHeader
in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader
clearXvmHeader
in interface com.neeve.server.mon.common.ISrvMonEvent
clearXvmHeader
in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent
clearXvmHeader
in interface ISrvMonAppMessagingStartedMessage
ISrvMonAppMessagingStartedMessage.setXvmHeader(SrvMonXvmHeader)
public static final int getEventSourceFieldId()
public final void setEventSource(String val)
ISrvMonAppMessagingStartedMessage
setEventSource
in interface com.neeve.server.mon.common.ISrvMonEvent
setEventSource
in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent
setEventSource
in interface ISrvMonAppMessagingStartedMessage
val
- The value to set.public final String getEventSource()
ISrvMonAppMessagingStartedMessage
getEventSource
in interface com.neeve.server.mon.common.ISrvMonEvent
getEventSource
in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent
getEventSource
in interface ISrvMonAppMessagingStartedMessage
public final void lendEventSource(XString val)
ISrvMonAppMessagingStartedMessage
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.ISrvMonEvent
lendEventSource
in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent
lendEventSource
in interface ISrvMonAppMessagingStartedMessage
val
- The value to set.public final void setEventSourceFrom(long val)
ISrvMonAppMessagingStartedMessage
NOTE:
This is the same as calling ISrvMonAppMessagingStartedMessage.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.ISrvMonEvent
setEventSourceFrom
in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent
setEventSourceFrom
in interface ISrvMonAppMessagingStartedMessage
public final <T extends XString> T getEventSourceTo(XString.Factory<T> factory)
ISrvMonAppMessagingStartedMessage
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.ISrvMonEvent
getEventSourceTo
in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent
getEventSourceTo
in interface ISrvMonAppMessagingStartedMessage
factory
- The factory from which to get the XString to copy into and returnnull
.public final void setEventSourceFrom(XString val)
ISrvMonAppMessagingStartedMessage
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than ISrvMonAppMessagingStartedMessage.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.ISrvMonEvent
setEventSourceFrom
in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent
setEventSourceFrom
in interface ISrvMonAppMessagingStartedMessage
public final void getEventSourceTo(XString val)
ISrvMonAppMessagingStartedMessage
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than ISrvMonAppMessagingStartedMessage.getEventSource()
bec
because it can avoid decoding the value into an String
.
getEventSourceTo
in interface com.neeve.server.mon.common.ISrvMonEvent
getEventSourceTo
in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent
getEventSourceTo
in interface ISrvMonAppMessagingStartedMessage
ISrvMonAppMessagingStartedMessage.getEventSource()
public final XString getEventSourceUnsafe()
ISrvMonAppMessagingStartedMessage
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.ISrvMonEvent
getEventSourceUnsafe
in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent
getEventSourceUnsafe
in interface ISrvMonAppMessagingStartedMessage
ISrvMonAppMessagingStartedMessage.getEventSource()
public final void setEventSourceFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getEventSourceField()
public final boolean hasEventSource()
ISrvMonAppMessagingStartedMessage
hasEventSource
in interface com.neeve.server.mon.common.ISrvMonEvent
hasEventSource
in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent
hasEventSource
in interface ISrvMonAppMessagingStartedMessage
ISrvMonAppMessagingStartedMessage.getEventSource()
public final void clearEventSource()
ISrvMonAppMessagingStartedMessage
clearEventSource
in interface com.neeve.server.mon.common.ISrvMonEvent
clearEventSource
in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent
clearEventSource
in interface ISrvMonAppMessagingStartedMessage
ISrvMonAppMessagingStartedMessage.setEventSource(String)
public static final int getStatusFieldId()
public final void setStatus(String val)
ISrvMonAppMessagingStartedMessage
setStatus
in interface ISrvMonAppMessagingStartedMessage
val
- The value to set.public final String getStatus()
ISrvMonAppMessagingStartedMessage
getStatus
in interface ISrvMonAppMessagingStartedMessage
public final void lendStatus(XString val)
ISrvMonAppMessagingStartedMessage
This method is equivalent to setStatus 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.
lendStatus
in interface ISrvMonAppMessagingStartedMessage
val
- The value to set.public final void setStatusFrom(long val)
ISrvMonAppMessagingStartedMessage
NOTE:
This is the same as calling ISrvMonAppMessagingStartedMessage.setStatus(String)
.
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setStatusFrom
in interface ISrvMonAppMessagingStartedMessage
public final <T extends XString> T getStatusTo(XString.Factory<T> factory)
ISrvMonAppMessagingStartedMessage
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;
getStatusTo
in interface ISrvMonAppMessagingStartedMessage
factory
- The factory from which to get the XString to copy into and returnnull
.public final void setStatusFrom(XString val)
ISrvMonAppMessagingStartedMessage
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than ISrvMonAppMessagingStartedMessage.setStatus(String)
because it avoids encoding the value into a String
if the given XString
is already encoded.
setStatusFrom
in interface ISrvMonAppMessagingStartedMessage
public final void getStatusTo(XString val)
ISrvMonAppMessagingStartedMessage
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than ISrvMonAppMessagingStartedMessage.getStatus()
bec
because it can avoid decoding the value into an String
.
getStatusTo
in interface ISrvMonAppMessagingStartedMessage
ISrvMonAppMessagingStartedMessage.getStatus()
public final XString getStatusUnsafe()
ISrvMonAppMessagingStartedMessage
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.
getStatusUnsafe
in interface ISrvMonAppMessagingStartedMessage
ISrvMonAppMessagingStartedMessage.getStatus()
public final void setStatusFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getStatusField()
public final boolean hasStatus()
ISrvMonAppMessagingStartedMessage
hasStatus
in interface ISrvMonAppMessagingStartedMessage
ISrvMonAppMessagingStartedMessage.getStatus()
public final void clearStatus()
ISrvMonAppMessagingStartedMessage
clearStatus
in interface ISrvMonAppMessagingStartedMessage
ISrvMonAppMessagingStartedMessage.setStatus(String)
public final boolean isDirty()
public static final com.neeve.xbuf.XbufSchema createSchema()
public final byte[] serializeToByteArray()
MessageView
serializeToByteArray
in interface MessageView
public final ByteBuffer serializeToByteBuffer()
MessageView
serializeToByteBuffer
in interface MessageView
public final com.neeve.io.IOBuffer serializeToIOBuffer(boolean useNative)
MessageView
MessageView
to an IOBuffer.
Ownership of the returned IOBuffer is given to the caller which should dispose of it when done.
The buffer backing the IOBuffer should be flipped (ready for read) upon return.
serializeToIOBuffer
in interface MessageView
serializeToIOBuffer
in class MessageViewImpl
useNative
- Whether the returned buffer should be native.MessageView
serialized to an IOBuffer.public final PktPacket serializeToPacket()
MessageView
serializeToPacket
in interface MessageView
public final SrvMonAppMessagingStartedMessage deserializeFromByteArray(byte[] array)
MessageView
deserializeFromByteArray
in interface MessageView
array
- The view's backing message serialized as a byte array.public final SrvMonAppMessagingStartedMessage deserializeFromByteBuffer(ByteBuffer buffer)
MessageView
deserializeFromByteBuffer
in interface MessageView
buffer
- The view's backing message serialized as a byte buffer.public final SrvMonAppMessagingStartedMessage deserializeFromPacket(PktPacket packet)
MessageView
deserializeFromPacket
in interface MessageView
packet
- The view's backing message serialized as a packet.public final void sync()
MessageView
sync
in interface MessageView
public final SrvMonAppMessagingStartedMessage 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 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.
copy
in interface IRogCopyableNode<ISrvMonAppMessagingStartedMessage>
copy
in interface ISrvMonAppMessagingStartedMessage
copy
in interface CopyableMessageView<ISrvMonAppMessagingStartedMessage>
IRogCopyableNode
,
CopyableMessageView
public final void copyInto(SrvMonAppMessagingStartedMessage copy)
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.
copyInto
in interface ISrvMonAppMessagingStartedMessage
copy
- The target to copy into which must not be null or read only.public final int desync(PktBuffer buffer, int pos, boolean frameOnly)
com.neeve.xbuf.IXbufDesyncer
desync
in interface com.neeve.xbuf.IXbufDesyncer
buffer
- The buffer to desync frompos
- The position in the container's backing buffer to desync
fromframeOnly
- Whether to frame the field on the underlying buffer.
See XbufField.desync(PktBuffer, int, boolean)
for more
informationpublic boolean needsSync()
MessageReflector
needsSync
in interface MessageReflector
public final boolean fieldExists(Object message, String name)
MessageReflector
fieldExists
in interface MessageReflector
message
- The message to check in.name
- The field to check for.public final boolean isFieldReflectable(Object message, String name)
MessageReflector
isFieldReflectable
in interface MessageReflector
message
- The message to check in.name
- The field to check for.public final String getFieldValueAsString(Object message, String name)
MessageReflector
Note that this method is generally less efficient than its variant
MessageReflector.getFieldValueAsString(Object, String[])
since this method requires
splitting the supplied path name into its dot separated path components. In cases
where the caller intends to reuse the same path name often, it is better
for the caller to supply it in split form.
getFieldValueAsString
in interface MessageReflector
message
- The message to introspect.name
- The field whose value is to be retrieved specified as a bean pathMessageReflector.fieldExists(java.lang.Object, java.lang.String)
and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String)
methodspublic final String getFieldValueAsString(Object message, String[] pathComponents)
MessageReflector
getFieldValueAsString
in interface MessageReflector
message
- The message to introspect.pathComponents
- The path components to use to access the field.MessageReflector.fieldExists(java.lang.Object, java.lang.String)
and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String)
methodspublic final XString getFieldValueAsRawString(Object message, String name)
MessageReflector
Note that this method is generally less efficient than its variant
MessageReflector.getFieldValueAsString(Object, String[])
since this method requires
splitting the supplied path name into its dot separated path components. In cases
where the caller intends to reuse the same path name often, it is better
for the caller to supply it in split form.
getFieldValueAsRawString
in interface MessageReflector
message
- The message to introspect.name
- The field whose value is to be retrieved specified as a bean pathMessageReflector.fieldExists(java.lang.Object, java.lang.String)
and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String)
methodspublic final XString getFieldValueAsRawString(Object message, String[] pathComponents)
MessageReflector
getFieldValueAsRawString
in interface MessageReflector
message
- The message to introspect.pathComponents
- The path components to use to access the field.MessageReflector.fieldExists(java.lang.Object, java.lang.String)
and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String)
methodspublic final boolean appendFieldValueTo(Object message, String name, XString target)
com.neeve.rog.impl.RogNode
If this node has a non-null messageReflector as returned by RogNode.getMessageReflector()
,
then this method will use that reflector to append the value of the field provided by
it if the field is reflectable and not null.
appendFieldValueTo
in interface MessageReflector
appendFieldValueTo
in class com.neeve.rog.impl.RogNode
message
- the node on which to reflect (which need not be this object).name
- the bean path to the field on the provided object.target
- The target XString into which to append the result.public final boolean appendFieldValueTo(Object node, String[] pathComponents, XString target)
com.neeve.rog.impl.RogNode
If this node has a non-null messageReflector as returned by RogNode.getMessageReflector()
,
then this method will use that reflector to append the value of the field provided by
it if the field is reflectable and not null.
appendFieldValueTo
in interface MessageReflector
appendFieldValueTo
in class com.neeve.rog.impl.RogNode
node
- the node on which to reflect (which need not be this object).pathComponents
- the bean path to the field on the provided object split by its '.' separated components. .target
- The target XString into which to append the result.public final IStoreObject.EncodingType getContentEncodingType()
IStoreObject
getContentEncodingType
in interface IStoreObject
public final PktPacket serialize()
IStoreObject
serialize
in interface IStoreObject
public final SrvMonAppMessagingStartedMessage deserialize(PktPacket packet)
IStoreObject
deserialize
in interface IStoreObject
packet
- The object in serialized form.public final IStoreObject setFieldValue(int id, Object val)
public final String toJsonString(boolean includeMetadata, String metadataObjectName, String payloadObjectName)
IRogJsonizable
toJsonString
in interface IRogJsonizable
includeMetadata
- Specify this parameter for the ROG entity
metadata to also be included in the JSON output. If included, the
entire ROG entity object is treated as a composite object containing
a nested metadata object and a nested data object. The next two
parameters metadataObjectName and dataObjectName
specify the names of the nested objects as they will appear in
the output JSON string.metadataObjectName
- The name of the nested metadata object
as it will appear in the output JSON string. A value of null will
default to using 'metadata' as the nested object name.payloadObjectName
- The name of the nested data object as it
will appear in the output JSON string. A value of null will default
to using 'data' as the nested object name.public final String toJsonString()
IRogJsonizable
toJsonString
in interface IRogJsonizable
public final String toString()
com.neeve.rog.impl.RogNode
toString
in class com.neeve.rog.impl.RogNode
Copyright © 2019 Neeve Research, LLC. All Rights Reserved.