com.neeve.server.mon.cnc

Interface ISrvMonTraceRecord

All Superinterfaces:

CopyableMessageView<ISrvMonTraceRecord>, com.neeve.server.mon.common.IHasSrvMonXvmHeader, IRogCopyableNode<ISrvMonTraceRecord>, IRogMessage, IRogMetadata, IRogNode, IRogValidatable, ISrvMonTrace, IStoreObject, IStoreObjectMetadata, MapMessageView, MessageView, UtlReferenceTracker.HasReferenceTracker

All Known Implementing Classes:

SrvMonTraceRecord

@Generated(value="com.neeve.adm.AdmGenerator",
           date="Thu May 07 15:37:32 EDT 2020")
@AdmGenerated(compatLevel="4.0.0",
              admVersion="nvx-rumi-adm v3.14 (build 29)",
              date="5/7/20 3:37 PM",
              buildInfo="nvx-talon-3.14.19 (nvx-codegen-plugin)")
public interface ISrvMonTraceRecord
extends IRogNode, IRogMessage, IRogCopyableNode<ISrvMonTraceRecord>, ISrvMonTrace, com.neeve.server.mon.common.IHasSrvMonXvmHeader

A trace record.

ADM Details

ADM Type	Message
Factory	SrvMonCncFactory

ADM Field Summary

Field	Type	Id	Description
hostAddress	String	9	The host address (if available).
hostName	String	10	The host name (if available).
legacy	Boolean	2	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	3	The trace level (if available).
processId	String	7	The process id (if available).
threadId	Long	5	The thread id (if available).
timestamp	Long	6	The timestamp (if available).
trace	String	1	The trace output.
traceSeqNo	Long	11	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	4	The tracer name (if available).
xvmHeader	SrvMonXvmHeader	6004	Details about the message source.
xvmName	String	8	The XVM name (if available).

Nested Class Summary

Nested classes/interfaces inherited from interface com.neeve.rog.IRogNode

IRogNode.PoolingListener

Nested classes/interfaces inherited from interface com.neeve.ods.IStoreObject

IStoreObject.EncodingType

Method Summary

Methods

Modifier and Type	Method and Description
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	clearXvmHeader() Clears the value of 'xvmHeader'.
void	clearXvmName() Clears the value of 'xvmName'.
SrvMonTraceRecord	copy() Creates a copy of this SrvMonTraceRecord.
void	copyInto(SrvMonTraceRecord target) Copies the contents of this SrvMonTraceRecord into the target.
String	getHostAddress() Gets the value of 'hostAddress'.
<T extends XString> T	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'.
<T extends XString> T	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'.
SrvMonTraceLevel	getLevel() Gets the value of 'level'.
String	getProcessId() Gets the value of 'processId'.
<T extends XString> T	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'.
long	getTimestamp() Gets the value of 'timestamp'.
String	getTrace() Gets the value of 'trace'.
String	getTracerName() Gets the value of 'tracerName'.
<T extends XString> T	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'.
<T extends XString> T	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'.
com.neeve.server.mon.common.SrvMonXvmHeader	getXvmHeader() Gets the value of 'xvmHeader'.
void	getXvmHeaderTo(com.neeve.server.mon.common.SrvMonXvmHeader val) Copies the value of SrvMonXvmHeader into the provided value.
String	getXvmName() Gets the value of 'xvmName'.
<T extends XString> T	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	hasXvmHeader() Checks for the presence of 'xvmHeader'.
boolean	hasXvmName() Checks for the presence of 'xvmName'.
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.
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(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(XString val) Copies the provided XString value into this object's 'hostName'.
void	setLegacy(boolean val) Sets the value of 'legacy'.
void	setLevel(SrvMonTraceLevel val) Sets the value of 'level'.
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(XString val) Copies the provided XString value into this object's 'processId'.
void	setThreadId(long val) Sets the value of 'threadId'.
void	setTimestamp(long val) Sets the value of 'timestamp'.
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(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(XString val) Copies the provided XString value into this object's 'tracerName'.
void	setTraceSeqNo(long val) Sets the value of 'traceSeqNo'.
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(XString val) Copies the provided XString value into this object's 'xvmName'.
com.neeve.server.mon.common.SrvMonXvmHeader	takeXvmHeader() 'Takes' a reference to the xvmHeader field from the message.

Methods inherited from interface com.neeve.rog.IRogNode

deserializeFromProtobuf, dispose, dump, getAttachment, getIsLiveInboundMessage, getIsPriority, getIsReadOnly, getMetadata, getParent, getPoolingListener, getType, metadataToJsonString, serializeToProtobuf, setAsInboundMessage, setAsInternal, setAsLastTransaction, setAsMessage, setAsOutboundMessage, setAsPriority, setAsReadOnly, setAsReplayedMessage, setAttachment, setInMsgsInTransaction, setOutMsgsInTransaction, setParentId, setPoolingListener, setTransactionInSequenceNumber, setTransactionOutSequenceNumber

Methods inherited from interface com.neeve.ods.IStoreObject

acquire, deserialize, deserializeMetadata, deserializeMetadata, getContentEncodingType, getOwnershipCount, getSerializedMetadataLength, getStoreMetadata, serialize, serializeMetadata, setFieldValue

Methods inherited from interface com.neeve.ods.IStoreObjectMetadata

ensureId, getBinding, getCheckpointVersion, getCommittedDataSize, getId, getOfid, getStableTransactionId, getTransactionId, setBinding, setCheckpointVersion, setCommittedDataSize, setId, setStableTransactionId, setTransactionId

Methods inherited from interface com.neeve.sma.MapMessageView

getMessageReflector

Methods inherited from interface com.neeve.rog.IRogMetadata

getEnqueueTs, getEnqueueTsMicros, getGraphId, getInMsgsInTransaction, getIsInboundMessage, getIsInternal, getIsLastTransaction, getIsMessage, getIsOutboundMessage, getIsReplayedMessage, getMessageBus, getMessageChannel, getMessageFlow, getMessageKey, getMessageSender, getMessageSequenceNumber, getMessageTransportHeaders, getOutMsgsInTransaction, getOutTs, getOutTsMicros, getParentId, getPreProcessingTs, getPreProcessingTsMicros, getTransactionInSequenceNumber, getTransactionOutSequenceNumber, isPossibleDuplicate, metadataToJsonString, metadataToString

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

setLevel

void setLevel(SrvMonTraceLevel val)

Sets the value of 'level'.

Field Description

The trace level (if available).

Specified by:

setLevel in interface ISrvMonTrace

Parameters:

val - The value to set.

getLevel

SrvMonTraceLevel getLevel()

Gets the value of 'level'.

Field Description

The trace level (if available).

Specified by:

getLevel in interface ISrvMonTrace

Returns:

The trace level (if available).

clearLevel

void clearLevel()

Clears the value of 'level'.

Field Description

The trace level (if available).

Specified by:

clearLevel in interface ISrvMonTrace

See Also:

setLevel(SrvMonTraceLevel)

hasLevel

boolean hasLevel()

Checks for the presence of 'level'.

Field Description

The trace level (if available).

Specified by:

hasLevel in interface ISrvMonTrace

See Also:

getLevel()

setThreadId

void setThreadId(long val)

Sets the value of 'threadId'.

Field Description

The thread id (if available).

Specified by:

setThreadId in interface ISrvMonTrace

Parameters:

val - The value to set.

getThreadId

long getThreadId()

Gets the value of 'threadId'.

Field Description

The thread id (if available).

Specified by:

getThreadId in interface ISrvMonTrace

Returns:

The thread id (if available).

clearThreadId

void clearThreadId()

Clears the value of 'threadId'.

Field Description

The thread id (if available).

Specified by:

clearThreadId in interface ISrvMonTrace

See Also:

setThreadId(long)

hasThreadId

boolean hasThreadId()

Checks for the presence of 'threadId'.

Field Description

The thread id (if available).

Specified by:

hasThreadId in interface ISrvMonTrace

See Also:

getThreadId()

setTimestamp

void setTimestamp(long val)

Sets the value of 'timestamp'.

Field Description

The timestamp (if available).

Specified by:

setTimestamp in interface ISrvMonTrace

Parameters:

val - The value to set.

getTimestamp

long getTimestamp()

Gets the value of 'timestamp'.

Field Description

The timestamp (if available).

Specified by:

getTimestamp in interface ISrvMonTrace

Returns:

The timestamp (if available).

clearTimestamp

void clearTimestamp()

Clears the value of 'timestamp'.

Field Description

The timestamp (if available).

Specified by:

clearTimestamp in interface ISrvMonTrace

See Also:

setTimestamp(long)

hasTimestamp

boolean hasTimestamp()

Checks for the presence of 'timestamp'.

Field Description

The timestamp (if available).

Specified by:

hasTimestamp in interface ISrvMonTrace

See Also:

getTimestamp()

setLegacy

void setLegacy(boolean val)

Sets the value of 'legacy'.

Field Description

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.

Parameters:

val - The value to set.

getLegacy

boolean getLegacy()

Gets the value of 'legacy'.

Field Description

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.

Returns:

Indicates if this is a legacy trace record.

clearLegacy

void clearLegacy()

Clears the value of 'legacy'.

Field Description

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.

See Also:

setLegacy(boolean)

hasLegacy

boolean hasLegacy()

Checks for the presence of 'legacy'.

Field Description

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.

See Also:

getLegacy()

setTraceSeqNo

void setTraceSeqNo(long val)

Sets the value of 'traceSeqNo'.

Field Description

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.

Parameters:

val - The value to set.

getTraceSeqNo

long getTraceSeqNo()

Gets the value of 'traceSeqNo'.

Field Description

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.

Returns:

The trace record sequence number.

clearTraceSeqNo

void clearTraceSeqNo()

Clears the value of 'traceSeqNo'.

Field Description

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.

See Also:

setTraceSeqNo(long)

hasTraceSeqNo

boolean hasTraceSeqNo()

Checks for the presence of 'traceSeqNo'.

Field Description

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.

See Also:

getTraceSeqNo()

setXvmHeader

void setXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)

Sets the value of 'xvmHeader'.

Field Description

Details about the message source.

Specified by:

setXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader

Parameters:

val - The value to set.

lendXvmHeader

void lendXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)

