|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.neeve.server.mon.SrvMonDisruptorStats
@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=201) public final class SrvMonDisruptorStats
Holds stats for a disruptor.
Nested Class Summary | |
---|---|
static class |
SrvMonDisruptorStats.Field
The SrvMonDisruptorStats xbuf field (used internally when this entity is used as a field of another entity). |
static class |
SrvMonDisruptorStats.ListField
The SrvMonDisruptorStats list field (used internally when this entity is used as an array field of another entity). |
Field Summary | |
---|---|
static SrvMonDisruptorStats[] |
EMPTY_ARRAY
A preallocated empty array used to avoid garbage when returning empty arrays of this type. |
Constructor Summary | |
---|---|
SrvMonDisruptorStats()
|
|
SrvMonDisruptorStats(int initialBackingBufferSize)
|
Method Summary | |
---|---|
SrvMonDisruptorStats |
acquire()
|
void |
clearCapacity()
Clears the value of 'capacity' Field Description The size of the diruptor's ringbuffer |
void |
clearClaimStrategy()
Clears the value of 'claimStrategy' Field Description The claim strategy used by threads inputing events to the disruptor |
void |
clearContent()
|
void |
clearOfferToPollLatencies()
Clears the value of 'offerToPollLatencies' Field Description Measures latency of events passing in the disruptor |
void |
clearRemaining()
Clears the value of 'remaining' Field Description The number of free ringbuffer slots |
void |
clearWaitStrategy()
Clears the value of 'waitStrategy' Field Description The claim strategy used by thread processing events in the disruptor |
void |
clearXRogType()
|
Object |
clone()
Creates a clone of this object. |
SrvMonDisruptorStats |
copy()
Creates a copy of this SrvMonDisruptorStats. |
void |
copyInto(SrvMonDisruptorStats copy)
Copies the contents of this SrvMonDisruptorStats into the target. |
static SrvMonDisruptorStats |
create()
|
static SrvMonDisruptorStats |
createFrom(byte[] serializedContainer)
|
static SrvMonDisruptorStats |
createFrom(byte[] serializedContainer,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
|
static SrvMonDisruptorStats |
createFromSerializedXbufContainer(byte[] serializedContainer)
|
static SrvMonDisruptorStats |
createFromSerializedXbufContainer(byte[] serializedContainer,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
|
static com.neeve.xbuf.XbufSchema |
createSchema()
|
SrvMonDisruptorStats |
deserializeFromByteArray(byte[] array)
|
SrvMonDisruptorStats |
deserializeFromByteArray(byte[] array,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
|
SrvMonDisruptorStats |
deserializeFromByteBuffer(ByteBuffer buffer)
|
SrvMonDisruptorStats |
deserializeFromByteBuffer(ByteBuffer buffer,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
|
SrvMonDisruptorStats |
deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
int offset,
int length)
|
SrvMonDisruptorStats |
deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
int offset,
int length,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
|
SrvMonDisruptorStats |
deserializeFromNative(long address,
int offset,
int length)
|
SrvMonDisruptorStats |
deserializeFromNative(long address,
int offset,
int length,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
|
int |
desync(PktBuffer buffer,
int pos,
boolean frameOnly)
|
void |
desyncFieldBitmask()
|
void |
dispose()
|
PktBuffer |
getBackingBuffer()
|
int |
getCapacity()
Gets the value of 'capacity' Field Description The size of the diruptor's ringbuffer |
com.neeve.xbuf.XbufVariableIntField |
getCapacityField()
|
static int |
getCapacityFieldId()
Get the field id for 'capacity' This method can be used to set field interests. |
SrvMonDisruptorClaimStrategy |
getClaimStrategy()
Gets the value of 'claimStrategy' Field Description The claim strategy used by threads inputing events to the disruptor |
com.neeve.xbuf.XbufVariableEnumField<SrvMonDisruptorClaimStrategy> |
getClaimStrategyField()
|
static int |
getClaimStrategyFieldId()
Get the field id for 'claimStrategy' This method can be used to set field interests. |
static com.neeve.xbuf.XbufDesyncPolicy |
getDesyncPolicy()
|
boolean |
getIsReadOnly()
|
SrvMonIntSeries |
getOfferToPollLatencies()
Gets the value of 'offerToPollLatencies' Field Description Measures latency of events passing in the disruptor |
static int |
getOfferToPollLatenciesFieldId()
Get the field id for 'offerToPollLatencies' This method can be used to set field interests. |
void |
getOfferToPollLatenciesTo(SrvMonIntSeries to)
Copies the value of SrvMonIntSeries into the provided value. |
int |
getOwnerCount()
|
UtlPool<SrvMonDisruptorStats> |
getPool()
Get a pool item's pool. |
int |
getRemaining()
Gets the value of 'remaining' Field Description The number of free ringbuffer slots |
com.neeve.xbuf.XbufVariableIntField |
getRemainingField()
|
static int |
getRemainingFieldId()
Get the field id for 'remaining' This method can be used to set field interests. |
int |
getSerializeToNativeLength()
|
void |
getValidationErrors(List<XString> results,
String errorPrefix)
Collects validation errors into the provided list. |
SrvMonDisruptorWaitStrategy |
getWaitStrategy()
Gets the value of 'waitStrategy' Field Description The claim strategy used by thread processing events in the disruptor |
com.neeve.xbuf.XbufVariableEnumField<SrvMonDisruptorWaitStrategy> |
getWaitStrategyField()
|
static int |
getWaitStrategyFieldId()
Get the field id for 'waitStrategy' This method can be used to set field interests. |
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 |
hasCapacity()
Checks for the presence of 'capacity' Field Description The size of the diruptor's ringbuffer |
boolean |
hasClaimStrategy()
Checks for the presence of 'claimStrategy' Field Description The claim strategy used by threads inputing events to the disruptor |
boolean |
hasOfferToPollLatencies()
Checks for the presence of 'offerToPollLatencies' Field Description Measures latency of events passing in the disruptor |
boolean |
hasRemaining()
Checks for the presence of 'remaining' Field Description The number of free ringbuffer slots |
boolean |
hasWaitStrategy()
Checks for the presence of 'waitStrategy' Field Description The claim strategy used by thread processing events in the disruptor |
boolean |
hasXRogType()
|
SrvMonDisruptorStats |
init()
Initialize an item. |
boolean |
isBufferBacked()
|
boolean |
isDirty()
|
boolean |
isReferenceCounted()
|
boolean |
isValid()
Tests if this object has any validation errors. |
void |
lendOfferToPollLatencies(SrvMonIntSeries val)
'Lends' a reference of the SrvMonIntSeries to the message for this field. |
static void |
optimizeFor(int val)
|
byte[] |
serializeToByteArray()
|
ByteBuffer |
serializeToByteBuffer()
|
com.neeve.io.IOBuffer |
serializeToIOBuffer(boolean useNative)
|
int |
serializeToNative(long address,
int addressOffset)
|
void |
setAsReadOnly()
|
void |
setCapacity(int val)
Sets the value of 'capacity' Field Description The size of the diruptor's ringbuffer |
void |
setCapacityFrom(com.neeve.xbuf.XbufVariableIntField val)
|
void |
setClaimStrategy(SrvMonDisruptorClaimStrategy val)
Sets the value of 'claimStrategy' Field Description The claim strategy used by threads inputing events to the disruptor |
void |
setClaimStrategyFrom(com.neeve.xbuf.XbufVariableEnumField<SrvMonDisruptorClaimStrategy> val)
|
static void |
setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
|
static void |
setFieldInterest(List<Integer> fieldIds)
|
void |
setOfferToPollLatencies(SrvMonIntSeries val)
Sets the value of 'offerToPollLatencies' Field Description Measures latency of events passing in the disruptor |
SrvMonDisruptorStats |
setPool(UtlPool<SrvMonDisruptorStats> pool)
Set a pool item's pool. |
void |
setRemaining(int val)
Sets the value of 'remaining' Field Description The number of free ringbuffer slots |
void |
setRemainingFrom(com.neeve.xbuf.XbufVariableIntField val)
|
void |
setWaitStrategy(SrvMonDisruptorWaitStrategy val)
Sets the value of 'waitStrategy' Field Description The claim strategy used by thread processing events in the disruptor |
void |
setWaitStrategyFrom(com.neeve.xbuf.XbufVariableEnumField<SrvMonDisruptorWaitStrategy> val)
|
void |
setXRogType(short val)
|
void |
setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)
|
void |
sync()
|
void |
syncFieldBitmask()
|
SrvMonIntSeries |
takeOfferToPollLatencies()
'Takes' a reference to the offerToPollLatencies field from the message. |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final SrvMonDisruptorStats[] EMPTY_ARRAY
Constructor Detail |
---|
public SrvMonDisruptorStats()
public SrvMonDisruptorStats(int initialBackingBufferSize)
Method Detail |
---|
public static SrvMonDisruptorStats create()
public static SrvMonDisruptorStats createFromSerializedXbufContainer(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public static SrvMonDisruptorStats createFromSerializedXbufContainer(byte[] serializedContainer)
public static SrvMonDisruptorStats createFrom(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public static SrvMonDisruptorStats createFrom(byte[] serializedContainer)
public static final void setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
public static final com.neeve.xbuf.XbufDesyncPolicy getDesyncPolicy()
public static final void setFieldInterest(List<Integer> fieldIds)
public final void clearContent()
public final void syncFieldBitmask()
public final void desyncFieldBitmask()
public final PktBuffer getBackingBuffer()
public static final void optimizeFor(int val)
public final void setAsReadOnly()
public final boolean getIsReadOnly()
public static final int getXRogTypeFieldId()
This method can be used to set field interests.
getXRogType()
public final void setXRogType(short val)
public final short getXRogType()
public final void setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)
public final com.neeve.xbuf.XbufVariableShortField getXRogTypeField()
public final boolean hasXRogType()
public final void clearXRogType()
public static final int getCapacityFieldId()
This method can be used to set field interests.
getCapacity()
public final void setCapacity(int val)
ISrvMonDisruptorStats
setCapacity
in interface ISrvMonDisruptorStats
val
- The value to set.public final int getCapacity()
ISrvMonDisruptorStats
getCapacity
in interface ISrvMonDisruptorStats
public final void setCapacityFrom(com.neeve.xbuf.XbufVariableIntField val)
public final com.neeve.xbuf.XbufVariableIntField getCapacityField()
public final boolean hasCapacity()
ISrvMonDisruptorStats
hasCapacity
in interface ISrvMonDisruptorStats
ISrvMonDisruptorStats.getCapacity()
public final void clearCapacity()
ISrvMonDisruptorStats
clearCapacity
in interface ISrvMonDisruptorStats
ISrvMonDisruptorStats.setCapacity(int)
public static final int getRemainingFieldId()
This method can be used to set field interests.
getRemaining()
public final void setRemaining(int val)
ISrvMonDisruptorStats
setRemaining
in interface ISrvMonDisruptorStats
val
- The value to set.public final int getRemaining()
ISrvMonDisruptorStats
getRemaining
in interface ISrvMonDisruptorStats
public final void setRemainingFrom(com.neeve.xbuf.XbufVariableIntField val)
public final com.neeve.xbuf.XbufVariableIntField getRemainingField()
public final boolean hasRemaining()
ISrvMonDisruptorStats
hasRemaining
in interface ISrvMonDisruptorStats
ISrvMonDisruptorStats.getRemaining()
public final void clearRemaining()
ISrvMonDisruptorStats
clearRemaining
in interface ISrvMonDisruptorStats
ISrvMonDisruptorStats.setRemaining(int)
public static final int getClaimStrategyFieldId()
This method can be used to set field interests.
getClaimStrategy()
public final void setClaimStrategy(SrvMonDisruptorClaimStrategy val)
ISrvMonDisruptorStats
setClaimStrategy
in interface ISrvMonDisruptorStats
val
- The value to set.public final void setClaimStrategyFrom(com.neeve.xbuf.XbufVariableEnumField<SrvMonDisruptorClaimStrategy> val)
public final com.neeve.xbuf.XbufVariableEnumField<SrvMonDisruptorClaimStrategy> getClaimStrategyField()
public final SrvMonDisruptorClaimStrategy getClaimStrategy()
ISrvMonDisruptorStats
getClaimStrategy
in interface ISrvMonDisruptorStats
public final boolean hasClaimStrategy()
ISrvMonDisruptorStats
hasClaimStrategy
in interface ISrvMonDisruptorStats
ISrvMonDisruptorStats.getClaimStrategy()
public final void clearClaimStrategy()
ISrvMonDisruptorStats
clearClaimStrategy
in interface ISrvMonDisruptorStats
ISrvMonDisruptorStats.setClaimStrategy(SrvMonDisruptorClaimStrategy)
public static final int getWaitStrategyFieldId()
This method can be used to set field interests.
getWaitStrategy()
public final void setWaitStrategy(SrvMonDisruptorWaitStrategy val)
ISrvMonDisruptorStats
setWaitStrategy
in interface ISrvMonDisruptorStats
val
- The value to set.public final void setWaitStrategyFrom(com.neeve.xbuf.XbufVariableEnumField<SrvMonDisruptorWaitStrategy> val)
public final com.neeve.xbuf.XbufVariableEnumField<SrvMonDisruptorWaitStrategy> getWaitStrategyField()
public final SrvMonDisruptorWaitStrategy getWaitStrategy()
ISrvMonDisruptorStats
getWaitStrategy
in interface ISrvMonDisruptorStats
public final boolean hasWaitStrategy()
ISrvMonDisruptorStats
hasWaitStrategy
in interface ISrvMonDisruptorStats
ISrvMonDisruptorStats.getWaitStrategy()
public final void clearWaitStrategy()
ISrvMonDisruptorStats
clearWaitStrategy
in interface ISrvMonDisruptorStats
ISrvMonDisruptorStats.setWaitStrategy(SrvMonDisruptorWaitStrategy)
public static final int getOfferToPollLatenciesFieldId()
This method can be used to set field interests.
getOfferToPollLatencies()
public final void setOfferToPollLatencies(SrvMonIntSeries val)
ISrvMonDisruptorStats
setOfferToPollLatencies
in interface ISrvMonDisruptorStats
val
- The value to set.public final void lendOfferToPollLatencies(SrvMonIntSeries val)
ISrvMonDisruptorStats
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.
lendOfferToPollLatencies
in interface ISrvMonDisruptorStats
val
- the value to 'lend' to lend.public final SrvMonIntSeries getOfferToPollLatencies()
ISrvMonDisruptorStats
getOfferToPollLatencies
in interface ISrvMonDisruptorStats
public final void getOfferToPollLatenciesTo(SrvMonIntSeries to)
ISrvMonDisruptorStats
IF the value is not set, then the contents of the provided SrvMonIntSeries are cleared.
getOfferToPollLatenciesTo
in interface ISrvMonDisruptorStats
to
- the value to copy intoSrvMonIntSeries.copyInto(SrvMonIntSeries)
public final SrvMonIntSeries takeOfferToPollLatencies()
ISrvMonDisruptorStats
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.
takeOfferToPollLatencies
in interface ISrvMonDisruptorStats
null
if the field is not set.public final boolean hasOfferToPollLatencies()
ISrvMonDisruptorStats
hasOfferToPollLatencies
in interface ISrvMonDisruptorStats
ISrvMonDisruptorStats.getOfferToPollLatencies()
public final void clearOfferToPollLatencies()
ISrvMonDisruptorStats
clearOfferToPollLatencies
in interface ISrvMonDisruptorStats
ISrvMonDisruptorStats.setOfferToPollLatencies(SrvMonIntSeries)
public final boolean isDirty()
public static final com.neeve.xbuf.XbufSchema createSchema()
public final byte[] serializeToByteArray()
public final ByteBuffer serializeToByteBuffer()
public final com.neeve.io.IOBuffer serializeToIOBuffer(boolean useNative)
public final boolean isBufferBacked()
public final int getSerializeToNativeLength()
public final int serializeToNative(long address, int addressOffset)
public final SrvMonDisruptorStats deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public final SrvMonDisruptorStats deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length)
public final SrvMonDisruptorStats deserializeFromByteArray(byte[] array, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public final SrvMonDisruptorStats deserializeFromByteArray(byte[] array)
public final SrvMonDisruptorStats deserializeFromByteBuffer(ByteBuffer buffer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public final SrvMonDisruptorStats deserializeFromByteBuffer(ByteBuffer buffer)
public final SrvMonDisruptorStats deserializeFromNative(long address, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public final SrvMonDisruptorStats deserializeFromNative(long address, int offset, int length)
public final void sync()
public final int desync(PktBuffer buffer, int pos, boolean frameOnly)
desync
in interface com.neeve.xbuf.IXbufDesyncer
public final SrvMonDisruptorStats init()
UtlPool.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.
init
in interface UtlPool.Item<SrvMonDisruptorStats>
public final SrvMonDisruptorStats setPool(UtlPool<SrvMonDisruptorStats> pool)
UtlPool.Item
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.
setPool
in interface UtlPool.Item<SrvMonDisruptorStats>
public final UtlPool<SrvMonDisruptorStats> getPool()
UtlPool.Item
This method should return the pool set using UtlPool.Item.setPool(com.neeve.util.UtlPool
getPool
in interface UtlPool.Item<SrvMonDisruptorStats>
UtlPool.Item.setPool(com.neeve.util.UtlPool)
public final boolean isReferenceCounted()
public final SrvMonDisruptorStats acquire()
public final int getOwnerCount()
public final void dispose()
public final Object clone()
This method differs from the copy()
method in that:
clone
in class Object
public final SrvMonDisruptorStats copy()
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 SrvMonDisruptorStats's embedded entity fields.
The returned copy will be writeable even if this SrvMonDisruptorStats is read only.
public final void copyInto(SrvMonDisruptorStats copy)
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 SrvMonDisruptorStats's embedded entity fields.
The returned copy will be writeable even if this SrvMonDisruptorStats is read only.
copy
- The target into which to copy.public final boolean isValid()
IRogValidatable
isValid
in interface IRogValidatable
public final void getValidationErrors(List<XString> results, String errorPrefix)
IRogValidatable
getValidationErrors
in interface IRogValidatable
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.public final String toString()
toString
in class Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |