com.neeve.server.mon

Interface ISrvMonAppClientDisconnectMessage

All Superinterfaces:

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

All Known Implementing Classes:

SrvMonAppClientDisconnectMessage

Deprecated.

- This message type has been replaced with that of the same name in the SrvMonLifecycleFactory.

ADM Details

ADM Type	Message
Factory	SrvMonFactory

ADM Field Summary

Field	Type	Id	Description
appName	String	1	The app from which the client disconnected.
clientName	String	2	The name of the client that disconnected.

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

The 'SrvMonAppClientDisconnectMessage' type.

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	clearAppName() Deprecated. Clears the value of 'appName'.
void	clearClientName() Deprecated. Clears the value of 'clientName'.
SrvMonAppClientDisconnectMessage	copy() Deprecated. Creates a copy of this SrvMonAppClientDisconnectMessage.
void	copyInto(SrvMonAppClientDisconnectMessage target) Deprecated. Copies the contents of this SrvMonAppClientDisconnectMessage into the target.
String	getAppName() Deprecated. Gets the value of 'appName'.
<T extends XString> T	getAppNameTo(XString.Factory<T> factory) Deprecated. Copies the value of this String field into a new XString from the given factory.
void	getAppNameTo(XString val) Deprecated. Copies the value of 'appName' into the provided XString.
XString	getAppNameUnsafe() Deprecated. Gets the raw value of 'appName'.
String	getClientName() Deprecated. Gets the value of 'clientName'.
<T extends XString> T	getClientNameTo(XString.Factory<T> factory) Deprecated. Copies the value of this String field into a new XString from the given factory.
void	getClientNameTo(XString val) Deprecated. Copies the value of 'clientName' into the provided XString.
XString	getClientNameUnsafe() Deprecated. Gets the raw value of 'clientName'.
boolean	hasAppName() Deprecated. Checks for the presence of 'appName'.
boolean	hasClientName() Deprecated. Checks for the presence of 'clientName'.
void	lendAppName(XString val) Deprecated. Lends the value of 'appName' to this object.
void	lendClientName(XString val) Deprecated. Lends the value of 'clientName' to this object.
void	setAppName(String val) Deprecated. Sets the value of 'appName'.
void	setAppNameFrom(long val) Deprecated. Sets the value of this String field to the given numeric value.
void	setAppNameFrom(XString val) Deprecated. Copies the provided XString value into this object's 'appName'.
void	setClientName(String val) Deprecated. Sets the value of 'clientName'.
void	setClientNameFrom(long val) Deprecated. Sets the value of this String field to the given numeric value.
void	setClientNameFrom(XString val) Deprecated. Copies the provided XString value into this object's 'clientName'.

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

setAppName

void setAppName(String val)

Deprecated.

Sets the value of 'appName'.

Field Description

The app from which the client disconnected.

Parameters:

val - The value to set.

getAppName

String getAppName()

Deprecated.

Gets the value of 'appName'.

Field Description

The app from which the client disconnected.

Returns:

The app from which the client disconnected.

lendAppName

void lendAppName(XString val)

Deprecated.

Lends the value of 'appName' to this object.

This method is equivalent to setAppName 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 app from which the client disconnected.

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.

Parameters:

val - The value to set.

Throws:

IllegalArgumentException - If the value is mutable.

setAppNameFrom

void setAppNameFrom(long val)

Deprecated.

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

Field Description

The app from which the client disconnected.

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

getAppNameTo

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

Deprecated.

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

Field Description

The app from which the client disconnected.

If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);

This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;

Parameters:

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

Returns:

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

Throws:

NullPointerException - if the provided factory is null

setAppNameFrom

void setAppNameFrom(XString val)

Deprecated.

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

Field Description

The app from which the client disconnected.

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

getAppNameTo

void getAppNameTo(XString val)

Deprecated.

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

Field Description

The app from which the client disconnected.

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

See Also:

getAppName()

getAppNameUnsafe

XString getAppNameUnsafe()

Deprecated.

Gets the raw value of 'appName'.

Field Description

The app from which the client disconnected.

NOTE:
This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.

However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.

Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.

Returns:

the field's raw value

See Also:

getAppName()

clearAppName

void clearAppName()

Deprecated.

Clears the value of 'appName'.

Field Description

The app from which the client disconnected.

See Also:

setAppName(String)

hasAppName

boolean hasAppName()

Deprecated.

Checks for the presence of 'appName'.

Field Description

The app from which the client disconnected.

See Also:

getAppName()

setClientName

void setClientName(String val)

Deprecated.

Sets the value of 'clientName'.

Field Description

The name of the client that disconnected.

Parameters:

val - The value to set.

getClientName

String getClientName()

Deprecated.

Gets the value of 'clientName'.

Field Description

The name of the client that disconnected.

Returns:

The name of the client that disconnected.

lendClientName

void lendClientName(XString val)

Deprecated.

Lends the value of 'clientName' to this object.

This method is equivalent to setClientName 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 name of the client that disconnected.

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.

Parameters:

val - The value to set.

Throws:

IllegalArgumentException - If the value is mutable.

setClientNameFrom

void setClientNameFrom(long val)

Deprecated.

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

Field Description

The name of the client that disconnected.

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

getClientNameTo

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

Deprecated.

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

Field Description

The name of the client that disconnected.

If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);

This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;

Parameters:

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

Returns:

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

Throws:

NullPointerException - if the provided factory is null

setClientNameFrom

void setClientNameFrom(XString val)

Deprecated.

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

Field Description

The name of the client that disconnected.

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

getClientNameTo

void getClientNameTo(XString val)

Deprecated.

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

Field Description

The name of the client that disconnected.

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

See Also:

getClientName()

getClientNameUnsafe

XString getClientNameUnsafe()

Deprecated.

Gets the raw value of 'clientName'.

Field Description

The name of the client that disconnected.

NOTE:
This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.

However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.

Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.

Returns:

the field's raw value

See Also:

getClientName()

clearClientName

void clearClientName()

Deprecated.

Clears the value of 'clientName'.

Field Description

The name of the client that disconnected.

See Also:

setClientName(String)

hasClientName

boolean hasClientName()

Deprecated.

Checks for the presence of 'clientName'.

Field Description

The name of the client that disconnected.

See Also:

getClientName()

copy

SrvMonAppClientDisconnectMessage copy()

Deprecated.

Creates a copy of this SrvMonAppClientDisconnectMessage.

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

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

Specified by:

copy in interface IRogCopyableNode<ISrvMonAppClientDisconnectMessage>

Returns:

A copy of this SrvMonAppClientDisconnectMessage.

See Also:

IRogCopyableNode, CopyableMessageView

copyInto

void copyInto(SrvMonAppClientDisconnectMessage target)

Deprecated.

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

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