'Lends' a reference of the SrvMonXvmHeader to the message for this field.

Field Description

Details about the message source.

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.

Specified by:

lendXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader

Parameters:

val - the value to 'lend' to lend.

getXvmHeader

com.neeve.server.mon.common.SrvMonXvmHeader getXvmHeader()

Gets the value of 'xvmHeader'.

Field Description

Details about the message source.

Specified by:

getXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader

Returns:

Details about the message source.

getXvmHeaderTo

void getXvmHeaderTo(com.neeve.server.mon.common.SrvMonXvmHeader val)

Copies the value of SrvMonXvmHeader into the provided value.

IF the value is not set, then the contents of the provided SrvMonXvmHeader are cleared.

Specified by:

getXvmHeaderTo in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader

Parameters:

val - the value to copy into

See Also:

SrvMonXvmHeader.copyInto(SrvMonXvmHeader)

takeXvmHeader

com.neeve.server.mon.common.SrvMonXvmHeader takeXvmHeader()

'Takes' a reference to the xvmHeader field from the message.

Field Description

Details about the message source.

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.

Specified by:

takeXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader

Returns:

a 'taken' reference to the field or null if the field is not set.

hasXvmHeader

boolean hasXvmHeader()

Checks for the presence of 'xvmHeader'.

Field Description

Details about the message source.

Specified by:

hasXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader

See Also:

getXvmHeader()

clearXvmHeader

void clearXvmHeader()

Clears the value of 'xvmHeader'.

Field Description

Details about the message source.

Specified by:

clearXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader

See Also:

setXvmHeader(SrvMonXvmHeader)

setTrace

void setTrace(String val)

Sets the value of 'trace'.

Field Description

The trace output.

Specified by:

setTrace in interface ISrvMonTrace

Parameters:

val - The value to set.

getTrace

String getTrace()

Gets the value of 'trace'.

Field Description

The trace output.

Specified by:

getTrace in interface ISrvMonTrace

Returns:

The trace output.

lendTrace

void lendTrace(XString val)

Lends the value of 'trace' to this object.

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.

Field Description

The trace output.

Usage Notes

Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.

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.

Specified by:

lendTrace in interface ISrvMonTrace

Parameters:

val - The value to set.

Throws:

IllegalArgumentException - If the value is mutable.

setTraceFrom

void setTraceFrom(long val)

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

Field Description

The trace output.

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

Specified by:

setTraceFrom in interface ISrvMonTrace

getTraceTo

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

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

Field Description

The trace output.

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;

Specified by:

getTraceTo in interface ISrvMonTrace

Parameters:

factory - The factory from which to get the XString to copy into and return

Returns:

a new XString from the provided factory if this field is set or null.

Throws:

NullPointerException - if the provided factory is null

setTraceFrom

void setTraceFrom(XString val)

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

Field Description

The trace output.

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

Specified by:

setTraceFrom in interface ISrvMonTrace

getTraceTo

void getTraceTo(XString val)

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

Field Description

The trace output.

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

Specified by:

getTraceTo in interface ISrvMonTrace

See Also:

getTrace()

getTraceUnsafe

XString getTraceUnsafe()

Gets the raw value of 'trace'.

Field Description

The trace output.

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.

Specified by:

getTraceUnsafe in interface ISrvMonTrace

Returns:

the field's raw value

See Also:

getTrace()

clearTrace

void clearTrace()

Clears the value of 'trace'.

Field Description

The trace output.

Specified by:

clearTrace in interface ISrvMonTrace

See Also:

setTrace(String)

hasTrace

boolean hasTrace()

Checks for the presence of 'trace'.

Field Description

The trace output.

Specified by:

hasTrace in interface ISrvMonTrace

See Also:

getTrace()

setTracerName

void setTracerName(String val)

Sets the value of 'tracerName'.

Field Description

The tracer name (if available).

Specified by:

setTracerName in interface ISrvMonTrace

Parameters:

val - The value to set.

getTracerName

String getTracerName()

Gets the value of 'tracerName'.

Field Description

The tracer name (if available).

Specified by:

getTracerName in interface ISrvMonTrace

Returns:

The tracer name (if available).

lendTracerName

void lendTracerName(XString val)

Lends the value of 'tracerName' to this object.

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.

Field Description

The tracer name (if available).

Usage Notes

Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.

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.

Specified by:

lendTracerName in interface ISrvMonTrace

Parameters:

val - The value to set.

Throws:

IllegalArgumentException - If the value is mutable.

setTracerNameFrom

void setTracerNameFrom(long val)

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

Field Description

The tracer name (if available).

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

Specified by:

setTracerNameFrom in interface ISrvMonTrace

getTracerNameTo

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

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

Field Description

The tracer name (if available).

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;

Specified by:

getTracerNameTo in interface ISrvMonTrace

Parameters:

factory - The factory from which to get the XString to copy into and return

Returns:

a new XString from the provided factory if this field is set or null.

Throws:

NullPointerException - if the provided factory is null

setTracerNameFrom

void setTracerNameFrom(XString val)

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

Field Description

The tracer name (if available).

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

Specified by:

setTracerNameFrom in interface ISrvMonTrace

getTracerNameTo

void getTracerNameTo(XString val)

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

Field Description

The tracer name (if available).

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

Specified by:

getTracerNameTo in interface ISrvMonTrace

See Also:

getTracerName()

getTracerNameUnsafe

XString getTracerNameUnsafe()

Gets the raw value of 'tracerName'.

Field Description

The tracer name (if available).

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.

Specified by:

getTracerNameUnsafe in interface ISrvMonTrace

Returns:

the field's raw value

See Also:

getTracerName()

clearTracerName

void clearTracerName()

Clears the value of 'tracerName'.

Field Description

The tracer name (if available).

Specified by:

clearTracerName in interface ISrvMonTrace

See Also:

setTracerName(String)

hasTracerName

boolean hasTracerName()

Checks for the presence of 'tracerName'.

Field Description

The tracer name (if available).

Specified by:

hasTracerName in interface ISrvMonTrace

See Also:

getTracerName()

setProcessId

void setProcessId(String val)

Sets the value of 'processId'.

Field Description

The process id (if available).

Specified by:

setProcessId in interface ISrvMonTrace

Parameters:

val - The value to set.

getProcessId

String getProcessId()

Gets the value of 'processId'.

Field Description

The process id (if available).

Specified by:

getProcessId in interface ISrvMonTrace

Returns:

The process id (if available).

lendProcessId

void lendProcessId(XString val)

Lends the value of 'processId' to this object.

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.

Field Description

The process id (if available).

Usage Notes

Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.

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.

Specified by:

lendProcessId in interface ISrvMonTrace

Parameters:

val - The value to set.

Throws:

IllegalArgumentException - If the value is mutable.

setProcessIdFrom

void setProcessIdFrom(long val)

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

Field Description

The process id (if available).

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

Specified by:

setProcessIdFrom in interface ISrvMonTrace

getProcessIdTo

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

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

Field Description

The process id (if available).

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;

Specified by:

getProcessIdTo in interface ISrvMonTrace

Parameters:

factory - The factory from which to get the XString to copy into and return

Returns:

a new XString from the provided factory if this field is set or null.

Throws:

NullPointerException - if the provided factory is null

setProcessIdFrom

void setProcessIdFrom(XString val)

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

Field Description

The process id (if available).

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

Specified by:

setProcessIdFrom in interface ISrvMonTrace

getProcessIdTo

void getProcessIdTo(XString val)

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

Field Description

The process id (if available).

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

Specified by:

getProcessIdTo in interface ISrvMonTrace

See Also:

getProcessId()

getProcessIdUnsafe

XString getProcessIdUnsafe()

Gets the raw value of 'processId'.

Field Description

The process id (if available).

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.

Specified by:

getProcessIdUnsafe in interface ISrvMonTrace

Returns:

the field's raw value

See Also:

getProcessId()

clearProcessId

void clearProcessId()

Clears the value of 'processId'.

Field Description

The process id (if available).

Specified by:

clearProcessId in interface ISrvMonTrace

See Also:

setProcessId(String)

hasProcessId

boolean hasProcessId()

Checks for the presence of 'processId'.

Field Description

The process id (if available).

Specified by:

hasProcessId in interface ISrvMonTrace

See Also:

getProcessId()

setXvmName

void setXvmName(String val)

Sets the value of 'xvmName'.

Field Description

The XVM name (if available).

Specified by:

setXvmName in interface ISrvMonTrace

Parameters:

val - The value to set.

getXvmName

String getXvmName()

Gets the value of 'xvmName'.

Field Description

The XVM name (if available).

Specified by:

getXvmName in interface ISrvMonTrace

Returns:

The XVM name (if available).

lendXvmName

void lendXvmName(XString val)

Lends the value of 'xvmName' to this object.

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.

Field Description

The XVM name (if available).

Usage Notes

Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.

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.

Specified by:

lendXvmName in interface ISrvMonTrace

Parameters:

val - The value to set.

Throws:

IllegalArgumentException - If the value is mutable.

setXvmNameFrom

void setXvmNameFrom(long val)

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

Field Description

The XVM name (if available).

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

Specified by:

setXvmNameFrom in interface ISrvMonTrace

getXvmNameTo

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

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

Field Description

The XVM name (if available).

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;

Specified by:

getXvmNameTo in interface ISrvMonTrace

Parameters:

factory - The factory from which to get the XString to copy into and return

Returns:

a new XString from the provided factory if this field is set or null.

Throws:

NullPointerException - if the provided factory is null

setXvmNameFrom

void setXvmNameFrom(XString val)

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

Field Description

The XVM name (if available).

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

Specified by:

setXvmNameFrom in interface ISrvMonTrace

getXvmNameTo

void getXvmNameTo(XString val)

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

Field Description

The XVM name (if available).

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

Specified by:

getXvmNameTo in interface ISrvMonTrace

See Also:

getXvmName()

getXvmNameUnsafe

XString getXvmNameUnsafe()

Gets the raw value of 'xvmName'.

Field Description

The XVM name (if available).

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.

Specified by:

getXvmNameUnsafe in interface ISrvMonTrace

Returns:

the field's raw value

See Also:

getXvmName()

clearXvmName

void clearXvmName()

Clears the value of 'xvmName'.

Field Description

The XVM name (if available).

Specified by:

clearXvmName in interface ISrvMonTrace

See Also:

setXvmName(String)

hasXvmName

boolean hasXvmName()

Checks for the presence of 'xvmName'.

Field Description

The XVM name (if available).

Specified by:

hasXvmName in interface ISrvMonTrace

See Also:

getXvmName()

setHostAddress

void setHostAddress(String val)

Sets the value of 'hostAddress'.

Field Description

The host address (if available).

Specified by:

setHostAddress in interface ISrvMonTrace

Parameters:

val - The value to set.

getHostAddress

String getHostAddress()

Gets the value of 'hostAddress'.

Field Description

The host address (if available).

Specified by:

getHostAddress in interface ISrvMonTrace

Returns:

The host address (if available).

lendHostAddress

void lendHostAddress(XString val)

Lends the value of 'hostAddress' to this object.

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.

Field Description

The host address (if available).

Usage Notes

Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.

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.

Specified by:

lendHostAddress in interface ISrvMonTrace

Parameters:

val - The value to set.

Throws:

IllegalArgumentException - If the value is mutable.

setHostAddressFrom

void setHostAddressFrom(long val)

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

Field Description

The host address (if available).

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

Specified by:

setHostAddressFrom in interface ISrvMonTrace

