@Generated(value="com.neeve.adm.AdmXbufGenerator", date="Fri Dec 05 13:32:50 UTC 2025") @AdmGenerated(encoding="Xbuf", compatLevel="4.1.0", admVersion="Unknown Version", date="12/5/25 1:32 PM", buildInfo="nvx-talon-3.16.63 (nvx-codegen-plugin)") @AdmFactoryInfo(factoryClass=SrvMonFactory.class, vfid=32, ofid=32, typeId=226) public final class SrvMonMsgTypeStats extends Object implements com.neeve.xbuf.IXbufDesyncer, UtlPool.Item<SrvMonMsgTypeStats>, ISrvMonMsgTypeStats
| ADM Type | Embedded Entity |
| Factory | SrvMonFactory |
| ADM Field Summary |
|---|
| Field | Type | Id | Description |
|---|---|---|---|
| messageFactoryId | Short | 116 | The factory id for the message type (unique within the application). |
| messageTypeId | Short | 117 | The message type id within its factory (unique within the type's factory). |
| messageTypeName | String | 115 | The fully qualified name of the message type. |
| msgCreateToOfferLatencies | SrvMonIntSeries |
63 |
Records latencies the message create to offer time (aka 'c2o') in microseconds.
This statistic records the time from when a message was created to when it was queued for processing by the engine. The creation timestamp is dependent on the source of the messsage:
|
| msgFilteringLatencies | SrvMonIntSeries |
61 | Records latencies for application message filtering times (by a message filter) (aka 'mfilt') in microseconds. |
| msgOfferToPollLatencies | SrvMonIntSeries |
64 |
Records latencies the message offer to poll time (aka 'c2o') in microseconds, the time an application spends in the engine's input queue.
Offer to poll latencies capture the time from which a message was offered to the AepEngine to the time that it is picked up by the engine for processing -- in other words the queue time (if any for the message). Note that the poll timestamp is the timestamp just after the engine's thread picks up the message, it does not include engine pre processing time, or message filtering time prior to the message being dispatch to an application handler. This time will included any scheduling delay specified for the message when it is offered to engine. |
| msgPreProcessingLatencies | SrvMonIntSeries |
62 |
The message pre processing latencies (aka 'mproc') in microseconds.
Message pre processing latencies record the time spent by the engine after it takes a message f rom its input queue to the time at which it begins dispatching it to handlers - in other words any bookkeeping overhead done by the engine done to prepare the message from dispatch. A high value in this statistic could indicate:
|
| msgProcessingLatencies | SrvMonIntSeries |
43 | Records latencies for application message process times (in an EventHandler) (aka 'mproc'). |
| numDupMsgsRcvd | Long | 19 | The number of duplicate messages the application has received. |
| numMsgsFiltered | Long | 60 | The number of messages that were filtered. |
| numMsgsRcvdBestEffort | Long | 17 | The number of best effort messages the application has received. |
| numMsgsRcvdGuaranteed | Long | 18 | The number of guaranteed messages the application has received. |
| numMsgsResent | Long | 22 | The number of messages the application has retransmitted. |
| numMsgsSentBestEffort | Long | 20 | The number of best effort messages sent by the application. |
| numMsgsSentGuaranteed | Long | 21 | The number of guaranteed messages sent by the application. |
| numMsgsSourced | Long | 59 |
The number of messages that were sourced.
Sourced messages apply only to messages not received directly from a message bus. They include: messages replicated to the backup, initialized from the event log at the primary, initialized from the primary at the backup, and messages injected by the application. The total number of messages received by the engine can be computed by adding numMsgsRcvdBestEffort + numMsgsRcvdGuaranteed + numMsgsSourced. |
| Modifier and Type | Class and Description |
|---|---|
static class |
SrvMonMsgTypeStats.Field
The SrvMonMsgTypeStats xbuf field (used internally when this entity is used as a field of another entity).
|
static class |
SrvMonMsgTypeStats.ListField
The SrvMonMsgTypeStats list field (used internally when this entity is used as an array field of another entity).
|
| Modifier and Type | Field and Description |
|---|---|
static SrvMonMsgTypeStats[] |
EMPTY_ARRAY
A preallocated empty array used to avoid garbage when returning empty arrays of this type.
|
| Constructor and Description |
|---|
SrvMonMsgTypeStats() |
SrvMonMsgTypeStats(int initialBackingBufferSize) |
| Modifier and Type | Method and Description |
|---|---|
SrvMonMsgTypeStats |
acquire() |
void |
clearContent() |
void |
clearMessageFactoryId()
Clears the value of 'messageFactoryId'.
|
void |
clearMessageTypeId()
Clears the value of 'messageTypeId'.
|
void |
clearMessageTypeName()
Clears the value of 'messageTypeName'.
|
void |
clearMsgCreateToOfferLatencies()
Clears the value of 'msgCreateToOfferLatencies'.
|
void |
clearMsgFilteringLatencies()
Clears the value of 'msgFilteringLatencies'.
|
void |
clearMsgOfferToPollLatencies()
Clears the value of 'msgOfferToPollLatencies'.
|
void |
clearMsgPreProcessingLatencies()
Clears the value of 'msgPreProcessingLatencies'.
|
void |
clearMsgProcessingLatencies()
Clears the value of 'msgProcessingLatencies'.
|
void |
clearNumDupMsgsRcvd()
Clears the value of 'numDupMsgsRcvd'.
|
void |
clearNumMsgsFiltered()
Clears the value of 'numMsgsFiltered'.
|
void |
clearNumMsgsRcvdBestEffort()
Clears the value of 'numMsgsRcvdBestEffort'.
|
void |
clearNumMsgsRcvdGuaranteed()
Clears the value of 'numMsgsRcvdGuaranteed'.
|
void |
clearNumMsgsResent()
Clears the value of 'numMsgsResent'.
|
void |
clearNumMsgsSentBestEffort()
Clears the value of 'numMsgsSentBestEffort'.
|
void |
clearNumMsgsSentGuaranteed()
Clears the value of 'numMsgsSentGuaranteed'.
|
void |
clearNumMsgsSourced()
Clears the value of 'numMsgsSourced'.
|
void |
clearXRogType() |
Object |
clone()
Creates a clone of this object.
|
SrvMonMsgTypeStats |
copy()
Creates a copy of this SrvMonMsgTypeStats.
|
void |
copyInto(SrvMonMsgTypeStats copy)
Copies the contents of this SrvMonMsgTypeStats into the target.
|
static SrvMonMsgTypeStats |
create() |
static SrvMonMsgTypeStats |
createFrom(byte[] serializedContainer) |
static SrvMonMsgTypeStats |
createFrom(byte[] serializedContainer,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy) |
static SrvMonMsgTypeStats |
createFromSerializedXbufContainer(byte[] serializedContainer) |
static SrvMonMsgTypeStats |
createFromSerializedXbufContainer(byte[] serializedContainer,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy) |
static com.neeve.xbuf.XbufSchema |
createSchema() |
SrvMonMsgTypeStats |
deserializeFromByteArray(byte[] array) |
SrvMonMsgTypeStats |
deserializeFromByteArray(byte[] array,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy) |
SrvMonMsgTypeStats |
deserializeFromByteBuffer(ByteBuffer buffer) |
SrvMonMsgTypeStats |
deserializeFromByteBuffer(ByteBuffer buffer,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy) |
SrvMonMsgTypeStats |
deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
int offset,
int length) |
SrvMonMsgTypeStats |
deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
int offset,
int length,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy) |
SrvMonMsgTypeStats |
deserializeFromNative(long address,
int offset,
int length) |
SrvMonMsgTypeStats |
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() |
short |
getMessageFactoryId()
Gets the value of 'messageFactoryId'.
|
Short |
getMessageFactoryIdAsObject()
Gets the value of 'messageFactoryId'.
|
com.neeve.xbuf.XbufVariableShortField |
getMessageFactoryIdField() |
static int |
getMessageFactoryIdFieldId() |
short |
getMessageTypeId()
Gets the value of 'messageTypeId'.
|
Short |
getMessageTypeIdAsObject()
Gets the value of 'messageTypeId'.
|
com.neeve.xbuf.XbufVariableShortField |
getMessageTypeIdField() |
static int |
getMessageTypeIdFieldId() |
String |
getMessageTypeName()
Gets the value of 'messageTypeName'.
|
com.neeve.xbuf.XbufStringField |
getMessageTypeNameField() |
static int |
getMessageTypeNameFieldId() |
<T extends XString> |
getMessageTypeNameTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory.
|
void |
getMessageTypeNameTo(XString val)
Copies the value of 'messageTypeName' into the provided XString.
|
XString |
getMessageTypeNameUnsafe()
Gets the raw value of 'messageTypeName'.
|
SrvMonIntSeries |
getMsgCreateToOfferLatencies()
Gets the value of 'msgCreateToOfferLatencies'.
|
static int |
getMsgCreateToOfferLatenciesFieldId() |
void |
getMsgCreateToOfferLatenciesTo(SrvMonIntSeries to)
Copies the value of SrvMonIntSeries into the provided value.
|
SrvMonIntSeries |
getMsgFilteringLatencies()
Gets the value of 'msgFilteringLatencies'.
|
static int |
getMsgFilteringLatenciesFieldId() |
void |
getMsgFilteringLatenciesTo(SrvMonIntSeries to)
Copies the value of SrvMonIntSeries into the provided value.
|
SrvMonIntSeries |
getMsgOfferToPollLatencies()
Gets the value of 'msgOfferToPollLatencies'.
|
static int |
getMsgOfferToPollLatenciesFieldId() |
void |
getMsgOfferToPollLatenciesTo(SrvMonIntSeries to)
Copies the value of SrvMonIntSeries into the provided value.
|
SrvMonIntSeries |
getMsgPreProcessingLatencies()
Gets the value of 'msgPreProcessingLatencies'.
|
static int |
getMsgPreProcessingLatenciesFieldId() |
void |
getMsgPreProcessingLatenciesTo(SrvMonIntSeries to)
Copies the value of SrvMonIntSeries into the provided value.
|
SrvMonIntSeries |
getMsgProcessingLatencies()
Gets the value of 'msgProcessingLatencies'.
|
static int |
getMsgProcessingLatenciesFieldId() |
void |
getMsgProcessingLatenciesTo(SrvMonIntSeries to)
Copies the value of SrvMonIntSeries into the provided value.
|
long |
getNumDupMsgsRcvd()
Gets the value of 'numDupMsgsRcvd'.
|
Long |
getNumDupMsgsRcvdAsObject()
Gets the value of 'numDupMsgsRcvd'.
|
com.neeve.xbuf.XbufVariableLongField |
getNumDupMsgsRcvdField() |
static int |
getNumDupMsgsRcvdFieldId() |
long |
getNumMsgsFiltered()
Gets the value of 'numMsgsFiltered'.
|
Long |
getNumMsgsFilteredAsObject()
Gets the value of 'numMsgsFiltered'.
|
com.neeve.xbuf.XbufVariableLongField |
getNumMsgsFilteredField() |
static int |
getNumMsgsFilteredFieldId() |
long |
getNumMsgsRcvdBestEffort()
Gets the value of 'numMsgsRcvdBestEffort'.
|
Long |
getNumMsgsRcvdBestEffortAsObject()
Gets the value of 'numMsgsRcvdBestEffort'.
|
com.neeve.xbuf.XbufVariableLongField |
getNumMsgsRcvdBestEffortField() |
static int |
getNumMsgsRcvdBestEffortFieldId() |
long |
getNumMsgsRcvdGuaranteed()
Gets the value of 'numMsgsRcvdGuaranteed'.
|
Long |
getNumMsgsRcvdGuaranteedAsObject()
Gets the value of 'numMsgsRcvdGuaranteed'.
|
com.neeve.xbuf.XbufVariableLongField |
getNumMsgsRcvdGuaranteedField() |
static int |
getNumMsgsRcvdGuaranteedFieldId() |
long |
getNumMsgsResent()
Gets the value of 'numMsgsResent'.
|
Long |
getNumMsgsResentAsObject()
Gets the value of 'numMsgsResent'.
|
com.neeve.xbuf.XbufVariableLongField |
getNumMsgsResentField() |
static int |
getNumMsgsResentFieldId() |
long |
getNumMsgsSentBestEffort()
Gets the value of 'numMsgsSentBestEffort'.
|
Long |
getNumMsgsSentBestEffortAsObject()
Gets the value of 'numMsgsSentBestEffort'.
|
com.neeve.xbuf.XbufVariableLongField |
getNumMsgsSentBestEffortField() |
static int |
getNumMsgsSentBestEffortFieldId() |
long |
getNumMsgsSentGuaranteed()
Gets the value of 'numMsgsSentGuaranteed'.
|
Long |
getNumMsgsSentGuaranteedAsObject()
Gets the value of 'numMsgsSentGuaranteed'.
|
com.neeve.xbuf.XbufVariableLongField |
getNumMsgsSentGuaranteedField() |
static int |
getNumMsgsSentGuaranteedFieldId() |
long |
getNumMsgsSourced()
Gets the value of 'numMsgsSourced'.
|
Long |
getNumMsgsSourcedAsObject()
Gets the value of 'numMsgsSourced'.
|
com.neeve.xbuf.XbufVariableLongField |
getNumMsgsSourcedField() |
static int |
getNumMsgsSourcedFieldId() |
int |
getOwnerCount() |
UtlPool<SrvMonMsgTypeStats> |
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() |
Short |
getXRogTypeAsObject() |
com.neeve.xbuf.XbufVariableShortField |
getXRogTypeField() |
static int |
getXRogTypeFieldId() |
boolean |
hasMessageFactoryId()
Checks for the presence of 'messageFactoryId'.
|
boolean |
hasMessageTypeId()
Checks for the presence of 'messageTypeId'.
|
boolean |
hasMessageTypeName()
Checks for the presence of 'messageTypeName'.
|
boolean |
hasMsgCreateToOfferLatencies()
Checks for the presence of 'msgCreateToOfferLatencies'.
|
boolean |
hasMsgFilteringLatencies()
Checks for the presence of 'msgFilteringLatencies'.
|
boolean |
hasMsgOfferToPollLatencies()
Checks for the presence of 'msgOfferToPollLatencies'.
|
boolean |
hasMsgPreProcessingLatencies()
Checks for the presence of 'msgPreProcessingLatencies'.
|
boolean |
hasMsgProcessingLatencies()
Checks for the presence of 'msgProcessingLatencies'.
|
boolean |
hasNumDupMsgsRcvd()
Checks for the presence of 'numDupMsgsRcvd'.
|
boolean |
hasNumMsgsFiltered()
Checks for the presence of 'numMsgsFiltered'.
|
boolean |
hasNumMsgsRcvdBestEffort()
Checks for the presence of 'numMsgsRcvdBestEffort'.
|
boolean |
hasNumMsgsRcvdGuaranteed()
Checks for the presence of 'numMsgsRcvdGuaranteed'.
|
boolean |
hasNumMsgsResent()
Checks for the presence of 'numMsgsResent'.
|
boolean |
hasNumMsgsSentBestEffort()
Checks for the presence of 'numMsgsSentBestEffort'.
|
boolean |
hasNumMsgsSentGuaranteed()
Checks for the presence of 'numMsgsSentGuaranteed'.
|
boolean |
hasNumMsgsSourced()
Checks for the presence of 'numMsgsSourced'.
|
boolean |
hasXRogType() |
SrvMonMsgTypeStats |
init()
Initialize an item.
|
boolean |
isBufferBacked() |
boolean |
isDirty() |
boolean |
isReferenceCounted() |
boolean |
isValid()
Tests if this object has any validation errors.
|
void |
lendMessageTypeName(XString val)
Lends the value of 'messageTypeName' to this object.
|
void |
lendMsgCreateToOfferLatencies(SrvMonIntSeries val)
'Lends' a reference of the SrvMonIntSeries to the message for this field.
|
void |
lendMsgFilteringLatencies(SrvMonIntSeries val)
'Lends' a reference of the SrvMonIntSeries to the message for this field.
|
void |
lendMsgOfferToPollLatencies(SrvMonIntSeries val)
'Lends' a reference of the SrvMonIntSeries to the message for this field.
|
void |
lendMsgPreProcessingLatencies(SrvMonIntSeries val)
'Lends' a reference of the SrvMonIntSeries to the message for this field.
|
void |
lendMsgProcessingLatencies(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() |
static void |
setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val) |
static void |
setFieldInterest(List<Integer> fieldIds) |
void |
setMessageFactoryId(short val)
Sets the value of 'messageFactoryId'.
|
void |
setMessageFactoryIdAsObject(Short val)
Sets the value of 'messageFactoryId'.
|
void |
setMessageFactoryIdFrom(com.neeve.xbuf.XbufVariableShortField val) |
void |
setMessageTypeId(short val)
Sets the value of 'messageTypeId'.
|
void |
setMessageTypeIdAsObject(Short val)
Sets the value of 'messageTypeId'.
|
void |
setMessageTypeIdFrom(com.neeve.xbuf.XbufVariableShortField val) |
void |
setMessageTypeName(String val)
Sets the value of 'messageTypeName'.
|
void |
setMessageTypeNameFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setMessageTypeNameFrom(com.neeve.xbuf.XbufStringField val) |
void |
setMessageTypeNameFrom(XString val)
Copies the provided XString value into this object's 'messageTypeName'.
|
void |
setMsgCreateToOfferLatencies(SrvMonIntSeries val)
Sets the value of 'msgCreateToOfferLatencies'.
|
void |
setMsgFilteringLatencies(SrvMonIntSeries val)
Sets the value of 'msgFilteringLatencies'.
|
void |
setMsgOfferToPollLatencies(SrvMonIntSeries val)
Sets the value of 'msgOfferToPollLatencies'.
|
void |
setMsgPreProcessingLatencies(SrvMonIntSeries val)
Sets the value of 'msgPreProcessingLatencies'.
|
void |
setMsgProcessingLatencies(SrvMonIntSeries val)
Sets the value of 'msgProcessingLatencies'.
|
void |
setNumDupMsgsRcvd(long val)
Sets the value of 'numDupMsgsRcvd'.
|
void |
setNumDupMsgsRcvdAsObject(Long val)
Sets the value of 'numDupMsgsRcvd'.
|
void |
setNumDupMsgsRcvdFrom(com.neeve.xbuf.XbufVariableLongField val) |
void |
setNumMsgsFiltered(long val)
Sets the value of 'numMsgsFiltered'.
|
void |
setNumMsgsFilteredAsObject(Long val)
Sets the value of 'numMsgsFiltered'.
|
void |
setNumMsgsFilteredFrom(com.neeve.xbuf.XbufVariableLongField val) |
void |
setNumMsgsRcvdBestEffort(long val)
Sets the value of 'numMsgsRcvdBestEffort'.
|
void |
setNumMsgsRcvdBestEffortAsObject(Long val)
Sets the value of 'numMsgsRcvdBestEffort'.
|
void |
setNumMsgsRcvdBestEffortFrom(com.neeve.xbuf.XbufVariableLongField val) |
void |
setNumMsgsRcvdGuaranteed(long val)
Sets the value of 'numMsgsRcvdGuaranteed'.
|
void |
setNumMsgsRcvdGuaranteedAsObject(Long val)
Sets the value of 'numMsgsRcvdGuaranteed'.
|
void |
setNumMsgsRcvdGuaranteedFrom(com.neeve.xbuf.XbufVariableLongField val) |
void |
setNumMsgsResent(long val)
Sets the value of 'numMsgsResent'.
|
void |
setNumMsgsResentAsObject(Long val)
Sets the value of 'numMsgsResent'.
|
void |
setNumMsgsResentFrom(com.neeve.xbuf.XbufVariableLongField val) |
void |
setNumMsgsSentBestEffort(long val)
Sets the value of 'numMsgsSentBestEffort'.
|
void |
setNumMsgsSentBestEffortAsObject(Long val)
Sets the value of 'numMsgsSentBestEffort'.
|
void |
setNumMsgsSentBestEffortFrom(com.neeve.xbuf.XbufVariableLongField val) |
void |
setNumMsgsSentGuaranteed(long val)
Sets the value of 'numMsgsSentGuaranteed'.
|
void |
setNumMsgsSentGuaranteedAsObject(Long val)
Sets the value of 'numMsgsSentGuaranteed'.
|
void |
setNumMsgsSentGuaranteedFrom(com.neeve.xbuf.XbufVariableLongField val) |
void |
setNumMsgsSourced(long val)
Sets the value of 'numMsgsSourced'.
|
void |
setNumMsgsSourcedAsObject(Long val)
Sets the value of 'numMsgsSourced'.
|
void |
setNumMsgsSourcedFrom(com.neeve.xbuf.XbufVariableLongField val) |
SrvMonMsgTypeStats |
setPool(UtlPool<SrvMonMsgTypeStats> pool)
Set a pool item's pool.
|
void |
setPreserializedFields(PktBuffer buffer) |
void |
setXRogType(short val) |
void |
setXRogTypeAsObject(Short val) |
void |
setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val) |
void |
sync() |
void |
syncFieldBitmask() |
SrvMonIntSeries |
takeMsgCreateToOfferLatencies()
'Takes' a reference to the msgCreateToOfferLatencies field from the message.
|
SrvMonIntSeries |
takeMsgFilteringLatencies()
'Takes' a reference to the msgFilteringLatencies field from the message.
|
SrvMonIntSeries |
takeMsgOfferToPollLatencies()
'Takes' a reference to the msgOfferToPollLatencies field from the message.
|
SrvMonIntSeries |
takeMsgPreProcessingLatencies()
'Takes' a reference to the msgPreProcessingLatencies field from the message.
|
SrvMonIntSeries |
takeMsgProcessingLatencies()
'Takes' a reference to the msgProcessingLatencies field from the message.
|
String |
toString() |
public static final SrvMonMsgTypeStats[] EMPTY_ARRAY
public SrvMonMsgTypeStats()
public SrvMonMsgTypeStats(int initialBackingBufferSize)
public static SrvMonMsgTypeStats create()
public static SrvMonMsgTypeStats createFromSerializedXbufContainer(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public static SrvMonMsgTypeStats createFromSerializedXbufContainer(byte[] serializedContainer)
public static SrvMonMsgTypeStats createFrom(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public static SrvMonMsgTypeStats createFrom(byte[] serializedContainer)
public static final void setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
public static final com.neeve.xbuf.XbufDesyncPolicy getDesyncPolicy()
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 final void setPreserializedFields(PktBuffer buffer)
public static final int getXRogTypeFieldId()
public final void setXRogType(short val)
public final void setXRogTypeAsObject(Short val)
public final short getXRogType()
public final Short getXRogTypeAsObject()
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 getNumMsgsRcvdBestEffortFieldId()
public final void setNumMsgsRcvdBestEffort(long val)
ISrvMonMsgTypeStatssetNumMsgsRcvdBestEffort in interface ISrvMonMsgTypeStatsval - The value to set.public final void setNumMsgsRcvdBestEffortAsObject(Long val)
ISrvMonMsgTypeStatssetNumMsgsRcvdBestEffortAsObject in interface ISrvMonMsgTypeStatsval - The value to set.public final long getNumMsgsRcvdBestEffort()
ISrvMonMsgTypeStatsgetNumMsgsRcvdBestEffort in interface ISrvMonMsgTypeStatspublic final Long getNumMsgsRcvdBestEffortAsObject()
ISrvMonMsgTypeStatsgetNumMsgsRcvdBestEffortAsObject in interface ISrvMonMsgTypeStatspublic final void setNumMsgsRcvdBestEffortFrom(com.neeve.xbuf.XbufVariableLongField val)
public final com.neeve.xbuf.XbufVariableLongField getNumMsgsRcvdBestEffortField()
public final boolean hasNumMsgsRcvdBestEffort()
ISrvMonMsgTypeStatshasNumMsgsRcvdBestEffort in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.getNumMsgsRcvdBestEffort()public final void clearNumMsgsRcvdBestEffort()
ISrvMonMsgTypeStatsclearNumMsgsRcvdBestEffort in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.setNumMsgsRcvdBestEffort(long)public static final int getNumMsgsRcvdGuaranteedFieldId()
public final void setNumMsgsRcvdGuaranteed(long val)
ISrvMonMsgTypeStatssetNumMsgsRcvdGuaranteed in interface ISrvMonMsgTypeStatsval - The value to set.public final void setNumMsgsRcvdGuaranteedAsObject(Long val)
ISrvMonMsgTypeStatssetNumMsgsRcvdGuaranteedAsObject in interface ISrvMonMsgTypeStatsval - The value to set.public final long getNumMsgsRcvdGuaranteed()
ISrvMonMsgTypeStatsgetNumMsgsRcvdGuaranteed in interface ISrvMonMsgTypeStatspublic final Long getNumMsgsRcvdGuaranteedAsObject()
ISrvMonMsgTypeStatsgetNumMsgsRcvdGuaranteedAsObject in interface ISrvMonMsgTypeStatspublic final void setNumMsgsRcvdGuaranteedFrom(com.neeve.xbuf.XbufVariableLongField val)
public final com.neeve.xbuf.XbufVariableLongField getNumMsgsRcvdGuaranteedField()
public final boolean hasNumMsgsRcvdGuaranteed()
ISrvMonMsgTypeStatshasNumMsgsRcvdGuaranteed in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.getNumMsgsRcvdGuaranteed()public final void clearNumMsgsRcvdGuaranteed()
ISrvMonMsgTypeStatsclearNumMsgsRcvdGuaranteed in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.setNumMsgsRcvdGuaranteed(long)public static final int getNumDupMsgsRcvdFieldId()
public final void setNumDupMsgsRcvd(long val)
ISrvMonMsgTypeStatssetNumDupMsgsRcvd in interface ISrvMonMsgTypeStatsval - The value to set.public final void setNumDupMsgsRcvdAsObject(Long val)
ISrvMonMsgTypeStatssetNumDupMsgsRcvdAsObject in interface ISrvMonMsgTypeStatsval - The value to set.public final long getNumDupMsgsRcvd()
ISrvMonMsgTypeStatsgetNumDupMsgsRcvd in interface ISrvMonMsgTypeStatspublic final Long getNumDupMsgsRcvdAsObject()
ISrvMonMsgTypeStatsgetNumDupMsgsRcvdAsObject in interface ISrvMonMsgTypeStatspublic final void setNumDupMsgsRcvdFrom(com.neeve.xbuf.XbufVariableLongField val)
public final com.neeve.xbuf.XbufVariableLongField getNumDupMsgsRcvdField()
public final boolean hasNumDupMsgsRcvd()
ISrvMonMsgTypeStatshasNumDupMsgsRcvd in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.getNumDupMsgsRcvd()public final void clearNumDupMsgsRcvd()
ISrvMonMsgTypeStatsclearNumDupMsgsRcvd in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.setNumDupMsgsRcvd(long)public static final int getNumMsgsSentBestEffortFieldId()
public final void setNumMsgsSentBestEffort(long val)
ISrvMonMsgTypeStatssetNumMsgsSentBestEffort in interface ISrvMonMsgTypeStatsval - The value to set.public final void setNumMsgsSentBestEffortAsObject(Long val)
ISrvMonMsgTypeStatssetNumMsgsSentBestEffortAsObject in interface ISrvMonMsgTypeStatsval - The value to set.public final long getNumMsgsSentBestEffort()
ISrvMonMsgTypeStatsgetNumMsgsSentBestEffort in interface ISrvMonMsgTypeStatspublic final Long getNumMsgsSentBestEffortAsObject()
ISrvMonMsgTypeStatsgetNumMsgsSentBestEffortAsObject in interface ISrvMonMsgTypeStatspublic final void setNumMsgsSentBestEffortFrom(com.neeve.xbuf.XbufVariableLongField val)
public final com.neeve.xbuf.XbufVariableLongField getNumMsgsSentBestEffortField()
public final boolean hasNumMsgsSentBestEffort()
ISrvMonMsgTypeStatshasNumMsgsSentBestEffort in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.getNumMsgsSentBestEffort()public final void clearNumMsgsSentBestEffort()
ISrvMonMsgTypeStatsclearNumMsgsSentBestEffort in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.setNumMsgsSentBestEffort(long)public static final int getNumMsgsSentGuaranteedFieldId()
public final void setNumMsgsSentGuaranteed(long val)
ISrvMonMsgTypeStatssetNumMsgsSentGuaranteed in interface ISrvMonMsgTypeStatsval - The value to set.public final void setNumMsgsSentGuaranteedAsObject(Long val)
ISrvMonMsgTypeStatssetNumMsgsSentGuaranteedAsObject in interface ISrvMonMsgTypeStatsval - The value to set.public final long getNumMsgsSentGuaranteed()
ISrvMonMsgTypeStatsgetNumMsgsSentGuaranteed in interface ISrvMonMsgTypeStatspublic final Long getNumMsgsSentGuaranteedAsObject()
ISrvMonMsgTypeStatsgetNumMsgsSentGuaranteedAsObject in interface ISrvMonMsgTypeStatspublic final void setNumMsgsSentGuaranteedFrom(com.neeve.xbuf.XbufVariableLongField val)
public final com.neeve.xbuf.XbufVariableLongField getNumMsgsSentGuaranteedField()
public final boolean hasNumMsgsSentGuaranteed()
ISrvMonMsgTypeStatshasNumMsgsSentGuaranteed in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.getNumMsgsSentGuaranteed()public final void clearNumMsgsSentGuaranteed()
ISrvMonMsgTypeStatsclearNumMsgsSentGuaranteed in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.setNumMsgsSentGuaranteed(long)public static final int getNumMsgsResentFieldId()
public final void setNumMsgsResent(long val)
ISrvMonMsgTypeStatssetNumMsgsResent in interface ISrvMonMsgTypeStatsval - The value to set.public final void setNumMsgsResentAsObject(Long val)
ISrvMonMsgTypeStatssetNumMsgsResentAsObject in interface ISrvMonMsgTypeStatsval - The value to set.public final long getNumMsgsResent()
ISrvMonMsgTypeStatsgetNumMsgsResent in interface ISrvMonMsgTypeStatspublic final Long getNumMsgsResentAsObject()
ISrvMonMsgTypeStatsgetNumMsgsResentAsObject in interface ISrvMonMsgTypeStatspublic final void setNumMsgsResentFrom(com.neeve.xbuf.XbufVariableLongField val)
public final com.neeve.xbuf.XbufVariableLongField getNumMsgsResentField()
public final boolean hasNumMsgsResent()
ISrvMonMsgTypeStatshasNumMsgsResent in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.getNumMsgsResent()public final void clearNumMsgsResent()
ISrvMonMsgTypeStatsclearNumMsgsResent in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.setNumMsgsResent(long)public static final int getNumMsgsSourcedFieldId()
public final void setNumMsgsSourced(long val)
ISrvMonMsgTypeStatsSourced messages apply only to messages not received directly from a message bus. They include: messages replicated to the backup, initialized from the event log at the primary, initialized from the primary at the backup, and messages injected by the application. The total number of messages received by the engine can be computed by adding numMsgsRcvdBestEffort + numMsgsRcvdGuaranteed + numMsgsSourced.
setNumMsgsSourced in interface ISrvMonMsgTypeStatsval - The value to set.public final void setNumMsgsSourcedAsObject(Long val)
ISrvMonMsgTypeStatsSourced messages apply only to messages not received directly from a message bus. They include: messages replicated to the backup, initialized from the event log at the primary, initialized from the primary at the backup, and messages injected by the application. The total number of messages received by the engine can be computed by adding numMsgsRcvdBestEffort + numMsgsRcvdGuaranteed + numMsgsSourced.
setNumMsgsSourcedAsObject in interface ISrvMonMsgTypeStatsval - The value to set.public final long getNumMsgsSourced()
ISrvMonMsgTypeStatsSourced messages apply only to messages not received directly from a message bus. They include: messages replicated to the backup, initialized from the event log at the primary, initialized from the primary at the backup, and messages injected by the application. The total number of messages received by the engine can be computed by adding numMsgsRcvdBestEffort + numMsgsRcvdGuaranteed + numMsgsSourced.
getNumMsgsSourced in interface ISrvMonMsgTypeStatspublic final Long getNumMsgsSourcedAsObject()
ISrvMonMsgTypeStatsSourced messages apply only to messages not received directly from a message bus. They include: messages replicated to the backup, initialized from the event log at the primary, initialized from the primary at the backup, and messages injected by the application. The total number of messages received by the engine can be computed by adding numMsgsRcvdBestEffort + numMsgsRcvdGuaranteed + numMsgsSourced.
getNumMsgsSourcedAsObject in interface ISrvMonMsgTypeStatspublic final void setNumMsgsSourcedFrom(com.neeve.xbuf.XbufVariableLongField val)
public final com.neeve.xbuf.XbufVariableLongField getNumMsgsSourcedField()
public final boolean hasNumMsgsSourced()
ISrvMonMsgTypeStatsSourced messages apply only to messages not received directly from a message bus. They include: messages replicated to the backup, initialized from the event log at the primary, initialized from the primary at the backup, and messages injected by the application. The total number of messages received by the engine can be computed by adding numMsgsRcvdBestEffort + numMsgsRcvdGuaranteed + numMsgsSourced.
hasNumMsgsSourced in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.getNumMsgsSourced()public final void clearNumMsgsSourced()
ISrvMonMsgTypeStatsSourced messages apply only to messages not received directly from a message bus. They include: messages replicated to the backup, initialized from the event log at the primary, initialized from the primary at the backup, and messages injected by the application. The total number of messages received by the engine can be computed by adding numMsgsRcvdBestEffort + numMsgsRcvdGuaranteed + numMsgsSourced.
clearNumMsgsSourced in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.setNumMsgsSourced(long)public static final int getNumMsgsFilteredFieldId()
public final void setNumMsgsFiltered(long val)
ISrvMonMsgTypeStatssetNumMsgsFiltered in interface ISrvMonMsgTypeStatsval - The value to set.public final void setNumMsgsFilteredAsObject(Long val)
ISrvMonMsgTypeStatssetNumMsgsFilteredAsObject in interface ISrvMonMsgTypeStatsval - The value to set.public final long getNumMsgsFiltered()
ISrvMonMsgTypeStatsgetNumMsgsFiltered in interface ISrvMonMsgTypeStatspublic final Long getNumMsgsFilteredAsObject()
ISrvMonMsgTypeStatsgetNumMsgsFilteredAsObject in interface ISrvMonMsgTypeStatspublic final void setNumMsgsFilteredFrom(com.neeve.xbuf.XbufVariableLongField val)
public final com.neeve.xbuf.XbufVariableLongField getNumMsgsFilteredField()
public final boolean hasNumMsgsFiltered()
ISrvMonMsgTypeStatshasNumMsgsFiltered in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.getNumMsgsFiltered()public final void clearNumMsgsFiltered()
ISrvMonMsgTypeStatsclearNumMsgsFiltered in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.setNumMsgsFiltered(long)public static final int getMessageFactoryIdFieldId()
public final void setMessageFactoryId(short val)
ISrvMonMsgTypeStatssetMessageFactoryId in interface ISrvMonMsgTypeStatsval - The value to set.public final void setMessageFactoryIdAsObject(Short val)
ISrvMonMsgTypeStatssetMessageFactoryIdAsObject in interface ISrvMonMsgTypeStatsval - The value to set.public final short getMessageFactoryId()
ISrvMonMsgTypeStatsgetMessageFactoryId in interface ISrvMonMsgTypeStatspublic final Short getMessageFactoryIdAsObject()
ISrvMonMsgTypeStatsgetMessageFactoryIdAsObject in interface ISrvMonMsgTypeStatspublic final void setMessageFactoryIdFrom(com.neeve.xbuf.XbufVariableShortField val)
public final com.neeve.xbuf.XbufVariableShortField getMessageFactoryIdField()
public final boolean hasMessageFactoryId()
ISrvMonMsgTypeStatshasMessageFactoryId in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.getMessageFactoryId()public final void clearMessageFactoryId()
ISrvMonMsgTypeStatsclearMessageFactoryId in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.setMessageFactoryId(short)public static final int getMessageTypeIdFieldId()
public final void setMessageTypeId(short val)
ISrvMonMsgTypeStatssetMessageTypeId in interface ISrvMonMsgTypeStatsval - The value to set.public final void setMessageTypeIdAsObject(Short val)
ISrvMonMsgTypeStatssetMessageTypeIdAsObject in interface ISrvMonMsgTypeStatsval - The value to set.public final short getMessageTypeId()
ISrvMonMsgTypeStatsgetMessageTypeId in interface ISrvMonMsgTypeStatspublic final Short getMessageTypeIdAsObject()
ISrvMonMsgTypeStatsgetMessageTypeIdAsObject in interface ISrvMonMsgTypeStatspublic final void setMessageTypeIdFrom(com.neeve.xbuf.XbufVariableShortField val)
public final com.neeve.xbuf.XbufVariableShortField getMessageTypeIdField()
public final boolean hasMessageTypeId()
ISrvMonMsgTypeStatshasMessageTypeId in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.getMessageTypeId()public final void clearMessageTypeId()
ISrvMonMsgTypeStatsclearMessageTypeId in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.setMessageTypeId(short)public static final int getMsgProcessingLatenciesFieldId()
public final void setMsgProcessingLatencies(SrvMonIntSeries val)
ISrvMonMsgTypeStatssetMsgProcessingLatencies in interface ISrvMonMsgTypeStatsval - The value to set.public final void lendMsgProcessingLatencies(SrvMonIntSeries val)
ISrvMonMsgTypeStats
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.
lendMsgProcessingLatencies in interface ISrvMonMsgTypeStatsval - the value to 'lend' to lend.public final SrvMonIntSeries getMsgProcessingLatencies()
ISrvMonMsgTypeStatsgetMsgProcessingLatencies in interface ISrvMonMsgTypeStatspublic final void getMsgProcessingLatenciesTo(SrvMonIntSeries to)
ISrvMonMsgTypeStatsIF the value is not set, then the contents of the provided SrvMonIntSeries are cleared.
getMsgProcessingLatenciesTo in interface ISrvMonMsgTypeStatsto - the value to copy intoSrvMonIntSeries.copyInto(SrvMonIntSeries)public final SrvMonIntSeries takeMsgProcessingLatencies()
ISrvMonMsgTypeStats
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.
takeMsgProcessingLatencies in interface ISrvMonMsgTypeStatsnull if the field is not set.public final boolean hasMsgProcessingLatencies()
ISrvMonMsgTypeStatshasMsgProcessingLatencies in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.getMsgProcessingLatencies()public final void clearMsgProcessingLatencies()
ISrvMonMsgTypeStatsclearMsgProcessingLatencies in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.setMsgProcessingLatencies(SrvMonIntSeries)public static final int getMsgFilteringLatenciesFieldId()
public final void setMsgFilteringLatencies(SrvMonIntSeries val)
ISrvMonMsgTypeStatssetMsgFilteringLatencies in interface ISrvMonMsgTypeStatsval - The value to set.public final void lendMsgFilteringLatencies(SrvMonIntSeries val)
ISrvMonMsgTypeStats
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.
lendMsgFilteringLatencies in interface ISrvMonMsgTypeStatsval - the value to 'lend' to lend.public final SrvMonIntSeries getMsgFilteringLatencies()
ISrvMonMsgTypeStatsgetMsgFilteringLatencies in interface ISrvMonMsgTypeStatspublic final void getMsgFilteringLatenciesTo(SrvMonIntSeries to)
ISrvMonMsgTypeStatsIF the value is not set, then the contents of the provided SrvMonIntSeries are cleared.
getMsgFilteringLatenciesTo in interface ISrvMonMsgTypeStatsto - the value to copy intoSrvMonIntSeries.copyInto(SrvMonIntSeries)public final SrvMonIntSeries takeMsgFilteringLatencies()
ISrvMonMsgTypeStats
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.
takeMsgFilteringLatencies in interface ISrvMonMsgTypeStatsnull if the field is not set.public final boolean hasMsgFilteringLatencies()
ISrvMonMsgTypeStatshasMsgFilteringLatencies in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.getMsgFilteringLatencies()public final void clearMsgFilteringLatencies()
ISrvMonMsgTypeStatsclearMsgFilteringLatencies in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.setMsgFilteringLatencies(SrvMonIntSeries)public static final int getMsgPreProcessingLatenciesFieldId()
public final void setMsgPreProcessingLatencies(SrvMonIntSeries val)
ISrvMonMsgTypeStatsMessage pre processing latencies record the time spent by the engine after it takes a message f rom its input queue to the time at which it begins dispatching it to handlers - in other words any bookkeeping overhead done by the engine done to prepare the message from dispatch.
A high value in this statistic could indicate:
setMsgPreProcessingLatencies in interface ISrvMonMsgTypeStatsval - The value to set.public final void lendMsgPreProcessingLatencies(SrvMonIntSeries val)
ISrvMonMsgTypeStatsMessage pre processing latencies record the time spent by the engine after it takes a message f rom its input queue to the time at which it begins dispatching it to handlers - in other words any bookkeeping overhead done by the engine done to prepare the message from dispatch.
A high value in this statistic could indicate:
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.
lendMsgPreProcessingLatencies in interface ISrvMonMsgTypeStatsval - the value to 'lend' to lend.public final SrvMonIntSeries getMsgPreProcessingLatencies()
ISrvMonMsgTypeStatsMessage pre processing latencies record the time spent by the engine after it takes a message f rom its input queue to the time at which it begins dispatching it to handlers - in other words any bookkeeping overhead done by the engine done to prepare the message from dispatch.
A high value in this statistic could indicate:
getMsgPreProcessingLatencies in interface ISrvMonMsgTypeStatspublic final void getMsgPreProcessingLatenciesTo(SrvMonIntSeries to)
ISrvMonMsgTypeStatsIF the value is not set, then the contents of the provided SrvMonIntSeries are cleared.
getMsgPreProcessingLatenciesTo in interface ISrvMonMsgTypeStatsto - the value to copy intoSrvMonIntSeries.copyInto(SrvMonIntSeries)public final SrvMonIntSeries takeMsgPreProcessingLatencies()
ISrvMonMsgTypeStatsMessage pre processing latencies record the time spent by the engine after it takes a message f rom its input queue to the time at which it begins dispatching it to handlers - in other words any bookkeeping overhead done by the engine done to prepare the message from dispatch.
A high value in this statistic could indicate:
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.
takeMsgPreProcessingLatencies in interface ISrvMonMsgTypeStatsnull if the field is not set.public final boolean hasMsgPreProcessingLatencies()
ISrvMonMsgTypeStatsMessage pre processing latencies record the time spent by the engine after it takes a message f rom its input queue to the time at which it begins dispatching it to handlers - in other words any bookkeeping overhead done by the engine done to prepare the message from dispatch.
A high value in this statistic could indicate:
hasMsgPreProcessingLatencies in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.getMsgPreProcessingLatencies()public final void clearMsgPreProcessingLatencies()
ISrvMonMsgTypeStatsMessage pre processing latencies record the time spent by the engine after it takes a message f rom its input queue to the time at which it begins dispatching it to handlers - in other words any bookkeeping overhead done by the engine done to prepare the message from dispatch.
A high value in this statistic could indicate:
clearMsgPreProcessingLatencies in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.setMsgPreProcessingLatencies(SrvMonIntSeries)public static final int getMsgCreateToOfferLatenciesFieldId()
public final void setMsgCreateToOfferLatencies(SrvMonIntSeries val)
ISrvMonMsgTypeStatsThis statistic records the time from when a message was created to when it was queued for processing by the engine.
The creation timestamp is dependent on the source of the messsage:
setMsgCreateToOfferLatencies in interface ISrvMonMsgTypeStatsval - The value to set.public final void lendMsgCreateToOfferLatencies(SrvMonIntSeries val)
ISrvMonMsgTypeStatsThis statistic records the time from when a message was created to when it was queued for processing by the engine.
The creation timestamp is dependent on the source of the messsage:
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.
lendMsgCreateToOfferLatencies in interface ISrvMonMsgTypeStatsval - the value to 'lend' to lend.public final SrvMonIntSeries getMsgCreateToOfferLatencies()
ISrvMonMsgTypeStatsThis statistic records the time from when a message was created to when it was queued for processing by the engine.
The creation timestamp is dependent on the source of the messsage:
getMsgCreateToOfferLatencies in interface ISrvMonMsgTypeStatspublic final void getMsgCreateToOfferLatenciesTo(SrvMonIntSeries to)
ISrvMonMsgTypeStatsIF the value is not set, then the contents of the provided SrvMonIntSeries are cleared.
getMsgCreateToOfferLatenciesTo in interface ISrvMonMsgTypeStatsto - the value to copy intoSrvMonIntSeries.copyInto(SrvMonIntSeries)public final SrvMonIntSeries takeMsgCreateToOfferLatencies()
ISrvMonMsgTypeStatsThis statistic records the time from when a message was created to when it was queued for processing by the engine.
The creation timestamp is dependent on the source of the messsage:
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.
takeMsgCreateToOfferLatencies in interface ISrvMonMsgTypeStatsnull if the field is not set.public final boolean hasMsgCreateToOfferLatencies()
ISrvMonMsgTypeStatsThis statistic records the time from when a message was created to when it was queued for processing by the engine.
The creation timestamp is dependent on the source of the messsage:
hasMsgCreateToOfferLatencies in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.getMsgCreateToOfferLatencies()public final void clearMsgCreateToOfferLatencies()
ISrvMonMsgTypeStatsThis statistic records the time from when a message was created to when it was queued for processing by the engine.
The creation timestamp is dependent on the source of the messsage:
clearMsgCreateToOfferLatencies in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.setMsgCreateToOfferLatencies(SrvMonIntSeries)public static final int getMsgOfferToPollLatenciesFieldId()
public final void setMsgOfferToPollLatencies(SrvMonIntSeries val)
ISrvMonMsgTypeStatsOffer to poll latencies capture the time from which a message was offered to the AepEngine to the time that it is picked up by the engine for processing -- in other words the queue time (if any for the message).
Note that the poll timestamp is the timestamp just after the engine's thread picks up the message, it does not include engine pre processing time, or message filtering time prior to the message being dispatch to an application handler.
This time will included any scheduling delay specified for the message when it is offered to engine.
setMsgOfferToPollLatencies in interface ISrvMonMsgTypeStatsval - The value to set.public final void lendMsgOfferToPollLatencies(SrvMonIntSeries val)
ISrvMonMsgTypeStatsOffer to poll latencies capture the time from which a message was offered to the AepEngine to the time that it is picked up by the engine for processing -- in other words the queue time (if any for the message).
Note that the poll timestamp is the timestamp just after the engine's thread picks up the message, it does not include engine pre processing time, or message filtering time prior to the message being dispatch to an application handler.
This time will included any scheduling delay specified for the message when it is offered to engine.
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.
lendMsgOfferToPollLatencies in interface ISrvMonMsgTypeStatsval - the value to 'lend' to lend.public final SrvMonIntSeries getMsgOfferToPollLatencies()
ISrvMonMsgTypeStatsOffer to poll latencies capture the time from which a message was offered to the AepEngine to the time that it is picked up by the engine for processing -- in other words the queue time (if any for the message).
Note that the poll timestamp is the timestamp just after the engine's thread picks up the message, it does not include engine pre processing time, or message filtering time prior to the message being dispatch to an application handler.
This time will included any scheduling delay specified for the message when it is offered to engine.
getMsgOfferToPollLatencies in interface ISrvMonMsgTypeStatspublic final void getMsgOfferToPollLatenciesTo(SrvMonIntSeries to)
ISrvMonMsgTypeStatsIF the value is not set, then the contents of the provided SrvMonIntSeries are cleared.
getMsgOfferToPollLatenciesTo in interface ISrvMonMsgTypeStatsto - the value to copy intoSrvMonIntSeries.copyInto(SrvMonIntSeries)public final SrvMonIntSeries takeMsgOfferToPollLatencies()
ISrvMonMsgTypeStatsOffer to poll latencies capture the time from which a message was offered to the AepEngine to the time that it is picked up by the engine for processing -- in other words the queue time (if any for the message).
Note that the poll timestamp is the timestamp just after the engine's thread picks up the message, it does not include engine pre processing time, or message filtering time prior to the message being dispatch to an application handler.
This time will included any scheduling delay specified for the message when it is offered to engine.
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.
takeMsgOfferToPollLatencies in interface ISrvMonMsgTypeStatsnull if the field is not set.public final boolean hasMsgOfferToPollLatencies()
ISrvMonMsgTypeStatsOffer to poll latencies capture the time from which a message was offered to the AepEngine to the time that it is picked up by the engine for processing -- in other words the queue time (if any for the message).
Note that the poll timestamp is the timestamp just after the engine's thread picks up the message, it does not include engine pre processing time, or message filtering time prior to the message being dispatch to an application handler.
This time will included any scheduling delay specified for the message when it is offered to engine.
hasMsgOfferToPollLatencies in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.getMsgOfferToPollLatencies()public final void clearMsgOfferToPollLatencies()
ISrvMonMsgTypeStatsOffer to poll latencies capture the time from which a message was offered to the AepEngine to the time that it is picked up by the engine for processing -- in other words the queue time (if any for the message).
Note that the poll timestamp is the timestamp just after the engine's thread picks up the message, it does not include engine pre processing time, or message filtering time prior to the message being dispatch to an application handler.
This time will included any scheduling delay specified for the message when it is offered to engine.
clearMsgOfferToPollLatencies in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.setMsgOfferToPollLatencies(SrvMonIntSeries)public static final int getMessageTypeNameFieldId()
public final void setMessageTypeName(String val)
ISrvMonMsgTypeStatssetMessageTypeName in interface ISrvMonMsgTypeStatsval - The value to set.public final String getMessageTypeName()
ISrvMonMsgTypeStatsgetMessageTypeName in interface ISrvMonMsgTypeStatspublic final void lendMessageTypeName(XString val)
ISrvMonMsgTypeStatsThis method is equivalent to setMessageTypeName 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.
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.
lendMessageTypeName in interface ISrvMonMsgTypeStatsval - The value to set.public final void setMessageTypeNameFrom(long val)
ISrvMonMsgTypeStats
NOTE:
This is the same as calling ISrvMonMsgTypeStats.setMessageTypeName(String).
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setMessageTypeNameFrom in interface ISrvMonMsgTypeStatspublic final <T extends XString> T getMessageTypeNameTo(XString.Factory<T> factory)
ISrvMonMsgTypeStats
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;
getMessageTypeNameTo in interface ISrvMonMsgTypeStatsfactory - The factory from which to get the XString to copy into and returnnull.public final void setMessageTypeNameFrom(XString val)
ISrvMonMsgTypeStats
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than ISrvMonMsgTypeStats.setMessageTypeName(String)
because it avoids encoding the value into a String if the given XString is already encoded.
setMessageTypeNameFrom in interface ISrvMonMsgTypeStatspublic final void getMessageTypeNameTo(XString val)
ISrvMonMsgTypeStats
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than ISrvMonMsgTypeStats.getMessageTypeName() bec
because it can avoid decoding the value into an String.
getMessageTypeNameTo in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.getMessageTypeName()public final XString getMessageTypeNameUnsafe()
ISrvMonMsgTypeStats
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.
getMessageTypeNameUnsafe in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.getMessageTypeName()public final void setMessageTypeNameFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getMessageTypeNameField()
public final boolean hasMessageTypeName()
ISrvMonMsgTypeStatshasMessageTypeName in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.getMessageTypeName()public final void clearMessageTypeName()
ISrvMonMsgTypeStatsclearMessageTypeName in interface ISrvMonMsgTypeStatsISrvMonMsgTypeStats.setMessageTypeName(String)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 SrvMonMsgTypeStats deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public final SrvMonMsgTypeStats deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length)
public final SrvMonMsgTypeStats deserializeFromByteArray(byte[] array, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public final SrvMonMsgTypeStats deserializeFromByteArray(byte[] array)
public final SrvMonMsgTypeStats deserializeFromByteBuffer(ByteBuffer buffer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public final SrvMonMsgTypeStats deserializeFromByteBuffer(ByteBuffer buffer)
public final SrvMonMsgTypeStats deserializeFromNative(long address, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public final SrvMonMsgTypeStats deserializeFromNative(long address, int offset, int length)
public final void sync()
public final int desync(PktBuffer buffer, int pos, boolean frameOnly)
com.neeve.xbuf.IXbufDesyncerdesync in interface com.neeve.xbuf.IXbufDesyncerbuffer - The buffer to desync frompos - The position in the container's backing buffer to desync
fromframeOnly - Whether to frame the field on the underlying buffer.
See XbufField.desync(PktBuffer, int, boolean) for more
informationpublic final SrvMonMsgTypeStats init()
UtlPool.ItemThis 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<SrvMonMsgTypeStats>public final SrvMonMsgTypeStats setPool(UtlPool<SrvMonMsgTypeStats> pool)
UtlPool.ItemThis 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<SrvMonMsgTypeStats>public final UtlPool<SrvMonMsgTypeStats> getPool()
UtlPool.Item
This method should return the pool set using UtlPool.Item.setPool(com.neeve.util.UtlPool<T>)
getPool in interface UtlPool.Item<SrvMonMsgTypeStats>UtlPool.Item.setPool(com.neeve.util.UtlPool<T>)public final boolean isReferenceCounted()
public final SrvMonMsgTypeStats acquire()
public final int getOwnerCount()
public final void dispose()
public final Object clone()
This method differs from the copy() method in that:
public final SrvMonMsgTypeStats 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 SrvMonMsgTypeStats's embedded entity fields.
The returned copy will be writeable even if this SrvMonMsgTypeStats is read only.
public final void copyInto(SrvMonMsgTypeStats 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 SrvMonMsgTypeStats's embedded entity fields.
The returned copy will be writeable even if this SrvMonMsgTypeStats is read only.
copy - The target into which to copy.public final boolean isValid()
IRogValidatableisValid in interface IRogValidatablepublic final void getValidationErrors(List<XString> results, String errorPrefix)
IRogValidatablegetValidationErrors in interface IRogValidatableresults - 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.Copyright © 2019 Neeve Research, LLC. All Rights Reserved.