com.neeve.server.mon
Interface ISrvMonAppClientConnectMessage

All Superinterfaces:

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

All Known Implementing Classes:

SrvMonAppClientConnectMessage

@Generated(value="com.neeve.adm.AdmGenerator",
           date="Wed Mar 28 10:54:31 EDT 2018")
@AdmGenerated(compatLevel="3.8.0",
              admVersion="nvx-adm v3.7.265 (build 0)",
              date="3/28/18 10:54 AM",
              buildInfo="nvx-talon-3.7.265 (nvx-codegen-plugin)")
public interface ISrvMonAppClientConnectMessage
extends IRogNode, IRogMessage, IRogCopyableNode<ISrvMonAppClientConnectMessage>

Emitted by a Talon Server to registered admin clients when a client has connected to the server.

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

void	clearAppName() Clears the value of 'appName' Field Description The app to which the client connected.
void	clearClientInfo() Clears the value of 'clientInfo' Field Description Hold information about the connecting client.
SrvMonAppClientConnectMessage	copy() Creates a copy of this SrvMonAppClientConnectMessage.
void	copyInto(SrvMonAppClientConnectMessage target) Copies the contents of this SrvMonAppClientConnectMessage into the target.
String	getAppName() Gets the value of 'appName' Field Description The app to which the client connected.
<T extends XString> T	getAppNameTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getAppNameTo(XString val) Copies the value of 'appName' into the provided XString.
XString	getAppNameUnsafe() Gets the raw value of 'appName'.
SrvMonAppClientInfo	getClientInfo() Gets the value of 'clientInfo' Field Description Hold information about the connecting client.
void	getClientInfoTo(SrvMonAppClientInfo val) Copies the value of SrvMonAppClientInfo into the provided value.
boolean	hasAppName() Checks for the presence of 'appName' Field Description The app to which the client connected.
boolean	hasClientInfo() Checks for the presence of 'clientInfo' Field Description Hold information about the connecting client.
void	lendAppName(XString val) Sets the value of 'appName' Field Description The app to which the client connected.
void	lendClientInfo(SrvMonAppClientInfo val) 'Lends' a reference of the SrvMonAppClientInfo to the message for this field.
void	setAppName(String val) Sets the value of 'appName' Field Description The app to which the client connected.
void	setAppNameFrom(long val) Sets the value of this String field to the given numeric value.
void	setAppNameFrom(XString val) Copies the provided XString value into this object's 'appName'.
void	setClientInfo(SrvMonAppClientInfo val) Sets the value of 'clientInfo' Field Description Hold information about the connecting client.
SrvMonAppClientInfo	takeClientInfo() 'Takes' a reference to the clientInfo field from the message.

Methods inherited from interface com.neeve.rog.IRogNode

deserializeFromProtobuf, dispose, dump, getAttachment, 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, ensureId, getBinding, getCheckpointVersion, getContentEncodingType, getId, getOfid, getOwnershipCount, getSerializedMetadataLength, getStableTransactionId, getTransactionId, serialize, serializeMetadata, setBinding, setCheckpointVersion, setFieldValue, 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, 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)

Sets the value of 'appName'

Field Description

The app to which the client connected.

Parameters:

val - The value to set.

getAppName

String getAppName()

Gets the value of 'appName'

Field Description

The app to which the client connected.

Returns:

The app to which the client connected.

lendAppName

void lendAppName(XString val)

Sets the value of 'appName'

Field Description

The app to which the client connected.

Parameters:

val - The value to set.

setAppNameFrom

void setAppNameFrom(long val)

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

Field Description

The app to which the client connected.

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)

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

Field Description

The app to which the client connected.

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)

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

Field Description

The app to which the client connected.

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)

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

Field Description

The app to which the client connected.

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()

Gets the raw value of 'appName'.

Field Description

The app to which the client connected.

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()

Clears the value of 'appName'

Field Description

The app to which the client connected.

See Also:

setAppName(String)

hasAppName

boolean hasAppName()

Checks for the presence of 'appName'

Field Description

The app to which the client connected.

See Also:

getAppName()

setClientInfo

void setClientInfo(SrvMonAppClientInfo val)

Sets the value of 'clientInfo'

Field Description

Hold information about the connecting client.

Parameters:

val - The value to set.

lendClientInfo

void lendClientInfo(SrvMonAppClientInfo val)

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

Field Description

Hold information about the connecting client.

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.

Parameters:

val - the value to 'lend' to lend.

getClientInfo

SrvMonAppClientInfo getClientInfo()

Gets the value of 'clientInfo'

Field Description

Hold information about the connecting client.

Returns:

Hold information about the connecting client.

getClientInfoTo

void getClientInfoTo(SrvMonAppClientInfo val)

Copies the value of SrvMonAppClientInfo into the provided value.

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

Parameters:

val - the value to copy into

See Also:

SrvMonAppClientInfo.copyInto(SrvMonAppClientInfo)

takeClientInfo

SrvMonAppClientInfo takeClientInfo()

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

Field Description

Hold information about the connecting client.

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.

Returns:

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

hasClientInfo

boolean hasClientInfo()

Checks for the presence of 'clientInfo'

Field Description

Hold information about the connecting client.

See Also:

getClientInfo()

clearClientInfo

void clearClientInfo()

Clears the value of 'clientInfo'

Field Description

Hold information about the connecting client.

See Also:

setClientInfo(SrvMonAppClientInfo)

copy

SrvMonAppClientConnectMessage copy()

Creates a copy of this SrvMonAppClientConnectMessage.

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

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

Specified by:

copy in interface IRogCopyableNode<ISrvMonAppClientConnectMessage>

Returns:

A copy of this SrvMonAppClientConnectMessage.

See Also:

IRogCopyableNode, CopyableMessageView

copyInto

void copyInto(SrvMonAppClientConnectMessage target)

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

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