com.neeve.server.mon
Class SrvMonAppClientConnectMessage

java.lang.Object
  com.neeve.util.UtlListElement
      com.neeve.sma.MessageViewImpl
          com.neeve.rog.impl.RogNode
              com.neeve.server.mon.SrvMonAppClientConnectMessage

All Implemented Interfaces:

com.neeve.link.ILnkMessage, IStoreObject, IRogCopyableNode<ISrvMonAppClientConnectMessage>, IRogJsonizable, IRogMessage, IRogMetadata, IRogNode, IRogValidatable, ISrvMonAppClientConnectMessage, CopyableMessageView<ISrvMonAppClientConnectMessage>, MapMessageView, MessageReflector, MessageView, UtlReferenceTracker.HasReferenceTracker, com.neeve.xbuf.IXbufDesyncer

@Generated(value="com.neeve.adm.AdmXbufGenerator",
           date="Wed Mar 28 10:54:31 EDT 2018")
@AdmGenerated(encoding="Xbuf",
              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)")
@AdmFactoryInfo(factoryClass=SrvMonFactory.class,
                vfid=32,
                ofid=32,
                typeId=8)
public final class SrvMonAppClientConnectMessage
extends com.neeve.rog.impl.RogNode
implements ISrvMonAppClientConnectMessage, com.neeve.link.ILnkMessage, MessageReflector, com.neeve.xbuf.IXbufDesyncer, IRogJsonizable

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

Nested Class Summary

static class

SrvMonAppClientConnectMessage.PacketBody The backing packet type for SrvMonAppClientConnectMessage (used internally for serialization purposes).

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

IRogNode.PoolingListener

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

IStoreObject.EncodingType

Field Summary

static SrvMonAppClientConnectMessage[]

EMPTY_ARRAY A preallocated empty array used to avoid garbage when returning empty arrays of this type.

Fields inherited from class com.neeve.rog.impl.RogNode

DATE_FORMAT

Fields inherited from class com.neeve.util.UtlListElement

count, head, next, prev

