@Generated(value="com.neeve.adm.AdmGenerator", date="Fri Dec 05 13:32:50 UTC 2025") @AdmGenerated(compatLevel="4.1.0", admVersion="Unknown Version", date="12/5/25 1:32 PM", buildInfo="nvx-talon-3.16.63 (nvx-codegen-plugin)") public interface ISrvMonMsgTypeStats extends IRogValidatable
| ADM Type | Embedded Entity |
| Factory | SrvMonFactory |
| ADM Field Summary |
|---|
| Field | Type | Id | Description |
|---|---|---|---|
| messageFactoryId | Short | 101 | The factory id for the message type (unique within the application). |
| messageTypeId | Short | 102 | The message type id within its factory (unique within the type's factory). |
| messageTypeName | String | 100 | The fully qualified name of the message type. |
| msgCreateToOfferLatencies | SrvMonIntSeries |
48 |
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 |
46 | Records latencies for application message filtering times (by a message filter) (aka 'mfilt') in microseconds. |
| msgOfferToPollLatencies | SrvMonIntSeries |
49 |
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 |
47 |
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 |
28 | Records latencies for application message process times (in an EventHandler) (aka 'mproc'). |
| numDupMsgsRcvd | Long | 4 | The number of duplicate messages the application has received. |
| numMsgsFiltered | Long | 45 | The number of messages that were filtered. |
| numMsgsRcvdBestEffort | Long | 2 | The number of best effort messages the application has received. |
| numMsgsRcvdGuaranteed | Long | 3 | The number of guaranteed messages the application has received. |
| numMsgsResent | Long | 7 | The number of messages the application has retransmitted. |
| numMsgsSentBestEffort | Long | 5 | The number of best effort messages sent by the application. |
| numMsgsSentGuaranteed | Long | 6 | The number of guaranteed messages sent by the application. |
| numMsgsSourced | Long | 44 |
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 | Method and Description |
|---|---|
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'.
|
short |
getMessageFactoryId()
Gets the value of 'messageFactoryId'.
|
Short |
getMessageFactoryIdAsObject()
Gets the value of 'messageFactoryId'.
|
short |
getMessageTypeId()
Gets the value of 'messageTypeId'.
|
Short |
getMessageTypeIdAsObject()
Gets the value of 'messageTypeId'.
|
String |
getMessageTypeName()
Gets the value of 'messageTypeName'.
|
<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'.
|
void |
getMsgCreateToOfferLatenciesTo(SrvMonIntSeries val)
Copies the value of SrvMonIntSeries into the provided value.
|
SrvMonIntSeries |
getMsgFilteringLatencies()
Gets the value of 'msgFilteringLatencies'.
|
void |
getMsgFilteringLatenciesTo(SrvMonIntSeries val)
Copies the value of SrvMonIntSeries into the provided value.
|
SrvMonIntSeries |
getMsgOfferToPollLatencies()
Gets the value of 'msgOfferToPollLatencies'.
|
void |
getMsgOfferToPollLatenciesTo(SrvMonIntSeries val)
Copies the value of SrvMonIntSeries into the provided value.
|
SrvMonIntSeries |
getMsgPreProcessingLatencies()
Gets the value of 'msgPreProcessingLatencies'.
|
void |
getMsgPreProcessingLatenciesTo(SrvMonIntSeries val)
Copies the value of SrvMonIntSeries into the provided value.
|
SrvMonIntSeries |
getMsgProcessingLatencies()
Gets the value of 'msgProcessingLatencies'.
|
void |
getMsgProcessingLatenciesTo(SrvMonIntSeries val)
Copies the value of SrvMonIntSeries into the provided value.
|
long |
getNumDupMsgsRcvd()
Gets the value of 'numDupMsgsRcvd'.
|
Long |
getNumDupMsgsRcvdAsObject()
Gets the value of 'numDupMsgsRcvd'.
|
long |
getNumMsgsFiltered()
Gets the value of 'numMsgsFiltered'.
|
Long |
getNumMsgsFilteredAsObject()
Gets the value of 'numMsgsFiltered'.
|
long |
getNumMsgsRcvdBestEffort()
Gets the value of 'numMsgsRcvdBestEffort'.
|
Long |
getNumMsgsRcvdBestEffortAsObject()
Gets the value of 'numMsgsRcvdBestEffort'.
|
long |
getNumMsgsRcvdGuaranteed()
Gets the value of 'numMsgsRcvdGuaranteed'.
|
Long |
getNumMsgsRcvdGuaranteedAsObject()
Gets the value of 'numMsgsRcvdGuaranteed'.
|
long |
getNumMsgsResent()
Gets the value of 'numMsgsResent'.
|
Long |
getNumMsgsResentAsObject()
Gets the value of 'numMsgsResent'.
|
long |
getNumMsgsSentBestEffort()
Gets the value of 'numMsgsSentBestEffort'.
|
Long |
getNumMsgsSentBestEffortAsObject()
Gets the value of 'numMsgsSentBestEffort'.
|
long |
getNumMsgsSentGuaranteed()
Gets the value of 'numMsgsSentGuaranteed'.
|
Long |
getNumMsgsSentGuaranteedAsObject()
Gets the value of 'numMsgsSentGuaranteed'.
|
long |
getNumMsgsSourced()
Gets the value of 'numMsgsSourced'.
|
Long |
getNumMsgsSourcedAsObject()
Gets the value of 'numMsgsSourced'.
|
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'.
|
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.
|
void |
setMessageFactoryId(short val)
Sets the value of 'messageFactoryId'.
|
void |
setMessageFactoryIdAsObject(Short val)
Sets the value of 'messageFactoryId'.
|
void |
setMessageTypeId(short val)
Sets the value of 'messageTypeId'.
|
void |
setMessageTypeIdAsObject(Short val)
Sets the value of 'messageTypeId'.
|
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(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 |
setNumMsgsFiltered(long val)
Sets the value of 'numMsgsFiltered'.
|
void |
setNumMsgsFilteredAsObject(Long val)
Sets the value of 'numMsgsFiltered'.
|
void |
setNumMsgsRcvdBestEffort(long val)
Sets the value of 'numMsgsRcvdBestEffort'.
|
void |
setNumMsgsRcvdBestEffortAsObject(Long val)
Sets the value of 'numMsgsRcvdBestEffort'.
|
void |
setNumMsgsRcvdGuaranteed(long val)
Sets the value of 'numMsgsRcvdGuaranteed'.
|
void |
setNumMsgsRcvdGuaranteedAsObject(Long val)
Sets the value of 'numMsgsRcvdGuaranteed'.
|
void |
setNumMsgsResent(long val)
Sets the value of 'numMsgsResent'.
|
void |
setNumMsgsResentAsObject(Long val)
Sets the value of 'numMsgsResent'.
|
void |
setNumMsgsSentBestEffort(long val)
Sets the value of 'numMsgsSentBestEffort'.
|
void |
setNumMsgsSentBestEffortAsObject(Long val)
Sets the value of 'numMsgsSentBestEffort'.
|
void |
setNumMsgsSentGuaranteed(long val)
Sets the value of 'numMsgsSentGuaranteed'.
|
void |
setNumMsgsSentGuaranteedAsObject(Long val)
Sets the value of 'numMsgsSentGuaranteed'.
|
void |
setNumMsgsSourced(long val)
Sets the value of 'numMsgsSourced'.
|
void |
setNumMsgsSourcedAsObject(Long val)
Sets the value of 'numMsgsSourced'.
|
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.
|
getValidationErrors, isValidvoid setNumMsgsRcvdBestEffort(long val)
val - The value to set.void setNumMsgsRcvdBestEffortAsObject(Long val)
val - The value to set.long getNumMsgsRcvdBestEffort()
Long getNumMsgsRcvdBestEffortAsObject()
void clearNumMsgsRcvdBestEffort()
setNumMsgsRcvdBestEffort(long)boolean hasNumMsgsRcvdBestEffort()
getNumMsgsRcvdBestEffort()void setNumMsgsRcvdGuaranteed(long val)
val - The value to set.void setNumMsgsRcvdGuaranteedAsObject(Long val)
val - The value to set.long getNumMsgsRcvdGuaranteed()
Long getNumMsgsRcvdGuaranteedAsObject()
void clearNumMsgsRcvdGuaranteed()
setNumMsgsRcvdGuaranteed(long)boolean hasNumMsgsRcvdGuaranteed()
getNumMsgsRcvdGuaranteed()void setNumDupMsgsRcvd(long val)
val - The value to set.void setNumDupMsgsRcvdAsObject(Long val)
val - The value to set.long getNumDupMsgsRcvd()
Long getNumDupMsgsRcvdAsObject()
void clearNumDupMsgsRcvd()
setNumDupMsgsRcvd(long)boolean hasNumDupMsgsRcvd()
getNumDupMsgsRcvd()void setNumMsgsSentBestEffort(long val)
val - The value to set.void setNumMsgsSentBestEffortAsObject(Long val)
val - The value to set.long getNumMsgsSentBestEffort()
Long getNumMsgsSentBestEffortAsObject()
void clearNumMsgsSentBestEffort()
setNumMsgsSentBestEffort(long)boolean hasNumMsgsSentBestEffort()
getNumMsgsSentBestEffort()void setNumMsgsSentGuaranteed(long val)
val - The value to set.void setNumMsgsSentGuaranteedAsObject(Long val)
val - The value to set.long getNumMsgsSentGuaranteed()
Long getNumMsgsSentGuaranteedAsObject()
void clearNumMsgsSentGuaranteed()
setNumMsgsSentGuaranteed(long)boolean hasNumMsgsSentGuaranteed()
getNumMsgsSentGuaranteed()void setNumMsgsResent(long val)
val - The value to set.void setNumMsgsResentAsObject(Long val)
val - The value to set.long getNumMsgsResent()
Long getNumMsgsResentAsObject()
void clearNumMsgsResent()
setNumMsgsResent(long)boolean hasNumMsgsResent()
getNumMsgsResent()void setNumMsgsSourced(long val)
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.
val - The value to set.void setNumMsgsSourcedAsObject(Long val)
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.
val - The value to set.long getNumMsgsSourced()
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.
Long getNumMsgsSourcedAsObject()
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.
void clearNumMsgsSourced()
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.
setNumMsgsSourced(long)boolean hasNumMsgsSourced()
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.
getNumMsgsSourced()void setNumMsgsFiltered(long val)
val - The value to set.void setNumMsgsFilteredAsObject(Long val)
val - The value to set.long getNumMsgsFiltered()
Long getNumMsgsFilteredAsObject()
void clearNumMsgsFiltered()
setNumMsgsFiltered(long)boolean hasNumMsgsFiltered()
getNumMsgsFiltered()void setMessageFactoryId(short val)
val - The value to set.void setMessageFactoryIdAsObject(Short val)
val - The value to set.short getMessageFactoryId()
Short getMessageFactoryIdAsObject()
void clearMessageFactoryId()
setMessageFactoryId(short)boolean hasMessageFactoryId()
getMessageFactoryId()void setMessageTypeId(short val)
val - The value to set.void setMessageTypeIdAsObject(Short val)
val - The value to set.short getMessageTypeId()
Short getMessageTypeIdAsObject()
void clearMessageTypeId()
setMessageTypeId(short)boolean hasMessageTypeId()
getMessageTypeId()void setMsgProcessingLatencies(SrvMonIntSeries val)
val - The value to set.void lendMsgProcessingLatencies(SrvMonIntSeries val)
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.
val - the value to 'lend' to lend.SrvMonIntSeries getMsgProcessingLatencies()
void getMsgProcessingLatenciesTo(SrvMonIntSeries val)
IF the value is not set, then the contents of the provided SrvMonIntSeries are cleared.
val - the value to copy intoSrvMonIntSeries.copyInto(SrvMonIntSeries)SrvMonIntSeries takeMsgProcessingLatencies()
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.
null if the field is not set.boolean hasMsgProcessingLatencies()
getMsgProcessingLatencies()void clearMsgProcessingLatencies()
void setMsgFilteringLatencies(SrvMonIntSeries val)
val - The value to set.void lendMsgFilteringLatencies(SrvMonIntSeries val)
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.
val - the value to 'lend' to lend.SrvMonIntSeries getMsgFilteringLatencies()
void getMsgFilteringLatenciesTo(SrvMonIntSeries val)
IF the value is not set, then the contents of the provided SrvMonIntSeries are cleared.
val - the value to copy intoSrvMonIntSeries.copyInto(SrvMonIntSeries)SrvMonIntSeries takeMsgFilteringLatencies()
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.
null if the field is not set.boolean hasMsgFilteringLatencies()
getMsgFilteringLatencies()void clearMsgFilteringLatencies()
void setMsgPreProcessingLatencies(SrvMonIntSeries val)
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:
val - The value to set.void lendMsgPreProcessingLatencies(SrvMonIntSeries val)
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:
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.
val - the value to 'lend' to lend.SrvMonIntSeries getMsgPreProcessingLatencies()
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:
void getMsgPreProcessingLatenciesTo(SrvMonIntSeries val)
IF the value is not set, then the contents of the provided SrvMonIntSeries are cleared.
val - the value to copy intoSrvMonIntSeries.copyInto(SrvMonIntSeries)SrvMonIntSeries takeMsgPreProcessingLatencies()
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:
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.
null if the field is not set.boolean hasMsgPreProcessingLatencies()
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:
getMsgPreProcessingLatencies()void clearMsgPreProcessingLatencies()
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:
void setMsgCreateToOfferLatencies(SrvMonIntSeries val)
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:
val - The value to set.void lendMsgCreateToOfferLatencies(SrvMonIntSeries val)
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:
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.
val - the value to 'lend' to lend.SrvMonIntSeries getMsgCreateToOfferLatencies()
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:
void getMsgCreateToOfferLatenciesTo(SrvMonIntSeries val)
IF the value is not set, then the contents of the provided SrvMonIntSeries are cleared.
val - the value to copy intoSrvMonIntSeries.copyInto(SrvMonIntSeries)SrvMonIntSeries takeMsgCreateToOfferLatencies()
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:
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.
null if the field is not set.boolean hasMsgCreateToOfferLatencies()
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:
getMsgCreateToOfferLatencies()void clearMsgCreateToOfferLatencies()
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:
void setMsgOfferToPollLatencies(SrvMonIntSeries val)
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.
val - The value to set.void lendMsgOfferToPollLatencies(SrvMonIntSeries val)
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.
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.
val - the value to 'lend' to lend.SrvMonIntSeries getMsgOfferToPollLatencies()
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.
void getMsgOfferToPollLatenciesTo(SrvMonIntSeries val)
IF the value is not set, then the contents of the provided SrvMonIntSeries are cleared.
val - the value to copy intoSrvMonIntSeries.copyInto(SrvMonIntSeries)SrvMonIntSeries takeMsgOfferToPollLatencies()
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.
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.
null if the field is not set.boolean hasMsgOfferToPollLatencies()
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.
getMsgOfferToPollLatencies()void clearMsgOfferToPollLatencies()
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.
void setMessageTypeName(String val)
val - The value to set.String getMessageTypeName()
void lendMessageTypeName(XString val)
This 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.
val - The value to set.IllegalArgumentException - If the value is mutable.void setMessageTypeNameFrom(long val)
NOTE:
This is the same as calling setMessageTypeName(String).
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
<T extends XString> T getMessageTypeNameTo(XString.Factory<T> factory)
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;
factory - The factory from which to get the XString to copy into and returnnull.NullPointerException - if the provided factory is nullvoid setMessageTypeNameFrom(XString val)
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than setMessageTypeName(String)
because it avoids encoding the value into a String if the given XString is already encoded.
void getMessageTypeNameTo(XString val)
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than getMessageTypeName() bec
because it can avoid decoding the value into an String.
getMessageTypeName()XString getMessageTypeNameUnsafe()
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.
getMessageTypeName()void clearMessageTypeName()
setMessageTypeName(String)boolean hasMessageTypeName()
getMessageTypeName()Copyright © 2019 Neeve Research, LLC. All Rights Reserved.