SrvMonAppClientInfo (Talon 3.14.19 API)

java.lang.Object
- com.neeve.server.mon.SrvMonAppClientInfo

All Implemented Interfaces:: IRogValidatable, ISrvMonAppClientInfo, UtlPool.Item<SrvMonAppClientInfo>, com.neeve.xbuf.IXbufDesyncer

@Generated(value="com.neeve.adm.AdmXbufGenerator",
           date="Thu May 07 15:37:32 EDT 2020")
@AdmGenerated(encoding="Xbuf",
              compatLevel="4.0.0",
              admVersion="nvx-rumi-adm v3.14 (build 29)",
              date="5/7/20 3:37 PM",
              buildInfo="nvx-talon-3.14.19 (nvx-codegen-plugin)")
@AdmFactoryInfo(factoryClass=SrvMonFactory.class,
                vfid=32,
                ofid=32,
                typeId=101)
public final class SrvMonAppClientInfo
extends Object
implements com.neeve.xbuf.IXbufDesyncer, UtlPool.Item<SrvMonAppClientInfo>, ISrvMonAppClientInfo

Holds information about a client connection to an application.

ADM Details

ADM Type	Embedded Entity
Factory	SrvMonFactory

ADM Field Summary

Field	Type	Id	Description
name	String	16	The connected client name.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SrvMonAppClientInfo.Field` The SrvMonAppClientInfo xbuf field (used internally when this entity is used as a field of another entity).
`static class`	`SrvMonAppClientInfo.ListField` The SrvMonAppClientInfo list field (used internally when this entity is used as an array field of another entity).

Field Summary

Fields
Modifier and Type Field and Description

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

Fields
Modifier and Type	Field and Description
`static SrvMonAppClientInfo[]`	`EMPTY_ARRAY` A preallocated empty array used to avoid garbage when returning empty arrays of this type.

Constructor Summary

Constructors
Constructor and Description

SrvMonAppClientInfo()

SrvMonAppClientInfo(int initialBackingBufferSize)

Constructors
Constructor and Description
`SrvMonAppClientInfo()`
`SrvMonAppClientInfo(int initialBackingBufferSize)`

Method Summary

Methods
Modifier and Type	Method and Description
`SrvMonAppClientInfo`	`acquire()`
`void`	`clearContent()`
`void`	`clearName()` Clears the value of 'name'.
`void`	`clearXRogType()`
`Object`	`clone()` Creates a clone of this object.
`SrvMonAppClientInfo`	`copy()` Creates a copy of this SrvMonAppClientInfo.
`void`	`copyInto(SrvMonAppClientInfo copy)` Copies the contents of this SrvMonAppClientInfo into the target.
`static SrvMonAppClientInfo`	`create()`
`static SrvMonAppClientInfo`	`createFrom(byte[] serializedContainer)`
`static SrvMonAppClientInfo`	`createFrom(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)`
`static SrvMonAppClientInfo`	`createFromSerializedXbufContainer(byte[] serializedContainer)`
`static SrvMonAppClientInfo`	`createFromSerializedXbufContainer(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)`
`static com.neeve.xbuf.XbufSchema`	`createSchema()`
`SrvMonAppClientInfo`	`deserializeFromByteArray(byte[] array)`
`SrvMonAppClientInfo`	`deserializeFromByteArray(byte[] array, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)`
`SrvMonAppClientInfo`	`deserializeFromByteBuffer(ByteBuffer buffer)`
`SrvMonAppClientInfo`	`deserializeFromByteBuffer(ByteBuffer buffer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)`
`SrvMonAppClientInfo`	`deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length)`
`SrvMonAppClientInfo`	`deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)`
`SrvMonAppClientInfo`	`deserializeFromNative(long address, int offset, int length)`
`SrvMonAppClientInfo`	`deserializeFromNative(long address, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)`
`int`	`desync(PktBuffer buffer, int pos, boolean frameOnly)` Desync fields from a buffer
`void`	`desyncFieldBitmask()`
`void`	`dispose()`
`PktBuffer`	`getBackingBuffer()`
`static com.neeve.xbuf.XbufDesyncPolicy`	`getDesyncPolicy()`
`boolean`	`getIsReadOnly()`
`String`	`getName()` Gets the value of 'name'.
`com.neeve.xbuf.XbufStringField`	`getNameField()`
`static int`	`getNameFieldId()`
`<T extends XString> T`	`getNameTo(XString.Factory<T> factory)` Copies the value of this String field into a new XString from the given factory.
`void`	`getNameTo(XString val)` Copies the value of 'name' into the provided XString.
`XString`	`getNameUnsafe()` Gets the raw value of 'name'.
`int`	`getOwnerCount()`
`UtlPool<SrvMonAppClientInfo>`	`getPool()` Get a pool item's pool.
`int`	`getSerializeToNativeLength()`
`void`	`getValidationErrors(List<XString> results, String errorPrefix)` Collects validation errors into the provided list.
`short`	`getXRogType()`
`com.neeve.xbuf.XbufVariableShortField`	`getXRogTypeField()`
`static int`	`getXRogTypeFieldId()`
`boolean`	`hasName()` Checks for the presence of 'name'.
`boolean`	`hasXRogType()`
`SrvMonAppClientInfo`	`init()` Initialize an item.
`boolean`	`isBufferBacked()`
`boolean`	`isDirty()`
`boolean`	`isReferenceCounted()`
`boolean`	`isValid()` Tests if this object has any validation errors.
`void`	`lendName(XString val)` Lends the value of 'name' to this object.
`static void`	`optimizeFor(int val)`
`byte[]`	`serializeToByteArray()`
`ByteBuffer`	`serializeToByteBuffer()`
`com.neeve.io.IOBuffer`	`serializeToIOBuffer(boolean useNative)`
`int`	`serializeToNative(long address, int addressOffset)`
`void`	`setAsReadOnly()`
`static void`	`setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)`
`static void`	`setFieldInterest(List<Integer> fieldIds)`
`void`	`setName(String val)` Sets the value of 'name'.
`void`	`setNameFrom(long val)` Sets the value of this String field to the given numeric value.
`void`	`setNameFrom(com.neeve.xbuf.XbufStringField val)`
`void`	`setNameFrom(XString val)` Copies the provided XString value into this object's 'name'.
`SrvMonAppClientInfo`	`setPool(UtlPool<SrvMonAppClientInfo> pool)` Set a pool item's pool.
`void`	`setPreserializedFields(PktBuffer buffer)`
`void`	`setXRogType(short val)`
`void`	`setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)`
`void`	`sync()`
`void`	`syncFieldBitmask()`
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - EMPTY_ARRAY
```
public static final SrvMonAppClientInfo[] EMPTY_ARRAY
```
    A preallocated empty array used to avoid garbage when returning empty arrays of this type.
- Constructor Detail
  - SrvMonAppClientInfo
```
public SrvMonAppClientInfo()
```
  - SrvMonAppClientInfo
```
public SrvMonAppClientInfo(int initialBackingBufferSize)
```
- Method Detail
  - create
```
public static SrvMonAppClientInfo create()
```
  - createFromSerializedXbufContainer
```
public static SrvMonAppClientInfo createFromSerializedXbufContainer(byte[] serializedContainer,
                                                    com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
```
  - createFromSerializedXbufContainer
```
public static SrvMonAppClientInfo createFromSerializedXbufContainer(byte[] serializedContainer)
```
  - createFrom
```
public static SrvMonAppClientInfo createFrom(byte[] serializedContainer,
                             com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
```
  - createFrom
```
public static SrvMonAppClientInfo 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)
```
  - setAsReadOnly
```
public final void setAsReadOnly()
```
  - getIsReadOnly
```
public final boolean getIsReadOnly()
```
  - setPreserializedFields
```
public final void setPreserializedFields(PktBuffer buffer)
```
  - getXRogTypeFieldId
```
public static final int getXRogTypeFieldId()
```
  - 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()
```
  - getNameFieldId
```
public static final int getNameFieldId()
```
  - setName
```
public final void setName(String val)
```
    Description copied from interface: ISrvMonAppClientInfo
    
    Sets the value of 'name'.
    Field Description
    The connected client name.
    
    Specified by:
    
    setName in interface ISrvMonAppClientInfo
    
    Parameters:
    val - The value to set.
  - getName
```
public final String getName()
```
    Description copied from interface: ISrvMonAppClientInfo
    
    Gets the value of 'name'.
    Field Description
    The connected client name.
    
    Specified by:
    
    getName in interface ISrvMonAppClientInfo
    
    Returns:
    The connected client name.
  - lendName
```
public final void lendName(XString val)
```
    Description copied from interface: ISrvMonAppClientInfo
    
    Lends the value of 'name' to this object.
    This method is equivalent to setName 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 connected client name.
    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:
    
    lendName in interface ISrvMonAppClientInfo
    
    Parameters:
    val - The value to set.
  - setNameFrom
```
public final void setNameFrom(long val)
```
    Description copied from interface: ISrvMonAppClientInfo
    
    Sets the value of this String field to the given numeric value.
    Field Description
    The connected client name.
    NOTE:
    This is the same as calling ISrvMonAppClientInfo.setName(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.
    
    Specified by:
    
    setNameFrom in interface ISrvMonAppClientInfo
  - getNameTo
```
public final <T extends XString> T getNameTo(XString.Factory<T> factory)
```
    Description copied from interface: ISrvMonAppClientInfo
    
    Copies the value of this String field into a new XString from the given factory.
    Field Description
    The connected client name.
    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:
    
    getNameTo in interface ISrvMonAppClientInfo
    
    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.
  - setNameFrom
```
public final void setNameFrom(XString val)
```
    Description copied from interface: ISrvMonAppClientInfo
    
    Copies the provided XString value into this object's 'name'.
    Field Description
    The connected client name.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than ISrvMonAppClientInfo.setName(String) because it avoids encoding the value into a String if the given XString is already encoded.
    
    Specified by:
    
    setNameFrom in interface ISrvMonAppClientInfo
  - getNameTo
```
public final void getNameTo(XString val)
```
    Description copied from interface: ISrvMonAppClientInfo
    
    Copies the value of 'name' into the provided XString.
    Field Description
    The connected client name.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than ISrvMonAppClientInfo.getName() bec because it can avoid decoding the value into an String.
    
    Specified by:
    
    getNameTo in interface ISrvMonAppClientInfo
    
    See Also:
    ISrvMonAppClientInfo.getName()
  - getNameUnsafe
```
public final XString getNameUnsafe()
```
    Description copied from interface: ISrvMonAppClientInfo
    
    Gets the raw value of 'name'.
    Field Description
    The connected client name.
    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:
    
    getNameUnsafe in interface ISrvMonAppClientInfo
    
    Returns:
    the field's raw value
    See Also:
    ISrvMonAppClientInfo.getName()
  - setNameFrom
```
public final void setNameFrom(com.neeve.xbuf.XbufStringField val)
```
  - getNameField
```
public final com.neeve.xbuf.XbufStringField getNameField()
```
  - hasName
```
public final boolean hasName()
```
    Description copied from interface: ISrvMonAppClientInfo
    
    Checks for the presence of 'name'.
    Field Description
    The connected client name.
    
    Specified by:
    
    hasName in interface ISrvMonAppClientInfo
    
    See Also:
    ISrvMonAppClientInfo.getName()
  - clearName
```
public final void clearName()
```
    Description copied from interface: ISrvMonAppClientInfo
    
    Clears the value of 'name'.
    Field Description
    The connected client name.
    
    Specified by:
    
    clearName in interface ISrvMonAppClientInfo
    
    See Also:
    ISrvMonAppClientInfo.setName(String)
  - isDirty
```
public final boolean isDirty()
```
  - createSchema
```
public static final com.neeve.xbuf.XbufSchema createSchema()
```
  - serializeToByteArray
```
public final byte[] serializeToByteArray()
```
  - serializeToByteBuffer
```
public final ByteBuffer serializeToByteBuffer()
```
  - serializeToIOBuffer
```
public final com.neeve.io.IOBuffer serializeToIOBuffer(boolean useNative)
```
  - isBufferBacked
```
public final boolean isBufferBacked()
```
  - getSerializeToNativeLength
```
public final int getSerializeToNativeLength()
```
  - serializeToNative
```
public final int serializeToNative(long address,
                    int addressOffset)
```
  - deserializeFromIOElasticBuffer
```
public final SrvMonAppClientInfo deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
                                                 int offset,
                                                 int length,
                                                 com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
```
  - deserializeFromIOElasticBuffer
```
public final SrvMonAppClientInfo deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
                                                 int offset,
                                                 int length)
```
  - deserializeFromByteArray
```
public final SrvMonAppClientInfo deserializeFromByteArray(byte[] array,
                                           com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
```
  - deserializeFromByteArray
```
public final SrvMonAppClientInfo deserializeFromByteArray(byte[] array)
```
  - deserializeFromByteBuffer
```
public final SrvMonAppClientInfo deserializeFromByteBuffer(ByteBuffer buffer,
                                            com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
```
  - deserializeFromByteBuffer
```
public final SrvMonAppClientInfo deserializeFromByteBuffer(ByteBuffer buffer)
```
  - deserializeFromNative
```
public final SrvMonAppClientInfo deserializeFromNative(long address,
                                        int offset,
                                        int length,
                                        com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
```
  - deserializeFromNative
```
public final SrvMonAppClientInfo deserializeFromNative(long address,
                                        int offset,
                                        int length)
```
  - sync
```
public final void sync()
```
  - desync
```
public final int desync(PktBuffer buffer,
         int pos,
         boolean frameOnly)
```
    Description copied from interface: com.neeve.xbuf.IXbufDesyncer
    
    Desync fields from a buffer
    
    Specified by:
    
    desync in interface com.neeve.xbuf.IXbufDesyncer
    
    Parameters:
    buffer - The buffer to desync from
    pos - The position in the container's backing buffer to desync from
    frameOnly - Whether to frame the field on the underlying buffer. See XbufField.desync(PktBuffer, int, boolean) for more information
  - init
```
public final SrvMonAppClientInfo init()
```
    Description copied from interface: UtlPool.Item
    
    Initialize an item.
    This method is invoked by an item pool very time an item is put into the pool. The method should wipe the contents of the item so as to present a fresh instance of the item to the caller when retrieved from the pool.
    
    Specified by:
    
    init in interface UtlPool.Item<SrvMonAppClientInfo>
    
    Returns:
    Return 'this' object for method invocation chaining.
  - setPool
```
public final SrvMonAppClientInfo setPool(UtlPool<SrvMonAppClientInfo> pool)
```
    Description copied from interface: UtlPool.Item
    
    Set a pool item's pool.
    This method is invoked by an item pool at the time an item is added to the pool. The intent is to record the item's source pool in the item so it can be disposed back into the pool when the user is done working with it.
    
    Specified by:
    
    setPool in interface UtlPool.Item<SrvMonAppClientInfo>
    
    Returns:
    Return 'this' object for method invocation chaining.
  - getPool
```
public final UtlPool<SrvMonAppClientInfo> getPool()
```
    Description copied from interface: UtlPool.Item
    
    Get a pool item's pool.
    This method should return the pool set using UtlPool.Item.setPool(com.neeve.util.UtlPool<T>)
    
    Specified by:
    
    getPool in interface UtlPool.Item<SrvMonAppClientInfo>
    
    Returns:
    the pool set using UtlPool.Item.setPool(com.neeve.util.UtlPool<T>)
  - isReferenceCounted
```
public final boolean isReferenceCounted()
```
  - acquire
```
public final SrvMonAppClientInfo acquire()
```
  - getOwnerCount
```
public final int getOwnerCount()
```
  - dispose
```
public final void dispose()
```
  - clone
```
public final Object clone()
```
    Creates a clone of this object.
    This method differs from the copy() method in that:
    - For protobuf and xbuf generated objects pass-through fields are not preserved. Pass through fields are fields not defined by ADM model that generated this class, but may exist in the backing buffer or protobuf message for the object.
    - The copy method may replace empty arrays with a null value whereas this method preserves empty array fields.
    Overrides:
    
    clone in class Object
  - copy
```
public final SrvMonAppClientInfo copy()
```
    Creates a copy of this SrvMonAppClientInfo.
    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 SrvMonAppClientInfo's embedded entity fields.
    The returned copy will be writeable even if this SrvMonAppClientInfo is read only.
    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.
    
    Returns:
    The copied entity.
  - copyInto
```
public final void copyInto(SrvMonAppClientInfo copy)
```
    Copies the contents of this SrvMonAppClientInfo 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 SrvMonAppClientInfo's embedded entity fields.
    The returned copy will be writeable even if this SrvMonAppClientInfo is read only.
    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.
    
    Parameters:
    copy - The target into which to copy.
  - isValid
```
public final boolean isValid()
```
    Description copied from interface: IRogValidatable
    
    Tests if this object has any validation errors.
    
    Specified by:
    
    isValid in interface IRogValidatable
  - getValidationErrors
```
public final void getValidationErrors(List<XString> results,
                       String errorPrefix)
```
    Description copied from interface: IRogValidatable
    
    Collects validation errors into the provided list. It is illegal for the caller to hold onto the List of XStrings beyond the lifespace of this object.
    
    Specified by:
    
    getValidationErrors in interface IRogValidatable
    
    Parameters:
    results - A results list into which validation errors will be collected.
    errorPrefix - The bean path prefix to use when identifying invalid fields or null if validating a top level entity.
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object

Class SrvMonAppClientInfo

ADM Details

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_ARRAY

Constructor Detail

SrvMonAppClientInfo

SrvMonAppClientInfo

Method Detail

create

createFromSerializedXbufContainer

createFromSerializedXbufContainer

createFrom

createFrom

setDesyncPolicy

getDesyncPolicy

setFieldInterest

clearContent

syncFieldBitmask

desyncFieldBitmask

getBackingBuffer

optimizeFor

setAsReadOnly

getIsReadOnly

setPreserializedFields

getXRogTypeFieldId

setXRogType

getXRogType

setXRogTypeFrom

getXRogTypeField

hasXRogType

clearXRogType

getNameFieldId

setName

Field Description

getName

Field Description

lendName

Field Description

Usage Notes

setNameFrom

Field Description

getNameTo

Field Description

setNameFrom

Field Description

getNameTo

Field Description

getNameUnsafe

Field Description

setNameFrom

getNameField

hasName

Field Description

clearName

Field Description

isDirty

createSchema

serializeToByteArray

serializeToByteBuffer

serializeToIOBuffer

isBufferBacked

getSerializeToNativeLength

serializeToNative

deserializeFromIOElasticBuffer

deserializeFromIOElasticBuffer

deserializeFromByteArray

deserializeFromByteArray

deserializeFromByteBuffer

deserializeFromByteBuffer

deserializeFromNative

deserializeFromNative

sync

desync

init

setPool