Method Summary

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	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.
void	clearContent()
void	clearXRogType()
SrvMonAppClientConnectMessage	copy() Creates a copy of this SrvMonAppClientConnectMessage.
void	copyInto(SrvMonAppClientConnectMessage copy) Copies the contents of this SrvMonAppClientConnectMessage into the target.
static SrvMonAppClientConnectMessage	create()
static SrvMonAppClientConnectMessage	create(com.eaio.uuid.UUID id)
static SrvMonAppClientConnectMessage	createFrom(byte[] serializedContainer)
static SrvMonAppClientConnectMessage	createFrom(ByteBuffer serializedContainer)
static SrvMonAppClientConnectMessage	createFromJson(String json)
static SrvMonAppClientConnectMessage	createFromRawJson(String json)
static SrvMonAppClientConnectMessage	createFromSerializedXbufContainer(byte[] serializedContainer)
static SrvMonAppClientConnectMessage	createFromSerializedXbufContainer(ByteBuffer serializedContainer)
static SrvMonAppClientConnectMessage	createFromSerializedXbufContainerPacket(byte[] serializedPacket)
static SrvMonAppClientConnectMessage	createFromSerializedXbufContainerPacket(ByteBuffer serializedPacket)
static SrvMonAppClientConnectMessage	createFromXbufContainerPacket(PktPacket packet)
static com.neeve.xbuf.XbufSchema	createSchema()
SrvMonAppClientConnectMessage	deserialize(PktPacket packet) Deserialize an object's data.
SrvMonAppClientConnectMessage	deserializeFromByteArray(byte[] array) Deserialize a view's backing message from a byte array.
SrvMonAppClientConnectMessage	deserializeFromByteBuffer(ByteBuffer buffer) Deserialize a view's backing message from a byte buffer.
SrvMonAppClientConnectMessage	deserializeFromJson(String json) Deserialize a view's backing message from a json string
SrvMonAppClientConnectMessage	deserializeFromPacket(PktPacket packet) Deserialize a view's backing message from a packet.
SrvMonAppClientConnectMessage	deserializeFromProtobuf(com.google.protobuf.Message message) Deserialize a node's data from a protobuf message.
SrvMonAppClientConnectMessage	deserializeFromRawJson(String json)
int	desync(PktBuffer buffer, int pos, boolean frameOnly)
void	desyncFieldBitmask()
int	dispose() Default implementation of MessageView.dispose() This is the default implementation of the dispose method.
boolean	fieldExists(Object message, String name) Check if a field of the supplied name exists in a message.
String	getAppName() Gets the value of 'appName' Field Description The app to which the client connected.
com.neeve.xbuf.XbufStringField	getAppNameField()
static int	getAppNameFieldId() Get the field id for 'appName' This method can be used to set field interests.
<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'.
PktBuffer	getBackingBuffer()
SrvMonAppClientInfo	getClientInfo() Gets the value of 'clientInfo' Field Description Hold information about the connecting client.
static int	getClientInfoFieldId() Get the field id for 'clientInfo' This method can be used to set field interests.
void	getClientInfoTo(SrvMonAppClientInfo to) Copies the value of SrvMonAppClientInfo into the provided value.
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.
PktPacket	getPacket()
short	getXRogType()
com.neeve.xbuf.XbufVariableShortField	getXRogTypeField()
static int	getXRogTypeFieldId() Get the field id for 'xRogType' This method can be used to set field interests.
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.
boolean	hasXRogType()
boolean	isDirty()
boolean	isFieldReflectable(Object message, String name) Check if a field of the supplied name is reflectable.
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.
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	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(com.neeve.xbuf.XbufStringField val)
void	setAppNameFrom(XString val) Copies the provided XString value into this object's 'appName'.
void	setAsReadOnly() Set whether a node is read only Note: This read-only flag only applies to data, not metadata
void	setClientInfo(SrvMonAppClientInfo val) Sets the value of 'clientInfo' Field Description Hold information about the connecting client.
static void	setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
static void	setFieldInterest(List<Integer> fieldIds)
IStoreObject	setFieldValue(int id, Object val) Set the value of an object field.
void	setXRogType(short val)
void	setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)
void	sync() Ensure a view's backing message is prepared and ready for transport
void	syncFieldBitmask()
SrvMonAppClientInfo	takeClientInfo() 'Takes' a reference to the clientInfo 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 this object
void	undispose(com.eaio.uuid.UUID id)

Methods inherited from class com.neeve.rog.impl.RogNode

accept, deserializeMetadata, deserializeMetadata, dump, ensureId, getAppSendBeginTs, getAppSendDoneTs, getAttachment, getBinding, getCheckpointVersion, getCreateTs, getEnqueueTs, getEnqueueTsMicros, getFields, getGraphId, getId, getInMsgsInTransaction, getIsInboundMessage, getIsInternal, getIsLastTransaction, getIsMessage, getIsOutboundMessage, getIsPriority, getIsReadOnly, getIsReplayedMessage, getMessageBus, getMessageBusAsRaw, getMessageChannel, getMessageChannelAsRaw, getMessageFlow, getMessageKey, getMessageKeyAsRaw, getMessageReflector, getMessageSender, getMessageSequenceNumber, 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, getTransactionId, getTransactionInSequenceNumber, getTransactionOutSequenceNumber, getTypeFromJson, getValidationErrors, isPossibleDuplicate, isValid, metadataToJsonString, metadataToJsonString, metadataToString, serializeMetadata, setAppSendBeginTs, setAppSendDoneTs, setAsInboundMessage, setAsInternal, setAsLastTransaction, setAsMessage, setAsOutboundMessage, setAsPriority, setAsReplayedMessage, setAttachment, setBinding, setCheckpointVersion, setCreateTs, setEnqueueTsMicros, setId, setInMsgsInTransaction, setMessageBus, setMessageBusAsRaw, setMessageChannel, setMessageChannelAsRaw, setMessageFlow, setMessageKey, setMessageKeyAsRaw, setMessageSender, setMessageSequenceNumber, 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

Methods inherited from class com.neeve.sma.MessageViewImpl

acquire, getMessage, getMessageEncodingType, getOwnershipCount, getTag, getType, getVfid, referenceTracker, setTag

Methods inherited from class com.neeve.util.UtlListElement

count, insertAfter, insertBefore, isLinked, next, previous, unlink, wipe

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.neeve.rog.IRogNode

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

Methods inherited from interface com.neeve.ods.IStoreObject

acquire, deserializeMetadata, deserializeMetadata, ensureId, getBinding, getCheckpointVersion, getId, getOfid, getOwnershipCount, getSerializedMetadataLength, getStableTransactionId, getTransactionId, serializeMetadata, setBinding, setCheckpointVersion, 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

Field Detail

EMPTY_ARRAY

public static final SrvMonAppClientConnectMessage[] EMPTY_ARRAY

A preallocated empty array used to avoid garbage when returning empty arrays of this type.

Method Detail

create

public static SrvMonAppClientConnectMessage create()

create

public static SrvMonAppClientConnectMessage create(com.eaio.uuid.UUID id)

createFromXbufContainerPacket

public static SrvMonAppClientConnectMessage createFromXbufContainerPacket(PktPacket packet)

createFromSerializedXbufContainerPacket

public static SrvMonAppClientConnectMessage createFromSerializedXbufContainerPacket(ByteBuffer serializedPacket)

createFromSerializedXbufContainerPacket

public static SrvMonAppClientConnectMessage createFromSerializedXbufContainerPacket(byte[] serializedPacket)

createFromSerializedXbufContainer

public static SrvMonAppClientConnectMessage createFromSerializedXbufContainer(ByteBuffer serializedContainer)

createFromSerializedXbufContainer

public static SrvMonAppClientConnectMessage createFromSerializedXbufContainer(byte[] serializedContainer)

createFromRawJson

public static SrvMonAppClientConnectMessage createFromRawJson(String json)

createFromJson

public static SrvMonAppClientConnectMessage createFromJson(String json)

createFrom

public static SrvMonAppClientConnectMessage createFrom(ByteBuffer serializedContainer)

createFrom

public static SrvMonAppClientConnectMessage createFrom(byte[] serializedContainer)

setDesyncPolicy

public static final void setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)

getDesyncPolicy

public static final com.neeve.xbuf.XbufDesyncPolicy getDesyncPolicy()

setFieldInterest

public static final void setFieldInterest(List<Integer> fieldIds)

clearContent

public final void clearContent()

syncFieldBitmask

public final void syncFieldBitmask()

desyncFieldBitmask

public final void desyncFieldBitmask()

getBackingBuffer

public final PktBuffer getBackingBuffer()

optimizeFor

public static final void optimizeFor(int val)

getPacket

public final PktPacket getPacket()

Specified by:

getPacket in interface com.neeve.link.ILnkMessage

serializeToProtobuf

public final com.google.protobuf.Message serializeToProtobuf()

Description copied from interface: IRogNode

Serialize a node's data to a proto message.

Specified by:

serializeToProtobuf in interface IRogNode

serializeToRawJson

public final String serializeToRawJson()

serializeToJson

public final String serializeToJson()

Description copied from interface: MessageView

Serialize a view's backing message to JSON.

Serializing/deserializing a message to/from JSON is an optional operation

Specified by:

serializeToJson in interface MessageView

deserializeFromProtobuf

public final SrvMonAppClientConnectMessage deserializeFromProtobuf(com.google.protobuf.Message message)

Description copied from interface: IRogNode

Deserialize a node's data from a protobuf message.

Specified by:

deserializeFromProtobuf in interface IRogNode

Parameters:

message - The protobuf message

deserializeFromRawJson

public final SrvMonAppClientConnectMessage deserializeFromRawJson(String json)

deserializeFromJson

public final SrvMonAppClientConnectMessage deserializeFromJson(String json)

Description copied from interface: MessageView

Deserialize a view's backing message from a json string

Specified by:

deserializeFromJson in interface MessageView

Parameters:

json - The view's backing message serialized as a json string.

Serializing/deserializing a message to/from JSON is an optional operation

setAsReadOnly

public final void setAsReadOnly()

Description copied from interface: IRogNode

Set whether a node is read only

Note: This read-only flag only applies to data, not metadata

