@Generated(value="com.neeve.adm.AdmXbufGenerator", date="Thu May 07 15:37:32 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=SrvMonCncFactory.class, vfid=36, ofid=36, typeId=5) public final class SrvMonTraceRecord extends com.neeve.rog.impl.RogNode implements ISrvMonTraceRecord, com.neeve.link.ILnkMessage, MessageReflector, com.neeve.xbuf.IXbufDesyncer, IRogJsonizable
ADM Type | Message |
Factory | SrvMonCncFactory |
ADM Field Summary |
---|
Field | Type | Id | Description |
---|---|---|---|
hostAddress | String | 24 | The host address (if available). |
hostName | String | 25 | The host name (if available). |
legacy | Boolean | 17 |
Indicates if this is a legacy trace record.
Prior to the 3.6 version trace collected from a XVM was not decomposed into the trace, level, threadId, and timestamp, rather the full trace string was emitted raw. When this field is true applications should only expect the trace field to be set. |
level | SrvMonTraceLevel |
18 | The trace level (if available). |
processId | String | 22 | The process id (if available). |
threadId | Long | 20 | The thread id (if available). |
timestamp | Long | 21 | The timestamp (if available). |
trace | String | 16 | The trace output. |
traceSeqNo | Long | 26 |
The trace record sequence number.
Each tracer record emitted by the XVM is assigned an increasing sequence number. This number resets on a XVM restart and is unique to each XVM instance. NOTE: legacy XVMs will not include this field. |
tracerName | String | 19 | The tracer name (if available). |
xvmHeader | SrvMonXvmHeader | 6019 | Details about the message source. |
xvmName | String | 23 | The XVM name (if available). |
Modifier and Type | Class and Description |
---|---|
static class |
SrvMonTraceRecord.PacketBody
The backing packet type for SrvMonTraceRecord (used internally for serialization purposes).
|
IRogNode.PoolingListener
IStoreObject.EncodingType
Modifier and Type | Field and Description |
---|---|
static SrvMonTraceRecord[] |
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 |
clearHostAddress()
Clears the value of 'hostAddress'.
|
void |
clearHostName()
Clears the value of 'hostName'.
|
void |
clearLegacy()
Clears the value of 'legacy'.
|
void |
clearLevel()
Clears the value of 'level'.
|
void |
clearProcessId()
Clears the value of 'processId'.
|
void |
clearThreadId()
Clears the value of 'threadId'.
|
void |
clearTimestamp()
Clears the value of 'timestamp'.
|
void |
clearTrace()
Clears the value of 'trace'.
|
void |
clearTracerName()
Clears the value of 'tracerName'.
|
void |
clearTraceSeqNo()
Clears the value of 'traceSeqNo'.
|
void |
clearXRogType() |
void |
clearXvmHeader()
Clears the value of 'xvmHeader'.
|
void |
clearXvmName()
Clears the value of 'xvmName'.
|
SrvMonTraceRecord |
copy()
Creates a copy of this SrvMonTraceRecord.
|
void |
copyInto(SrvMonTraceRecord copy)
Copies the contents of this SrvMonTraceRecord into the target.
|
static SrvMonTraceRecord |
create() |
static SrvMonTraceRecord |
create(com.eaio.uuid.UUID id) |
static SrvMonTraceRecord |
createFrom(byte[] serializedContainer) |
static SrvMonTraceRecord |
createFrom(ByteBuffer serializedContainer) |
static SrvMonTraceRecord |
createFromJson(String json) |
static SrvMonTraceRecord |
createFromRawJson(String json) |
static SrvMonTraceRecord |
createFromSerializedXbufContainer(byte[] serializedContainer) |
static SrvMonTraceRecord |
createFromSerializedXbufContainer(ByteBuffer serializedContainer) |
static SrvMonTraceRecord |
createFromSerializedXbufContainerPacket(byte[] serializedPacket) |
static SrvMonTraceRecord |
createFromSerializedXbufContainerPacket(ByteBuffer serializedPacket) |
static SrvMonTraceRecord |
createFromXbufContainerPacket(PktPacket packet) |
static com.neeve.xbuf.XbufSchema |
createSchema() |
SrvMonTraceRecord |
deserialize(PktPacket packet)
Deserialize an object's data.
|
SrvMonTraceRecord |
deserializeFromByteArray(byte[] array)
Deserialize a view's backing message from a byte array.
|
SrvMonTraceRecord |
deserializeFromByteBuffer(ByteBuffer buffer)
Deserialize a view's backing message from a byte buffer.
|
SrvMonTraceRecord |
deserializeFromJson(String json)
Deserialize a view's backing message from a json string
|
SrvMonTraceRecord |
deserializeFromPacket(PktPacket packet)
Deserialize a view's backing message from a packet.
|
SrvMonTraceRecord |
deserializeFromProtobuf(com.google.protobuf.Message message)
Deserialize a node's data from a protobuf message.
|
SrvMonTraceRecord |
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() |
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.
|
String |
getHostAddress()
Gets the value of 'hostAddress'.
|
com.neeve.xbuf.XbufStringField |
getHostAddressField() |
static int |
getHostAddressFieldId() |
<T extends XString> |
getHostAddressTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory.
|
void |
getHostAddressTo(XString val)
Copies the value of 'hostAddress' into the provided XString.
|
XString |
getHostAddressUnsafe()
Gets the raw value of 'hostAddress'.
|
String |
getHostName()
Gets the value of 'hostName'.
|
com.neeve.xbuf.XbufStringField |
getHostNameField() |
static int |
getHostNameFieldId() |
<T extends XString> |
getHostNameTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory.
|
void |
getHostNameTo(XString val)
Copies the value of 'hostName' into the provided XString.
|
XString |
getHostNameUnsafe()
Gets the raw value of 'hostName'.
|
boolean |
getLegacy()
Gets the value of 'legacy'.
|
com.neeve.xbuf.XbufVariableBooleanField |
getLegacyField() |
static int |
getLegacyFieldId() |
SrvMonTraceLevel |
getLevel()
Gets the value of 'level'.
|
com.neeve.xbuf.XbufVariableEnumField<SrvMonTraceLevel> |
getLevelField() |
static int |
getLevelFieldId() |
PktPacket |
getPacket()
Return the packet tied to this message.
|
String |
getProcessId()
Gets the value of 'processId'.
|
com.neeve.xbuf.XbufStringField |
getProcessIdField() |
static int |
getProcessIdFieldId() |
<T extends XString> |
getProcessIdTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory.
|
void |
getProcessIdTo(XString val)
Copies the value of 'processId' into the provided XString.
|
XString |
getProcessIdUnsafe()
Gets the raw value of 'processId'.
|
long |
getThreadId()
Gets the value of 'threadId'.
|
com.neeve.xbuf.XbufVariableLongField |
getThreadIdField() |
static int |
getThreadIdFieldId() |
long |
getTimestamp()
Gets the value of 'timestamp'.
|
com.neeve.xbuf.XbufVariableLongField |
getTimestampField() |
static int |
getTimestampFieldId() |
String |
getTrace()
Gets the value of 'trace'.
|
com.neeve.xbuf.XbufStringField |
getTraceField() |
static int |
getTraceFieldId() |
String |
getTracerName()
Gets the value of 'tracerName'.
|
com.neeve.xbuf.XbufStringField |
getTracerNameField() |
static int |
getTracerNameFieldId() |
<T extends XString> |
getTracerNameTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory.
|
void |
getTracerNameTo(XString val)
Copies the value of 'tracerName' into the provided XString.
|
XString |
getTracerNameUnsafe()
Gets the raw value of 'tracerName'.
|
long |
getTraceSeqNo()
Gets the value of 'traceSeqNo'.
|
com.neeve.xbuf.XbufVariableLongField |
getTraceSeqNoField() |
static int |
getTraceSeqNoFieldId() |
<T extends XString> |
getTraceTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory.
|
void |
getTraceTo(XString val)
Copies the value of 'trace' into the provided XString.
|
XString |
getTraceUnsafe()
Gets the raw value of 'trace'.
|
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.
|
String |
getXvmName()
Gets the value of 'xvmName'.
|
com.neeve.xbuf.XbufStringField |
getXvmNameField() |
static int |
getXvmNameFieldId() |
<T extends XString> |
getXvmNameTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory.
|
void |
getXvmNameTo(XString val)
Copies the value of 'xvmName' into the provided XString.
|
XString |
getXvmNameUnsafe()
Gets the raw value of 'xvmName'.
|
boolean |
hasHostAddress()
Checks for the presence of 'hostAddress'.
|
boolean |
hasHostName()
Checks for the presence of 'hostName'.
|
boolean |
hasLegacy()
Checks for the presence of 'legacy'.
|
boolean |
hasLevel()
Checks for the presence of 'level'.
|
boolean |
hasProcessId()
Checks for the presence of 'processId'.
|
boolean |
hasThreadId()
Checks for the presence of 'threadId'.
|
boolean |
hasTimestamp()
Checks for the presence of 'timestamp'.
|
boolean |
hasTrace()
Checks for the presence of 'trace'.
|
boolean |
hasTracerName()
Checks for the presence of 'tracerName'.
|
boolean |
hasTraceSeqNo()
Checks for the presence of 'traceSeqNo'.
|
boolean |
hasXRogType() |
boolean |
hasXvmHeader()
Checks for the presence of 'xvmHeader'.
|
boolean |
hasXvmName()
Checks for the presence of 'xvmName'.
|
boolean |
isDirty() |
boolean |
isFieldReflectable(Object message,
String name)
Check if a field of the supplied name is reflectable.
|
void |
lendHostAddress(XString val)
Lends the value of 'hostAddress' to this object.
|
void |
lendHostName(XString val)
Lends the value of 'hostName' to this object.
|
void |
lendProcessId(XString val)
Lends the value of 'processId' to this object.
|
void |
lendTrace(XString val)
Lends the value of 'trace' to this object.
|
void |
lendTracerName(XString val)
Lends the value of 'tracerName' 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 |
lendXvmName(XString val)
Lends the value of 'xvmName' to this object.
|
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) |
static void |
setFieldInterest(List<Integer> fieldIds) |
IStoreObject |
setFieldValue(int id,
Object val) |
void |
setHostAddress(String val)
Sets the value of 'hostAddress'.
|
void |
setHostAddressFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setHostAddressFrom(com.neeve.xbuf.XbufStringField val) |
void |
setHostAddressFrom(XString val)
Copies the provided XString value into this object's 'hostAddress'.
|
void |
setHostName(String val)
Sets the value of 'hostName'.
|
void |
setHostNameFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setHostNameFrom(com.neeve.xbuf.XbufStringField val) |
void |
setHostNameFrom(XString val)
Copies the provided XString value into this object's 'hostName'.
|
void |
setLegacy(boolean val)
Sets the value of 'legacy'.
|
void |
setLegacyFrom(com.neeve.xbuf.XbufVariableBooleanField val) |
void |
setLevel(SrvMonTraceLevel val)
Sets the value of 'level'.
|
void |
setLevelFrom(com.neeve.xbuf.XbufVariableEnumField<SrvMonTraceLevel> val) |
void |
setPreserializedFields(PktBuffer buffer) |
void |
setProcessId(String val)
Sets the value of 'processId'.
|
void |
setProcessIdFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setProcessIdFrom(com.neeve.xbuf.XbufStringField val) |
void |
setProcessIdFrom(XString val)
Copies the provided XString value into this object's 'processId'.
|
void |
setThreadId(long val)
Sets the value of 'threadId'.
|
void |
setThreadIdFrom(com.neeve.xbuf.XbufVariableLongField val) |
void |
setTimestamp(long val)
Sets the value of 'timestamp'.
|
void |
setTimestampFrom(com.neeve.xbuf.XbufVariableLongField val) |
void |
setTrace(String val)
Sets the value of 'trace'.
|
void |
setTraceFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setTraceFrom(com.neeve.xbuf.XbufStringField val) |
void |
setTraceFrom(XString val)
Copies the provided XString value into this object's 'trace'.
|
void |
setTracerName(String val)
Sets the value of 'tracerName'.
|
void |
setTracerNameFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setTracerNameFrom(com.neeve.xbuf.XbufStringField val) |
void |
setTracerNameFrom(XString val)
Copies the provided XString value into this object's 'tracerName'.
|
void |
setTraceSeqNo(long val)
Sets the value of 'traceSeqNo'.
|
void |
setTraceSeqNoFrom(com.neeve.xbuf.XbufVariableLongField val) |
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 |
setXvmName(String val)
Sets the value of 'xvmName'.
|
void |
setXvmNameFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setXvmNameFrom(com.neeve.xbuf.XbufStringField val) |
void |
setXvmNameFrom(XString val)
Copies the provided XString value into this object's 'xvmName'.
|
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 SrvMonTraceRecord[] EMPTY_ARRAY
public static SrvMonTraceRecord create()
public static SrvMonTraceRecord create(com.eaio.uuid.UUID id)
public static SrvMonTraceRecord createFromXbufContainerPacket(PktPacket packet)
public static SrvMonTraceRecord createFromSerializedXbufContainerPacket(ByteBuffer serializedPacket)
public static SrvMonTraceRecord createFromSerializedXbufContainerPacket(byte[] serializedPacket)
public static SrvMonTraceRecord createFromSerializedXbufContainer(ByteBuffer serializedContainer)
public static SrvMonTraceRecord createFromSerializedXbufContainer(byte[] serializedContainer)
public static SrvMonTraceRecord createFromRawJson(String json)
public static SrvMonTraceRecord createFromJson(String json)
public static SrvMonTraceRecord createFrom(ByteBuffer serializedContainer)
public static SrvMonTraceRecord 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 SrvMonTraceRecord deserializeFromProtobuf(com.google.protobuf.Message message)
IRogNode
deserializeFromProtobuf
in interface IRogNode
message
- The protobuf messagepublic final SrvMonTraceRecord deserializeFromRawJson(String json)
public final SrvMonTraceRecord 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 getLevelFieldId()
public final void setLevel(SrvMonTraceLevel val)
ISrvMonTraceRecord
setLevel
in interface ISrvMonTrace
setLevel
in interface ISrvMonTraceRecord
val
- The value to set.public final void setLevelFrom(com.neeve.xbuf.XbufVariableEnumField<SrvMonTraceLevel> val)
public final com.neeve.xbuf.XbufVariableEnumField<SrvMonTraceLevel> getLevelField()
public final SrvMonTraceLevel getLevel()
ISrvMonTraceRecord
getLevel
in interface ISrvMonTrace
getLevel
in interface ISrvMonTraceRecord
public final boolean hasLevel()
ISrvMonTraceRecord
hasLevel
in interface ISrvMonTrace
hasLevel
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.getLevel()
public final void clearLevel()
ISrvMonTraceRecord
clearLevel
in interface ISrvMonTrace
clearLevel
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.setLevel(SrvMonTraceLevel)
public static final int getThreadIdFieldId()
public final void setThreadId(long val)
ISrvMonTraceRecord
setThreadId
in interface ISrvMonTrace
setThreadId
in interface ISrvMonTraceRecord
val
- The value to set.public final long getThreadId()
ISrvMonTraceRecord
getThreadId
in interface ISrvMonTrace
getThreadId
in interface ISrvMonTraceRecord
public final void setThreadIdFrom(com.neeve.xbuf.XbufVariableLongField val)
public final com.neeve.xbuf.XbufVariableLongField getThreadIdField()
public final boolean hasThreadId()
ISrvMonTraceRecord
hasThreadId
in interface ISrvMonTrace
hasThreadId
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.getThreadId()
public final void clearThreadId()
ISrvMonTraceRecord
clearThreadId
in interface ISrvMonTrace
clearThreadId
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.setThreadId(long)
public static final int getTimestampFieldId()
public final void setTimestamp(long val)
ISrvMonTraceRecord
setTimestamp
in interface ISrvMonTrace
setTimestamp
in interface ISrvMonTraceRecord
val
- The value to set.public final long getTimestamp()
ISrvMonTraceRecord
getTimestamp
in interface ISrvMonTrace
getTimestamp
in interface ISrvMonTraceRecord
public final void setTimestampFrom(com.neeve.xbuf.XbufVariableLongField val)
public final com.neeve.xbuf.XbufVariableLongField getTimestampField()
public final boolean hasTimestamp()
ISrvMonTraceRecord
hasTimestamp
in interface ISrvMonTrace
hasTimestamp
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.getTimestamp()
public final void clearTimestamp()
ISrvMonTraceRecord
clearTimestamp
in interface ISrvMonTrace
clearTimestamp
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.setTimestamp(long)
public static final int getLegacyFieldId()
public final void setLegacy(boolean val)
ISrvMonTraceRecord
Prior to the 3.6 version trace collected from a XVM was not decomposed into the trace, level, threadId, and timestamp, rather the full trace string was emitted raw. When this field is true applications should only expect the trace field to be set.
setLegacy
in interface ISrvMonTraceRecord
val
- The value to set.public final boolean getLegacy()
ISrvMonTraceRecord
Prior to the 3.6 version trace collected from a XVM was not decomposed into the trace, level, threadId, and timestamp, rather the full trace string was emitted raw. When this field is true applications should only expect the trace field to be set.
getLegacy
in interface ISrvMonTraceRecord
public final void setLegacyFrom(com.neeve.xbuf.XbufVariableBooleanField val)
public final com.neeve.xbuf.XbufVariableBooleanField getLegacyField()
public final boolean hasLegacy()
ISrvMonTraceRecord
Prior to the 3.6 version trace collected from a XVM was not decomposed into the trace, level, threadId, and timestamp, rather the full trace string was emitted raw. When this field is true applications should only expect the trace field to be set.
hasLegacy
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.getLegacy()
public final void clearLegacy()
ISrvMonTraceRecord
Prior to the 3.6 version trace collected from a XVM was not decomposed into the trace, level, threadId, and timestamp, rather the full trace string was emitted raw. When this field is true applications should only expect the trace field to be set.
clearLegacy
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.setLegacy(boolean)
public static final int getTraceSeqNoFieldId()
public final void setTraceSeqNo(long val)
ISrvMonTraceRecord
Each tracer record emitted by the XVM is assigned an increasing sequence number. This number resets on a XVM restart and is unique to each XVM instance.
NOTE: legacy XVMs will not include this field.
setTraceSeqNo
in interface ISrvMonTraceRecord
val
- The value to set.public final long getTraceSeqNo()
ISrvMonTraceRecord
Each tracer record emitted by the XVM is assigned an increasing sequence number. This number resets on a XVM restart and is unique to each XVM instance.
NOTE: legacy XVMs will not include this field.
getTraceSeqNo
in interface ISrvMonTraceRecord
public final void setTraceSeqNoFrom(com.neeve.xbuf.XbufVariableLongField val)
public final com.neeve.xbuf.XbufVariableLongField getTraceSeqNoField()
public final boolean hasTraceSeqNo()
ISrvMonTraceRecord
Each tracer record emitted by the XVM is assigned an increasing sequence number. This number resets on a XVM restart and is unique to each XVM instance.
NOTE: legacy XVMs will not include this field.
hasTraceSeqNo
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.getTraceSeqNo()
public final void clearTraceSeqNo()
ISrvMonTraceRecord
Each tracer record emitted by the XVM is assigned an increasing sequence number. This number resets on a XVM restart and is unique to each XVM instance.
NOTE: legacy XVMs will not include this field.
clearTraceSeqNo
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.setTraceSeqNo(long)
public static final int getXvmHeaderFieldId()
public final void setXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)
ISrvMonTraceRecord
setXvmHeader
in interface ISrvMonTraceRecord
setXvmHeader
in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader
val
- The value to set.public final void lendXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)
ISrvMonTraceRecord
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 ISrvMonTraceRecord
lendXvmHeader
in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader
val
- the value to 'lend' to lend.public final com.neeve.server.mon.common.SrvMonXvmHeader getXvmHeader()
ISrvMonTraceRecord
getXvmHeader
in interface ISrvMonTraceRecord
getXvmHeader
in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader
public final void getXvmHeaderTo(com.neeve.server.mon.common.SrvMonXvmHeader to)
ISrvMonTraceRecord
IF the value is not set, then the contents of the provided SrvMonXvmHeader are cleared.
getXvmHeaderTo
in interface ISrvMonTraceRecord
getXvmHeaderTo
in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader
to
- the value to copy intoSrvMonXvmHeader.copyInto(SrvMonXvmHeader)
public final com.neeve.server.mon.common.SrvMonXvmHeader takeXvmHeader()
ISrvMonTraceRecord
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 ISrvMonTraceRecord
takeXvmHeader
in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader
null
if the field is not set.public final boolean hasXvmHeader()
ISrvMonTraceRecord
hasXvmHeader
in interface ISrvMonTraceRecord
hasXvmHeader
in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader
ISrvMonTraceRecord.getXvmHeader()
public final void clearXvmHeader()
ISrvMonTraceRecord
clearXvmHeader
in interface ISrvMonTraceRecord
clearXvmHeader
in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader
ISrvMonTraceRecord.setXvmHeader(SrvMonXvmHeader)
public static final int getTraceFieldId()
public final void setTrace(String val)
ISrvMonTraceRecord
setTrace
in interface ISrvMonTrace
setTrace
in interface ISrvMonTraceRecord
val
- The value to set.public final String getTrace()
ISrvMonTraceRecord
getTrace
in interface ISrvMonTrace
getTrace
in interface ISrvMonTraceRecord
public final void lendTrace(XString val)
ISrvMonTraceRecord
This method is equivalent to setTrace 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.
lendTrace
in interface ISrvMonTrace
lendTrace
in interface ISrvMonTraceRecord
val
- The value to set.public final void setTraceFrom(long val)
ISrvMonTraceRecord
NOTE:
This is the same as calling ISrvMonTraceRecord.setTrace(String)
.
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setTraceFrom
in interface ISrvMonTrace
setTraceFrom
in interface ISrvMonTraceRecord
public final <T extends XString> T getTraceTo(XString.Factory<T> factory)
ISrvMonTraceRecord
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;
getTraceTo
in interface ISrvMonTrace
getTraceTo
in interface ISrvMonTraceRecord
factory
- The factory from which to get the XString to copy into and returnnull
.public final void setTraceFrom(XString val)
ISrvMonTraceRecord
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than ISrvMonTraceRecord.setTrace(String)
because it avoids encoding the value into a String
if the given XString
is already encoded.
setTraceFrom
in interface ISrvMonTrace
setTraceFrom
in interface ISrvMonTraceRecord
public final void getTraceTo(XString val)
ISrvMonTraceRecord
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than ISrvMonTraceRecord.getTrace()
bec
because it can avoid decoding the value into an String
.
getTraceTo
in interface ISrvMonTrace
getTraceTo
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.getTrace()
public final XString getTraceUnsafe()
ISrvMonTraceRecord
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.
getTraceUnsafe
in interface ISrvMonTrace
getTraceUnsafe
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.getTrace()
public final void setTraceFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getTraceField()
public final boolean hasTrace()
ISrvMonTraceRecord
hasTrace
in interface ISrvMonTrace
hasTrace
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.getTrace()
public final void clearTrace()
ISrvMonTraceRecord
clearTrace
in interface ISrvMonTrace
clearTrace
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.setTrace(String)
public static final int getTracerNameFieldId()
public final void setTracerName(String val)
ISrvMonTraceRecord
setTracerName
in interface ISrvMonTrace
setTracerName
in interface ISrvMonTraceRecord
val
- The value to set.public final String getTracerName()
ISrvMonTraceRecord
getTracerName
in interface ISrvMonTrace
getTracerName
in interface ISrvMonTraceRecord
public final void lendTracerName(XString val)
ISrvMonTraceRecord
This method is equivalent to setTracerName 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.
lendTracerName
in interface ISrvMonTrace
lendTracerName
in interface ISrvMonTraceRecord
val
- The value to set.public final void setTracerNameFrom(long val)
ISrvMonTraceRecord
NOTE:
This is the same as calling ISrvMonTraceRecord.setTracerName(String)
.
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setTracerNameFrom
in interface ISrvMonTrace
setTracerNameFrom
in interface ISrvMonTraceRecord
public final <T extends XString> T getTracerNameTo(XString.Factory<T> factory)
ISrvMonTraceRecord
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;
getTracerNameTo
in interface ISrvMonTrace
getTracerNameTo
in interface ISrvMonTraceRecord
factory
- The factory from which to get the XString to copy into and returnnull
.public final void setTracerNameFrom(XString val)
ISrvMonTraceRecord
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than ISrvMonTraceRecord.setTracerName(String)
because it avoids encoding the value into a String
if the given XString
is already encoded.
setTracerNameFrom
in interface ISrvMonTrace
setTracerNameFrom
in interface ISrvMonTraceRecord
public final void getTracerNameTo(XString val)
ISrvMonTraceRecord
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than ISrvMonTraceRecord.getTracerName()
bec
because it can avoid decoding the value into an String
.
getTracerNameTo
in interface ISrvMonTrace
getTracerNameTo
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.getTracerName()
public final XString getTracerNameUnsafe()
ISrvMonTraceRecord
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.
getTracerNameUnsafe
in interface ISrvMonTrace
getTracerNameUnsafe
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.getTracerName()
public final void setTracerNameFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getTracerNameField()
public final boolean hasTracerName()
ISrvMonTraceRecord
hasTracerName
in interface ISrvMonTrace
hasTracerName
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.getTracerName()
public final void clearTracerName()
ISrvMonTraceRecord
clearTracerName
in interface ISrvMonTrace
clearTracerName
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.setTracerName(String)
public static final int getProcessIdFieldId()
public final void setProcessId(String val)
ISrvMonTraceRecord
setProcessId
in interface ISrvMonTrace
setProcessId
in interface ISrvMonTraceRecord
val
- The value to set.public final String getProcessId()
ISrvMonTraceRecord
getProcessId
in interface ISrvMonTrace
getProcessId
in interface ISrvMonTraceRecord
public final void lendProcessId(XString val)
ISrvMonTraceRecord
This method is equivalent to setProcessId 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.
lendProcessId
in interface ISrvMonTrace
lendProcessId
in interface ISrvMonTraceRecord
val
- The value to set.public final void setProcessIdFrom(long val)
ISrvMonTraceRecord
NOTE:
This is the same as calling ISrvMonTraceRecord.setProcessId(String)
.
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setProcessIdFrom
in interface ISrvMonTrace
setProcessIdFrom
in interface ISrvMonTraceRecord
public final <T extends XString> T getProcessIdTo(XString.Factory<T> factory)
ISrvMonTraceRecord
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;
getProcessIdTo
in interface ISrvMonTrace
getProcessIdTo
in interface ISrvMonTraceRecord
factory
- The factory from which to get the XString to copy into and returnnull
.public final void setProcessIdFrom(XString val)
ISrvMonTraceRecord
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than ISrvMonTraceRecord.setProcessId(String)
because it avoids encoding the value into a String
if the given XString
is already encoded.
setProcessIdFrom
in interface ISrvMonTrace
setProcessIdFrom
in interface ISrvMonTraceRecord
public final void getProcessIdTo(XString val)
ISrvMonTraceRecord
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than ISrvMonTraceRecord.getProcessId()
bec
because it can avoid decoding the value into an String
.
getProcessIdTo
in interface ISrvMonTrace
getProcessIdTo
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.getProcessId()
public final XString getProcessIdUnsafe()
ISrvMonTraceRecord
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.
getProcessIdUnsafe
in interface ISrvMonTrace
getProcessIdUnsafe
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.getProcessId()
public final void setProcessIdFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getProcessIdField()
public final boolean hasProcessId()
ISrvMonTraceRecord
hasProcessId
in interface ISrvMonTrace
hasProcessId
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.getProcessId()
public final void clearProcessId()
ISrvMonTraceRecord
clearProcessId
in interface ISrvMonTrace
clearProcessId
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.setProcessId(String)
public static final int getXvmNameFieldId()
public final void setXvmName(String val)
ISrvMonTraceRecord
setXvmName
in interface ISrvMonTrace
setXvmName
in interface ISrvMonTraceRecord
val
- The value to set.public final String getXvmName()
ISrvMonTraceRecord
getXvmName
in interface ISrvMonTrace
getXvmName
in interface ISrvMonTraceRecord
public final void lendXvmName(XString val)
ISrvMonTraceRecord
This method is equivalent to setXvmName 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.
lendXvmName
in interface ISrvMonTrace
lendXvmName
in interface ISrvMonTraceRecord
val
- The value to set.public final void setXvmNameFrom(long val)
ISrvMonTraceRecord
NOTE:
This is the same as calling ISrvMonTraceRecord.setXvmName(String)
.
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setXvmNameFrom
in interface ISrvMonTrace
setXvmNameFrom
in interface ISrvMonTraceRecord
public final <T extends XString> T getXvmNameTo(XString.Factory<T> factory)
ISrvMonTraceRecord
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;
getXvmNameTo
in interface ISrvMonTrace
getXvmNameTo
in interface ISrvMonTraceRecord
factory
- The factory from which to get the XString to copy into and returnnull
.public final void setXvmNameFrom(XString val)
ISrvMonTraceRecord
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than ISrvMonTraceRecord.setXvmName(String)
because it avoids encoding the value into a String
if the given XString
is already encoded.
setXvmNameFrom
in interface ISrvMonTrace
setXvmNameFrom
in interface ISrvMonTraceRecord
public final void getXvmNameTo(XString val)
ISrvMonTraceRecord
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than ISrvMonTraceRecord.getXvmName()
bec
because it can avoid decoding the value into an String
.
getXvmNameTo
in interface ISrvMonTrace
getXvmNameTo
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.getXvmName()
public final XString getXvmNameUnsafe()
ISrvMonTraceRecord
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.
getXvmNameUnsafe
in interface ISrvMonTrace
getXvmNameUnsafe
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.getXvmName()
public final void setXvmNameFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getXvmNameField()
public final boolean hasXvmName()
ISrvMonTraceRecord
hasXvmName
in interface ISrvMonTrace
hasXvmName
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.getXvmName()
public final void clearXvmName()
ISrvMonTraceRecord
clearXvmName
in interface ISrvMonTrace
clearXvmName
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.setXvmName(String)
public static final int getHostAddressFieldId()
public final void setHostAddress(String val)
ISrvMonTraceRecord
setHostAddress
in interface ISrvMonTrace
setHostAddress
in interface ISrvMonTraceRecord
val
- The value to set.public final String getHostAddress()
ISrvMonTraceRecord
getHostAddress
in interface ISrvMonTrace
getHostAddress
in interface ISrvMonTraceRecord
public final void lendHostAddress(XString val)
ISrvMonTraceRecord
This method is equivalent to setHostAddress 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.
lendHostAddress
in interface ISrvMonTrace
lendHostAddress
in interface ISrvMonTraceRecord
val
- The value to set.public final void setHostAddressFrom(long val)
ISrvMonTraceRecord
NOTE:
This is the same as calling ISrvMonTraceRecord.setHostAddress(String)
.
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setHostAddressFrom
in interface ISrvMonTrace
setHostAddressFrom
in interface ISrvMonTraceRecord
public final <T extends XString> T getHostAddressTo(XString.Factory<T> factory)
ISrvMonTraceRecord
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;
getHostAddressTo
in interface ISrvMonTrace
getHostAddressTo
in interface ISrvMonTraceRecord
factory
- The factory from which to get the XString to copy into and returnnull
.public final void setHostAddressFrom(XString val)
ISrvMonTraceRecord
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than ISrvMonTraceRecord.setHostAddress(String)
because it avoids encoding the value into a String
if the given XString
is already encoded.
setHostAddressFrom
in interface ISrvMonTrace
setHostAddressFrom
in interface ISrvMonTraceRecord
public final void getHostAddressTo(XString val)
ISrvMonTraceRecord
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than ISrvMonTraceRecord.getHostAddress()
bec
because it can avoid decoding the value into an String
.
getHostAddressTo
in interface ISrvMonTrace
getHostAddressTo
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.getHostAddress()
public final XString getHostAddressUnsafe()
ISrvMonTraceRecord
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.
getHostAddressUnsafe
in interface ISrvMonTrace
getHostAddressUnsafe
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.getHostAddress()
public final void setHostAddressFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getHostAddressField()
public final boolean hasHostAddress()
ISrvMonTraceRecord
hasHostAddress
in interface ISrvMonTrace
hasHostAddress
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.getHostAddress()
public final void clearHostAddress()
ISrvMonTraceRecord
clearHostAddress
in interface ISrvMonTrace
clearHostAddress
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.setHostAddress(String)
public static final int getHostNameFieldId()
public final void setHostName(String val)
ISrvMonTraceRecord
setHostName
in interface ISrvMonTrace
setHostName
in interface ISrvMonTraceRecord
val
- The value to set.public final String getHostName()
ISrvMonTraceRecord
getHostName
in interface ISrvMonTrace
getHostName
in interface ISrvMonTraceRecord
public final void lendHostName(XString val)
ISrvMonTraceRecord
This method is equivalent to setHostName 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.
lendHostName
in interface ISrvMonTrace
lendHostName
in interface ISrvMonTraceRecord
val
- The value to set.public final void setHostNameFrom(long val)
ISrvMonTraceRecord
NOTE:
This is the same as calling ISrvMonTraceRecord.setHostName(String)
.
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setHostNameFrom
in interface ISrvMonTrace
setHostNameFrom
in interface ISrvMonTraceRecord
public final <T extends XString> T getHostNameTo(XString.Factory<T> factory)
ISrvMonTraceRecord
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;
getHostNameTo
in interface ISrvMonTrace
getHostNameTo
in interface ISrvMonTraceRecord
factory
- The factory from which to get the XString to copy into and returnnull
.public final void setHostNameFrom(XString val)
ISrvMonTraceRecord
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than ISrvMonTraceRecord.setHostName(String)
because it avoids encoding the value into a String
if the given XString
is already encoded.
setHostNameFrom
in interface ISrvMonTrace
setHostNameFrom
in interface ISrvMonTraceRecord
public final void getHostNameTo(XString val)
ISrvMonTraceRecord
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than ISrvMonTraceRecord.getHostName()
bec
because it can avoid decoding the value into an String
.
getHostNameTo
in interface ISrvMonTrace
getHostNameTo
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.getHostName()
public final XString getHostNameUnsafe()
ISrvMonTraceRecord
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.
getHostNameUnsafe
in interface ISrvMonTrace
getHostNameUnsafe
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.getHostName()
public final void setHostNameFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getHostNameField()
public final boolean hasHostName()
ISrvMonTraceRecord
hasHostName
in interface ISrvMonTrace
hasHostName
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.getHostName()
public final void clearHostName()
ISrvMonTraceRecord
clearHostName
in interface ISrvMonTrace
clearHostName
in interface ISrvMonTraceRecord
ISrvMonTraceRecord.setHostName(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 SrvMonTraceRecord deserializeFromByteArray(byte[] array)
MessageView
deserializeFromByteArray
in interface MessageView
array
- The view's backing message serialized as a byte array.public final SrvMonTraceRecord deserializeFromByteBuffer(ByteBuffer buffer)
MessageView
deserializeFromByteBuffer
in interface MessageView
buffer
- The view's backing message serialized as a byte buffer.public final SrvMonTraceRecord 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 SrvMonTraceRecord 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 SrvMonTraceRecord's embedded entity fields.
The returned copy will be writeable even if this SrvMonTraceRecord 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<ISrvMonTraceRecord>
copy
in interface ISrvMonTraceRecord
copy
in interface CopyableMessageView<ISrvMonTraceRecord>
IRogCopyableNode
,
CopyableMessageView
public final void copyInto(SrvMonTraceRecord 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 SrvMonTraceRecord's embedded entity fields.
The returned copy will be writeable even if this SrvMonTraceRecord 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 ISrvMonTraceRecord
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 SrvMonTraceRecord 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.