getHostAddressTo

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

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

Field Description

The host address (if available).

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;

Specified by:

getHostAddressTo in interface ISrvMonTrace

Parameters:

factory - The factory from which to get the XString to copy into and return

Returns:

a new XString from the provided factory if this field is set or null.

Throws:

NullPointerException - if the provided factory is null

setHostAddressFrom

void setHostAddressFrom(XString val)

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

Field Description

The host address (if available).

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

Specified by:

setHostAddressFrom in interface ISrvMonTrace

getHostAddressTo

void getHostAddressTo(XString val)

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

Field Description

The host address (if available).

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

Specified by:

getHostAddressTo in interface ISrvMonTrace

See Also:

getHostAddress()

getHostAddressUnsafe

XString getHostAddressUnsafe()

Gets the raw value of 'hostAddress'.

Field Description

The host address (if available).

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.

Specified by:

getHostAddressUnsafe in interface ISrvMonTrace

Returns:

the field's raw value

See Also:

getHostAddress()

clearHostAddress

void clearHostAddress()

Clears the value of 'hostAddress'.

Field Description

The host address (if available).

Specified by:

clearHostAddress in interface ISrvMonTrace

See Also:

setHostAddress(String)

hasHostAddress

boolean hasHostAddress()

Checks for the presence of 'hostAddress'.

Field Description

The host address (if available).

Specified by:

hasHostAddress in interface ISrvMonTrace

See Also:

getHostAddress()

setHostName

void setHostName(String val)

Sets the value of 'hostName'.

Field Description

The host name (if available).

Specified by:

setHostName in interface ISrvMonTrace

Parameters:

val - The value to set.

getHostName

String getHostName()

Gets the value of 'hostName'.

Field Description

The host name (if available).

Specified by:

getHostName in interface ISrvMonTrace

Returns:

The host name (if available).

lendHostName

void lendHostName(XString val)

Lends the value of 'hostName' to this object.

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.

Field Description

The host name (if available).

Usage Notes

Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.

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.

Specified by:

lendHostName in interface ISrvMonTrace

Parameters:

val - The value to set.

Throws:

IllegalArgumentException - If the value is mutable.

setHostNameFrom

void setHostNameFrom(long val)

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

Field Description

The host name (if available).

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

Specified by:

setHostNameFrom in interface ISrvMonTrace

getHostNameTo

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

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

Field Description

The host name (if available).

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;

Specified by:

getHostNameTo in interface ISrvMonTrace

Parameters:

factory - The factory from which to get the XString to copy into and return

Returns:

a new XString from the provided factory if this field is set or null.

Throws:

NullPointerException - if the provided factory is null

setHostNameFrom

void setHostNameFrom(XString val)

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

Field Description

The host name (if available).

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

Specified by:

setHostNameFrom in interface ISrvMonTrace

getHostNameTo

void getHostNameTo(XString val)

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

Field Description

The host name (if available).

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

Specified by:

getHostNameTo in interface ISrvMonTrace

See Also:

getHostName()

getHostNameUnsafe

XString getHostNameUnsafe()

Gets the raw value of 'hostName'.

Field Description

The host name (if available).

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.

Specified by:

getHostNameUnsafe in interface ISrvMonTrace

Returns:

the field's raw value

See Also:

getHostName()

clearHostName

void clearHostName()

Clears the value of 'hostName'.

Field Description

The host name (if available).

Specified by:

clearHostName in interface ISrvMonTrace

See Also:

setHostName(String)

hasHostName

boolean hasHostName()

Checks for the presence of 'hostName'.

Field Description

The host name (if available).

Specified by:

hasHostName in interface ISrvMonTrace

See Also:

getHostName()

copy

SrvMonTraceRecord copy()

Creates a copy of this SrvMonTraceRecord.

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.

Specified by:

copy in interface CopyableMessageView<ISrvMonTraceRecord>

Specified by:

copy in interface IRogCopyableNode<ISrvMonTraceRecord>

Returns:

A copy of this SrvMonTraceRecord.

See Also:

IRogCopyableNode, CopyableMessageView

copyInto

void copyInto(SrvMonTraceRecord target)

Copies the contents of this SrvMonTraceRecord into the target.

The copy clears the target's contents and copies primitive, enum and embedded entity fields into the provided copy. Each embedded entity field is cloned so that modifications made to the copy's embedded entity fields do not affect this 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.

Parameters:

target - The target to copy into which must not be null or read only.