Specified by:

setAsReadOnly in interface IRogNode

Overrides:

setAsReadOnly in class com.neeve.rog.impl.RogNode

dispose

public int dispose()

Description copied from class: MessageViewImpl

Default implementation of MessageView.dispose()

This is the default implementation of the dispose method. The implementation just decrements the ownership count. Implementations that implement view object pooling or other such functionality should override this method but invoke this method to decrement the object reference count.

Specified by:

dispose in interface IStoreObject

Specified by:

dispose in interface IRogNode

Specified by:

dispose in interface MessageView

Overrides:

dispose in class com.neeve.rog.impl.RogNode

Returns:

The reference count after the dispose completed.

undispose

public void undispose(com.eaio.uuid.UUID id)

Overrides:

undispose in class com.neeve.rog.impl.RogNode

getXRogTypeFieldId

public static final int getXRogTypeFieldId()

Get the field id for 'xRogType'

This method can be used to set field interests.

See Also:

getXRogType()

setXRogType

public final void setXRogType(short val)

getXRogType

public final short getXRogType()

setXRogTypeFrom

public final void setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)

getXRogTypeField

public final com.neeve.xbuf.XbufVariableShortField getXRogTypeField()

hasXRogType

public final boolean hasXRogType()

clearXRogType

public final void clearXRogType()

getAppNameFieldId

public static final int getAppNameFieldId()

Get the field id for 'appName'

This method can be used to set field interests.

See Also:

getAppName()

setAppName

public final void setAppName(String val)

Description copied from interface: ISrvMonAppClientConnectMessage

Sets the value of 'appName'

Field Description

The app to which the client connected.

Specified by:

setAppName in interface ISrvMonAppClientConnectMessage

Parameters:

val - The value to set.

getAppName

public final String getAppName()

Description copied from interface: ISrvMonAppClientConnectMessage

Gets the value of 'appName'

Field Description

The app to which the client connected.

Specified by:

getAppName in interface ISrvMonAppClientConnectMessage

Returns:

The app to which the client connected.

lendAppName

public final void lendAppName(XString val)

Description copied from interface: ISrvMonAppClientConnectMessage

Sets the value of 'appName'

Field Description

The app to which the client connected.

Specified by:

lendAppName in interface ISrvMonAppClientConnectMessage

Parameters:

val - The value to set.

setAppNameFrom

public final void setAppNameFrom(long val)

Description copied from interface: ISrvMonAppClientConnectMessage

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 ISrvMonAppClientConnectMessage.setAppName(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

Specified by:

setAppNameFrom in interface ISrvMonAppClientConnectMessage

getAppNameTo

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

Description copied from interface: ISrvMonAppClientConnectMessage

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;

Specified by:

getAppNameTo in interface ISrvMonAppClientConnectMessage

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.

setAppNameFrom

public final void setAppNameFrom(XString val)

Description copied from interface: ISrvMonAppClientConnectMessage

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 ISrvMonAppClientConnectMessage.setAppName(String) because it avoids encoding the value into a String if the given XString is already encoded.

Specified by:

setAppNameFrom in interface ISrvMonAppClientConnectMessage

getAppNameTo

public final void getAppNameTo(XString val)

Description copied from interface: ISrvMonAppClientConnectMessage

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 ISrvMonAppClientConnectMessage.getAppName() bec because it can avoid decoding the value into an String.

Specified by:

getAppNameTo in interface ISrvMonAppClientConnectMessage

See Also:

ISrvMonAppClientConnectMessage.getAppName()

getAppNameUnsafe

public final XString getAppNameUnsafe()

Description copied from interface: ISrvMonAppClientConnectMessage

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.

Specified by:

getAppNameUnsafe in interface ISrvMonAppClientConnectMessage

Returns:

the field's raw value

See Also:

ISrvMonAppClientConnectMessage.getAppName()

setAppNameFrom

public final void setAppNameFrom(com.neeve.xbuf.XbufStringField val)

getAppNameField

public final com.neeve.xbuf.XbufStringField getAppNameField()

hasAppName

public final boolean hasAppName()

Description copied from interface: ISrvMonAppClientConnectMessage

Checks for the presence of 'appName'

Field Description

The app to which the client connected.

Specified by:

hasAppName in interface ISrvMonAppClientConnectMessage

See Also:

ISrvMonAppClientConnectMessage.getAppName()

clearAppName

public final void clearAppName()

Description copied from interface: ISrvMonAppClientConnectMessage

Clears the value of 'appName'

Field Description

The app to which the client connected.

Specified by:

clearAppName in interface ISrvMonAppClientConnectMessage

See Also:

ISrvMonAppClientConnectMessage.setAppName(String)

getClientInfoFieldId

public static final int getClientInfoFieldId()

Get the field id for 'clientInfo'

This method can be used to set field interests.

See Also:

getClientInfo()

setClientInfo

public final void setClientInfo(SrvMonAppClientInfo val)

Description copied from interface: ISrvMonAppClientConnectMessage

Sets the value of 'clientInfo'

Field Description

Hold information about the connecting client.

Specified by:

setClientInfo in interface ISrvMonAppClientConnectMessage

Parameters:

val - The value to set.

lendClientInfo

public final void lendClientInfo(SrvMonAppClientInfo val)

Description copied from interface: ISrvMonAppClientConnectMessage

'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.

Specified by:

lendClientInfo in interface ISrvMonAppClientConnectMessage

Parameters:

val - the value to 'lend' to lend.

getClientInfo

public final SrvMonAppClientInfo getClientInfo()

Description copied from interface: ISrvMonAppClientConnectMessage

Gets the value of 'clientInfo'

Field Description

Hold information about the connecting client.

Specified by:

getClientInfo in interface ISrvMonAppClientConnectMessage

Returns:

Hold information about the connecting client.

getClientInfoTo

public final void getClientInfoTo(SrvMonAppClientInfo to)

Description copied from interface: ISrvMonAppClientConnectMessage

Copies the value of SrvMonAppClientInfo into the provided value.

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

Specified by:

getClientInfoTo in interface ISrvMonAppClientConnectMessage

Parameters:

to - the value to copy into

See Also:

SrvMonAppClientInfo.copyInto(SrvMonAppClientInfo)

takeClientInfo

public final SrvMonAppClientInfo takeClientInfo()

Description copied from interface: ISrvMonAppClientConnectMessage

'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.

Specified by:

takeClientInfo in interface ISrvMonAppClientConnectMessage

Returns:

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

hasClientInfo

public final boolean hasClientInfo()

Description copied from interface: ISrvMonAppClientConnectMessage

Checks for the presence of 'clientInfo'

Field Description

Hold information about the connecting client.

Specified by:

hasClientInfo in interface ISrvMonAppClientConnectMessage

See Also:

ISrvMonAppClientConnectMessage.getClientInfo()

clearClientInfo

public final void clearClientInfo()

Description copied from interface: ISrvMonAppClientConnectMessage

Clears the value of 'clientInfo'

Field Description

Hold information about the connecting client.

Specified by:

clearClientInfo in interface ISrvMonAppClientConnectMessage

See Also:

ISrvMonAppClientConnectMessage.setClientInfo(SrvMonAppClientInfo)

isDirty

public final boolean isDirty()

createSchema

public static final com.neeve.xbuf.XbufSchema createSchema()

serializeToByteArray

public final byte[] serializeToByteArray()

Description copied from interface: MessageView

Serialize a view's backing message to a byte array.

Specified by:

serializeToByteArray in interface MessageView

serializeToByteBuffer

public final ByteBuffer serializeToByteBuffer()

Description copied from interface: MessageView

Serialize a view's backing message to a byte buffer.

Specified by:

serializeToByteBuffer in interface MessageView

serializeToIOBuffer

public final com.neeve.io.IOBuffer serializeToIOBuffer(boolean useNative)

Description copied from interface: MessageView

Serializes the 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.

Specified by:

serializeToIOBuffer in interface MessageView

Overrides:

serializeToIOBuffer in class MessageViewImpl

Parameters:

useNative - Whether the returned buffer should be native.

Returns:

The MessageView serialized to an IOBuffer.

serializeToPacket

public final PktPacket serializeToPacket()

Description copied from interface: MessageView

Serialize a view's backing message to a packet.

Specified by:

serializeToPacket in interface MessageView

deserializeFromByteArray

public final SrvMonAppClientConnectMessage deserializeFromByteArray(byte[] array)

Description copied from interface: MessageView

Deserialize a view's backing message from a byte array.

Specified by:

deserializeFromByteArray in interface MessageView

Parameters:

array - The view's backing message serialized as a byte array.

deserializeFromByteBuffer

public final SrvMonAppClientConnectMessage deserializeFromByteBuffer(ByteBuffer buffer)

Description copied from interface: MessageView

Deserialize a view's backing message from a byte buffer.

Specified by:

deserializeFromByteBuffer in interface MessageView

Parameters:

buffer - The view's backing message serialized as a byte buffer.

deserializeFromPacket

public final SrvMonAppClientConnectMessage deserializeFromPacket(PktPacket packet)

Description copied from interface: MessageView

Deserialize a view's backing message from a packet.

Specified by:

deserializeFromPacket in interface MessageView

Parameters:

packet - The view's backing message serialized as a packet.

sync

public final void sync()

Description copied from interface: MessageView

Ensure a view's backing message is prepared and ready for transport

Specified by:

sync in interface MessageView

copy

public final 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.

Xbuf Pass-through Fields

When backed by a buffer, this operation copies the underlying buffer which means that if the message was deserialized from with unrecognized fields, such fields will be preserved in the copy as well.

Specified by:

copy in interface IRogCopyableNode<ISrvMonAppClientConnectMessage>

Specified by:

copy in interface ISrvMonAppClientConnectMessage

Specified by:

copy in interface CopyableMessageView<ISrvMonAppClientConnectMessage>

Returns:

A copy of this SrvMonAppClientConnectMessage.

See Also:

IRogCopyableNode, CopyableMessageView

copyInto

public final void copyInto(SrvMonAppClientConnectMessage copy)

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.

Xbuf Pass-through Fields

When backed by a buffer, this operation copies the underlying buffer which means that if the message was deserialized from with unrecognized fields, such fields will be preserved in the copy as well.

Specified by:

copyInto in interface ISrvMonAppClientConnectMessage

Parameters:

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

desync

public final int desync(PktBuffer buffer,
                        int pos,
                        boolean frameOnly)

Specified by:

desync in interface com.neeve.xbuf.IXbufDesyncer

needsSync

public boolean needsSync()

Description copied from interface: MessageReflector

Check if a view needs to be sync'd for reflection.

Specified by:

needsSync in interface MessageReflector

fieldExists

public final boolean fieldExists(Object message,
                                 String name)

Description copied from interface: MessageReflector

Check if a field of the supplied name exists in a message.

Specified by:

fieldExists in interface MessageReflector

Parameters:

message - The message to check in.

name - The field to check for.

isFieldReflectable

public final boolean isFieldReflectable(Object message,
                                        String name)

Description copied from interface: MessageReflector

Check if a field of the supplied name is reflectable.

Specified by:

isFieldReflectable in interface MessageReflector

Parameters:

message - The message to check in.

name - The field to check for.

Returns:

Returns null if a field of the supplied name is either not present in the message or is of a type that makes it non-reflectable.

getFieldValueAsString

public final String getFieldValueAsString(Object message,
                                          String name)

Description copied from interface: MessageReflector

Get the value of a reflectable field in a message as a string.

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.

Specified by:

getFieldValueAsString in interface MessageReflector

Parameters:

message - The message to introspect.

name - The field whose value is to be retrieved specified as a bean path

Returns:

Returns null if a field of the supplied name is not in the message or the field is of a type that is not reflectable or the field value is null. The caller should differentiate between these various cases through the use of the MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methods

getFieldValueAsString

public final String getFieldValueAsString(Object message,
                                          String[] pathComponents)

Description copied from interface: MessageReflector

Get the value of a reflectable field in a message as a string.

Specified by:

getFieldValueAsString in interface MessageReflector

Parameters:

message - The message to introspect.

pathComponents - The path components to use to access the field.

Returns:

Returns null if a field of the supplied pathComponents is not in the message or the field is of a type that is not reflectable or the field value is null. The caller should differentiate between these various cases through the use of the MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methods

getFieldValueAsRawString

public final XString getFieldValueAsRawString(Object message,
                                              String name)

Description copied from interface: MessageReflector

Get the value of a reflectable field in a message as a string.

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.

Specified by:

getFieldValueAsRawString in interface MessageReflector

Parameters:

message - The message to introspect.

name - The field whose value is to be retrieved specified as a bean path

Returns:

Returns null if a field of the supplied name is not in the message or the field is of a type that is not reflectable or the field value is null. The caller should differentiate between these various cases through the use of the MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methods

getFieldValueAsRawString

public final XString getFieldValueAsRawString(Object message,
                                              String[] pathComponents)

Description copied from interface: MessageReflector

Get the value of a reflectable field in a message as a string.

Specified by:

getFieldValueAsRawString in interface MessageReflector

Parameters:

message - The message to introspect.

pathComponents - The path components to use to access the field.

Returns:

Returns null if a field of the supplied pathComponents is not in the message or the field is of a type that is not reflectable or the field value is null. The caller should differentiate between these various cases through the use of the MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methods

appendFieldValueTo

public final boolean appendFieldValueTo(Object message,
                                        String name,
                                        XString target)

Description copied from interface: MessageReflector

Appends a reflected field value as a string into the given XString.

If the field is reflectable and has a non null value, then it will be appended otherwise, this method must return false.

Specified by:

appendFieldValueTo in interface MessageReflector

Overrides:

appendFieldValueTo in class com.neeve.rog.impl.RogNode

Parameters:

message - the node on which to reflect (which need not be this object).

name - the bean path to the field.

target - The target XString into which to append the result.

Returns:

true if the field was reflectable and had a value which could be appended, false otherwise.

appendFieldValueTo

public final boolean appendFieldValueTo(Object node,
                                        String[] pathComponents,
                                        XString target)

Description copied from interface: MessageReflector

Appends a reflected field value as a string into the given XString.

If the field is reflectable and has a non null value, then it will be appended otherwise, this method must return false.

Specified by:

appendFieldValueTo in interface MessageReflector

Overrides:

appendFieldValueTo in class com.neeve.rog.impl.RogNode

Parameters:

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.

Returns:

true if the field was reflectable and had a value which could be appended, false otherwise.

getContentEncodingType

public final IStoreObject.EncodingType getContentEncodingType()

Description copied from interface: IStoreObject

Get an object's content data encoding type.

Specified by:

getContentEncodingType in interface IStoreObject

serialize

public final PktPacket serialize()

Description copied from interface: IStoreObject

Serialize an object's data.

Specified by:

serialize in interface IStoreObject

deserialize

public final SrvMonAppClientConnectMessage deserialize(PktPacket packet)

Description copied from interface: IStoreObject

Deserialize an object's data.

Specified by:

deserialize in interface IStoreObject

Parameters:

packet - The object in serialized form.

Returns:

Returns 'this' object for invocation chaining.

setFieldValue

public final IStoreObject setFieldValue(int id,
                                        Object val)

Description copied from interface: IStoreObject

Set the value of an object field.

Specified by:

setFieldValue in interface IStoreObject

Overrides:

setFieldValue in class com.neeve.rog.impl.RogNode

Returns:

Returns this object for invocation chaining.

This method is invoked during the rollback process to restore field values.

toJsonString

public final String toJsonString(boolean includeMetadata,
                                 String metadataObjectName,
                                 String payloadObjectName)

Description copied from interface: IRogJsonizable

Get a full JSON representation of an ROG entity

Specified by:

toJsonString in interface IRogJsonizable

Parameters:

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.

toJsonString

public final String toJsonString()

Description copied from interface: IRogJsonizable

Get a JSON representation of an ROG entity

Specified by:

toJsonString in interface IRogJsonizable

toString

public final String toString()

Description copied from class: MessageViewImpl

Return a string representation of this object

Overrides:

toString in class com.neeve.rog.impl.RogNode