com.neeve.server.mon
Interface ISrvMonAppEngineStats

All Superinterfaces:

IRogValidatable

All Known Implementing Classes:

SrvMonAppEngineStats

@Generated(value="com.neeve.adm.AdmGenerator",
           date="Wed Mar 28 10:54:31 EDT 2018")
@AdmGenerated(compatLevel="3.8.0",
              admVersion="nvx-adm v3.7.265 (build 0)",
              date="3/28/18 10:54 AM",
              buildInfo="nvx-talon-3.7.265 (nvx-codegen-plugin)")
public interface ISrvMonAppEngineStats
extends IRogValidatable

Holds stats for an application's AepEngine.

Method Summary

void	addMsgTypeStats(SrvMonMsgTypeStats val) Adds the provided value to the list of 'msgTypeStats' values.
void	clearBackupOutboundLogQueueSize() Clears the value of 'backupOutboundLogQueueSize' Field Description Number of messages in backup outbound loq queue The backup log queue holds messages that have not been stabilized and are pending for write to an outbound message logger.
void	clearBackupOutboundQueueSize() Clears the value of 'backupOutboundQueueSize' Field Description Number of messages in backup outbound queue The backup outbound queue holds messages that have not been stabilized and will be restransmitted in the event that an engine becomes the Primary cluster member.
void	clearCommitEpilogueLatencies() Clears the value of 'commitEpilogueLatencies' Field Description Time spent from the point the store or send commit completes, whichever is last, to commit completion (aka 'cepilo').
void	clearCommitFullLatencies() Clears the value of 'commitFullLatencies' Field Description Time spent from the time the first message of a transaction is received to commit completion (aka 'cfull').
void	clearCommitPrologueLatencies() Clears the value of 'commitPrologueLatencies' Field Description Time spent from the point where transaction commit is started to send or store commit whichever is first (aka 'cprolo').
void	clearCommitSendLatencies() Clears the value of 'commitSendLatencies' Field Description Time spent for send commits to complete i.e. time from when send commit is initiated to receipt of send completion event (aka 'csend').
void	clearCommitStartLatencies() Clears the value of 'commitStartLatencies' Field Description Time spent from the point the first message of a transaction is received to the time the transaction is committed (aka 'cstart').
void	clearCommitStoreLatencies() Clears the value of 'commitStoreLatencies' Field Description Time spent in store commit i.e. time from when store commit is initiated to receipt of store completion event (aka 'cstore').
void	clearCommitTransactionLatencies() Deprecated. - This field should not be used (it was a meant to be commitTransitionLatencies which should be used instead).
void	clearCommitTransitionLatencies() Clears the value of 'commitTransitionLatencies' Field Description Time spent from the point the store or send commit completes, whichever is first to the start of next stage - send or commit (aka 'ctrans').
void	clearInAckLatencies() Clears the value of 'inAckLatencies' Field Description Records latencies for receipt of a message to stabilization (and upstream acknowledgement for Guaranteed) (aka 'inack').
void	clearInboundMessageLoggerStats() Clears the value of 'inboundMessageLoggerStats' Field Description Inbound message logger stats for applications with inbound message logging enabled.
void	clearInOutLatencies() Clears the value of 'inOutLatencies' Field Description Records latencies for receipt of a message to transmission of the last outbound message (aka 'inout').
void	clearMsgFilteringLatencies() Clears the value of 'msgFilteringLatencies' Field Description Records latencies for application message filtering times (by a message filter) (aka 'mfilt').
void	clearMsgPreProcLatencies() Clears the value of 'msgPreProcLatencies' Field Description Records the time (in microseconds) spent by the engine dispatching the message to an application (aka 'mpproc').
void	clearMsgProcessingLatencies() Clears the value of 'msgProcessingLatencies' Field Description Records latencies for application message process times (in an EventHandler) (aka 'mproc').
void	clearMsgSendCoreLatencies() Clears the value of 'msgSendCoreLatencies' Field Description Time spent in AepEngine.sendMessageCore() (aka 'msendc')
void	clearMsgSendLatencies() Clears the value of 'msgSendLatencies' Field Description Time spent in AepEngine.sendMessage() (aka 'msend').
void	clearMsgTypeStats() Clears the value of 'msgTypeStats' Field Description Per message type stats (when enabled and included in heartbeats) Per message type stats are included in heartbeats only when the XVM is configured to include them, they are collected for the application, and there was activity for the message type in the collection interval.
void	clearNumCommitsCompleted() Clears the value of 'numCommitsCompleted' Field Description The number of transaction commits completed by the engine.
void	clearNumCommitsStarted() Clears the value of 'numCommitsStarted' Field Description The number of transaction commits started by the engine.
void	clearNumDupMsgsRcvd() Clears the value of 'numDupMsgsRcvd' Field Description The number of duplicate messages the application has received.
void	clearNumEventsProcessed() Clears the value of 'numEventsProcessed' Field Description The number of events processed by the engine
void	clearNumEventsRcvd() Clears the value of 'numEventsRcvd' Field Description The number of events received by the engine
void	clearNumFlowEventsProcComplete() Clears the value of 'numFlowEventsProcComplete' Field Description The number of flow related events that have completely processed by the engine
void	clearNumFlowEventsProcFail() Clears the value of 'numFlowEventsProcFail' Field Description The number of flow related events unsuccessfully processed by the engine
void	clearNumFlowEventsProcSuccess() Clears the value of 'numFlowEventsProcSuccess' Field Description The number of flow related events successfully processed by the engine
void	clearNumFlowEventsRcvd() Clears the value of 'numFlowEventsRcvd' Field Description The number of flow related events processed by the engine
void	clearNumFlows() Clears the value of 'numFlows' Field Description The number of active flows in the application.
void	clearNumMsgsFiltered() Clears the value of 'numMsgsFiltered' Field Description The number of messages that were filtered.
void	clearNumMsgsRcvdBestEffort() Clears the value of 'numMsgsRcvdBestEffort' Field Description The number of best effort messages the application has received.
void	clearNumMsgsRcvdGuaranteed() Clears the value of 'numMsgsRcvdGuaranteed' Field Description The number of guaranteed messages the application has received.
void	clearNumMsgsResent() Clears the value of 'numMsgsResent' Field Description The number of messages the application has retransmitted.
void	clearNumMsgsSentBestEffort() Clears the value of 'numMsgsSentBestEffort' Field Description The number of best effort messages sent by the application.
void	clearNumMsgsSentGuaranteed() Clears the value of 'numMsgsSentGuaranteed' Field Description The number of guaranteed messages sent by the application.
void	clearNumMsgsSourced() Clears the value of 'numMsgsSourced' Field Description The number of messages that were sourced.
void	clearNumPartialRollbacks() Clears the value of 'numPartialRollbacks' Field Description The number of partial (savepoint) transaction rollback that have been initiated.
void	clearNumRollbacks() Clears the value of 'numRollbacks' Field Description The number of transactions that have been rolled back.
void	clearNumSendCommitsCompleted() Clears the value of 'numSendCommitsCompleted' Field Description The number of send (message bus) commits completed by the engine.
void	clearNumSendCommitsStarted() Clears the value of 'numSendCommitsStarted' Field Description The number of send (message bus) commits started by the engine.
void	clearNumStoreCommitsCompleted() Clears the value of 'numStoreCommitsCompleted' Field Description The number of store commits completed by the engine.
void	clearNumStoreCommitsStarted() Clears the value of 'numStoreCommitsStarted' Field Description The number of store commits started by the engine.
void	clearNumTransactions() Clears the value of 'numTransactions' Field Description The number of transactions created by the engine.
void	clearOutboundMessageLoggerStats() Clears the value of 'outboundMessageLoggerStats' Field Description Outbound message logger stats for applications with outbound message logging enabled.
void	clearOutboundSno() Clears the value of 'outboundSno' Field Description The current outbound sequence number for the engine.
void	clearOutboundStableSno() Clears the value of 'outboundStableSno' Field Description The current stable outbound sequence number for the engine.
void	clearSendCommitCompletionQueueSize() Clears the value of 'sendCommitCompletionQueueSize' Field Description The number of send commits pending completion.
void	clearStoreCommitCompletionQueueSize() Clears the value of 'storeCommitCompletionQueueSize' Field Description The number of store commits pending completion for the engine.
void	clearTransactionLeg1ProcessingTimes() Clears the value of 'transactionLeg1ProcessingTimes' Field Description Records latencies for the first transaction processing leg.
void	clearTransactionLeg2ProcessingTimes() Clears the value of 'transactionLeg2ProcessingTimes' Field Description Records latencies for the second transaction processing leg.
void	clearTransactionLeg3ProcessingTimes() Clears the value of 'transactionLeg3ProcessingTimes' Field Description Transaction Leg Three includes time spent from the point where the store/store commit completion is received to the completion of the transaction commit (aka 'tleg3') .
long	getBackupOutboundLogQueueSize() Gets the value of 'backupOutboundLogQueueSize' Field Description Number of messages in backup outbound loq queue The backup log queue holds messages that have not been stabilized and are pending for write to an outbound message logger.
long	getBackupOutboundQueueSize() Gets the value of 'backupOutboundQueueSize' Field Description Number of messages in backup outbound queue The backup outbound queue holds messages that have not been stabilized and will be restransmitted in the event that an engine becomes the Primary cluster member.
SrvMonIntSeries	getCommitEpilogueLatencies() Gets the value of 'commitEpilogueLatencies' Field Description Time spent from the point the store or send commit completes, whichever is last, to commit completion (aka 'cepilo').
void	getCommitEpilogueLatenciesTo(SrvMonIntSeries val) Copies the value of SrvMonIntSeries into the provided value.
SrvMonIntSeries	getCommitFullLatencies() Gets the value of 'commitFullLatencies' Field Description Time spent from the time the first message of a transaction is received to commit completion (aka 'cfull').
void	getCommitFullLatenciesTo(SrvMonIntSeries val) Copies the value of SrvMonIntSeries into the provided value.
SrvMonIntSeries	getCommitPrologueLatencies() Gets the value of 'commitPrologueLatencies' Field Description Time spent from the point where transaction commit is started to send or store commit whichever is first (aka 'cprolo').
void	getCommitPrologueLatenciesTo(SrvMonIntSeries val) Copies the value of SrvMonIntSeries into the provided value.
SrvMonIntSeries	getCommitSendLatencies() Gets the value of 'commitSendLatencies' Field Description Time spent for send commits to complete i.e. time from when send commit is initiated to receipt of send completion event (aka 'csend').
void	getCommitSendLatenciesTo(SrvMonIntSeries val) Copies the value of SrvMonIntSeries into the provided value.
SrvMonIntSeries	getCommitStartLatencies() Gets the value of 'commitStartLatencies' Field Description Time spent from the point the first message of a transaction is received to the time the transaction is committed (aka 'cstart').
void	getCommitStartLatenciesTo(SrvMonIntSeries val) Copies the value of SrvMonIntSeries into the provided value.
SrvMonIntSeries	getCommitStoreLatencies() Gets the value of 'commitStoreLatencies' Field Description Time spent in store commit i.e. time from when store commit is initiated to receipt of store completion event (aka 'cstore').
void	getCommitStoreLatenciesTo(SrvMonIntSeries val) Copies the value of SrvMonIntSeries into the provided value.
SrvMonIntSeries	getCommitTransactionLatencies() Deprecated. - This field should not be used (it was a meant to be commitTransitionLatencies which should be used instead).
void	getCommitTransactionLatenciesTo(SrvMonIntSeries val) Deprecated. - This field should not be used (it was a meant to be commitTransitionLatencies which should be used instead).
SrvMonIntSeries	getCommitTransitionLatencies() Gets the value of 'commitTransitionLatencies' Field Description Time spent from the point the store or send commit completes, whichever is first to the start of next stage - send or commit (aka 'ctrans').
void	getCommitTransitionLatenciesTo(SrvMonIntSeries val) Copies the value of SrvMonIntSeries into the provided value.
SrvMonIntSeries	getInAckLatencies() Gets the value of 'inAckLatencies' Field Description Records latencies for receipt of a message to stabilization (and upstream acknowledgement for Guaranteed) (aka 'inack').
void	getInAckLatenciesTo(SrvMonIntSeries val) Copies the value of SrvMonIntSeries into the provided value.
SrvMonAppMessageLoggerStats	getInboundMessageLoggerStats() Gets the value of 'inboundMessageLoggerStats' Field Description Inbound message logger stats for applications with inbound message logging enabled.
void	getInboundMessageLoggerStatsTo(SrvMonAppMessageLoggerStats val) Copies the value of SrvMonAppMessageLoggerStats into the provided value.
SrvMonIntSeries	getInOutLatencies() Gets the value of 'inOutLatencies' Field Description Records latencies for receipt of a message to transmission of the last outbound message (aka 'inout').
void	getInOutLatenciesTo(SrvMonIntSeries val) Copies the value of SrvMonIntSeries into the provided value.
SrvMonIntSeries	getMsgFilteringLatencies() Gets the value of 'msgFilteringLatencies' Field Description Records latencies for application message filtering times (by a message filter) (aka 'mfilt').
void	getMsgFilteringLatenciesTo(SrvMonIntSeries val) Copies the value of SrvMonIntSeries into the provided value.
SrvMonIntSeries	getMsgPreProcLatencies() Gets the value of 'msgPreProcLatencies' Field Description Records the time (in microseconds) spent by the engine dispatching the message to an application (aka 'mpproc').
void	getMsgPreProcLatenciesTo(SrvMonIntSeries val) Copies the value of SrvMonIntSeries into the provided value.
SrvMonIntSeries	getMsgProcessingLatencies() Gets the value of 'msgProcessingLatencies' Field Description Records latencies for application message process times (in an EventHandler) (aka 'mproc').
void	getMsgProcessingLatenciesTo(SrvMonIntSeries val) Copies the value of SrvMonIntSeries into the provided value.
SrvMonIntSeries	getMsgSendCoreLatencies() Gets the value of 'msgSendCoreLatencies' Field Description Time spent in AepEngine.sendMessageCore() (aka 'msendc')
void	getMsgSendCoreLatenciesTo(SrvMonIntSeries val) Copies the value of SrvMonIntSeries into the provided value.
SrvMonIntSeries	getMsgSendLatencies() Gets the value of 'msgSendLatencies' Field Description Time spent in AepEngine.sendMessage() (aka 'msend').
void	getMsgSendLatenciesTo(SrvMonIntSeries val) Copies the value of SrvMonIntSeries into the provided value.
SrvMonMsgTypeStats[]	getMsgTypeStats() Gets the value of 'msgTypeStats' If the field is not set this method will return null.
SrvMonMsgTypeStats[]	getMsgTypeStatsEmptyIfNull() Gets the value of 'msgTypeStats' or an empty array if the value is null or not set.
XIterator<SrvMonMsgTypeStats>	getMsgTypeStatsIterator() Gets the value of 'msgTypeStats' as iterator of values.
long	getNumCommitsCompleted() Gets the value of 'numCommitsCompleted' Field Description The number of transaction commits completed by the engine.
long	getNumCommitsStarted() Gets the value of 'numCommitsStarted' Field Description The number of transaction commits started by the engine.
long	getNumDupMsgsRcvd() Gets the value of 'numDupMsgsRcvd' Field Description The number of duplicate messages the application has received.
long	getNumEventsProcessed() Gets the value of 'numEventsProcessed' Field Description The number of events processed by the engine
long	getNumEventsRcvd() Gets the value of 'numEventsRcvd' Field Description The number of events received by the engine
long	getNumFlowEventsProcComplete() Gets the value of 'numFlowEventsProcComplete' Field Description The number of flow related events that have completely processed by the engine
long	getNumFlowEventsProcFail() Gets the value of 'numFlowEventsProcFail' Field Description The number of flow related events unsuccessfully processed by the engine
long	getNumFlowEventsProcSuccess() Gets the value of 'numFlowEventsProcSuccess' Field Description The number of flow related events successfully processed by the engine
long	getNumFlowEventsRcvd() Gets the value of 'numFlowEventsRcvd' Field Description The number of flow related events processed by the engine
int	getNumFlows() Gets the value of 'numFlows' Field Description The number of active flows in the application.
long	getNumMsgsFiltered() Gets the value of 'numMsgsFiltered' Field Description The number of messages that were filtered.
long	getNumMsgsRcvdBestEffort() Gets the value of 'numMsgsRcvdBestEffort' Field Description The number of best effort messages the application has received.
long	getNumMsgsRcvdGuaranteed() Gets the value of 'numMsgsRcvdGuaranteed' Field Description The number of guaranteed messages the application has received.
long	getNumMsgsResent() Gets the value of 'numMsgsResent' Field Description The number of messages the application has retransmitted.
long	getNumMsgsSentBestEffort() Gets the value of 'numMsgsSentBestEffort' Field Description The number of best effort messages sent by the application.
long	getNumMsgsSentGuaranteed() Gets the value of 'numMsgsSentGuaranteed' Field Description The number of guaranteed messages sent by the application.
long	getNumMsgsSourced() Gets the value of 'numMsgsSourced' Field Description The number of messages that were sourced.
long	getNumPartialRollbacks() Gets the value of 'numPartialRollbacks' Field Description The number of partial (savepoint) transaction rollback that have been initiated.
long	getNumRollbacks() Gets the value of 'numRollbacks' Field Description The number of transactions that have been rolled back.
long	getNumSendCommitsCompleted() Gets the value of 'numSendCommitsCompleted' Field Description The number of send (message bus) commits completed by the engine.
long	getNumSendCommitsStarted() Gets the value of 'numSendCommitsStarted' Field Description The number of send (message bus) commits started by the engine.
long	getNumStoreCommitsCompleted() Gets the value of 'numStoreCommitsCompleted' Field Description The number of store commits completed by the engine.
long	getNumStoreCommitsStarted() Gets the value of 'numStoreCommitsStarted' Field Description The number of store commits started by the engine.
long	getNumTransactions() Gets the value of 'numTransactions' Field Description The number of transactions created by the engine.
SrvMonAppMessageLoggerStats	getOutboundMessageLoggerStats() Gets the value of 'outboundMessageLoggerStats' Field Description Outbound message logger stats for applications with outbound message logging enabled.
void	getOutboundMessageLoggerStatsTo(SrvMonAppMessageLoggerStats val) Copies the value of SrvMonAppMessageLoggerStats into the provided value.
long	getOutboundSno() Gets the value of 'outboundSno' Field Description The current outbound sequence number for the engine.
long	getOutboundStableSno() Gets the value of 'outboundStableSno' Field Description The current stable outbound sequence number for the engine.
int	getSendCommitCompletionQueueSize() Gets the value of 'sendCommitCompletionQueueSize' Field Description The number of send commits pending completion.
int	getStoreCommitCompletionQueueSize() Gets the value of 'storeCommitCompletionQueueSize' Field Description The number of store commits pending completion for the engine.
SrvMonIntSeries	getTransactionLeg1ProcessingTimes() Gets the value of 'transactionLeg1ProcessingTimes' Field Description Records latencies for the first transaction processing leg.
void	getTransactionLeg1ProcessingTimesTo(SrvMonIntSeries val) Copies the value of SrvMonIntSeries into the provided value.
SrvMonIntSeries	getTransactionLeg2ProcessingTimes() Gets the value of 'transactionLeg2ProcessingTimes' Field Description Records latencies for the second transaction processing leg.
void	getTransactionLeg2ProcessingTimesTo(SrvMonIntSeries val) Copies the value of SrvMonIntSeries into the provided value.
SrvMonIntSeries	getTransactionLeg3ProcessingTimes() Gets the value of 'transactionLeg3ProcessingTimes' Field Description Transaction Leg Three includes time spent from the point where the store/store commit completion is received to the completion of the transaction commit (aka 'tleg3') .
void	getTransactionLeg3ProcessingTimesTo(SrvMonIntSeries val) Copies the value of SrvMonIntSeries into the provided value.
boolean	hasBackupOutboundLogQueueSize() Checks for the presence of 'backupOutboundLogQueueSize' Field Description Number of messages in backup outbound loq queue The backup log queue holds messages that have not been stabilized and are pending for write to an outbound message logger.
boolean	hasBackupOutboundQueueSize() Checks for the presence of 'backupOutboundQueueSize' Field Description Number of messages in backup outbound queue The backup outbound queue holds messages that have not been stabilized and will be restransmitted in the event that an engine becomes the Primary cluster member.
boolean	hasCommitEpilogueLatencies() Checks for the presence of 'commitEpilogueLatencies' Field Description Time spent from the point the store or send commit completes, whichever is last, to commit completion (aka 'cepilo').
boolean	hasCommitFullLatencies() Checks for the presence of 'commitFullLatencies' Field Description Time spent from the time the first message of a transaction is received to commit completion (aka 'cfull').
boolean	hasCommitPrologueLatencies() Checks for the presence of 'commitPrologueLatencies' Field Description Time spent from the point where transaction commit is started to send or store commit whichever is first (aka 'cprolo').
boolean	hasCommitSendLatencies() Checks for the presence of 'commitSendLatencies' Field Description Time spent for send commits to complete i.e. time from when send commit is initiated to receipt of send completion event (aka 'csend').
boolean	hasCommitStartLatencies() Checks for the presence of 'commitStartLatencies' Field Description Time spent from the point the first message of a transaction is received to the time the transaction is committed (aka 'cstart').
boolean	hasCommitStoreLatencies() Checks for the presence of 'commitStoreLatencies' Field Description Time spent in store commit i.e. time from when store commit is initiated to receipt of store completion event (aka 'cstore').
boolean	hasCommitTransactionLatencies() Deprecated. - This field should not be used (it was a meant to be commitTransitionLatencies which should be used instead).
boolean	hasCommitTransitionLatencies() Checks for the presence of 'commitTransitionLatencies' Field Description Time spent from the point the store or send commit completes, whichever is first to the start of next stage - send or commit (aka 'ctrans').
boolean	hasInAckLatencies() Checks for the presence of 'inAckLatencies' Field Description Records latencies for receipt of a message to stabilization (and upstream acknowledgement for Guaranteed) (aka 'inack').
boolean	hasInboundMessageLoggerStats() Checks for the presence of 'inboundMessageLoggerStats' Field Description Inbound message logger stats for applications with inbound message logging enabled.
boolean	hasInOutLatencies() Checks for the presence of 'inOutLatencies' Field Description Records latencies for receipt of a message to transmission of the last outbound message (aka 'inout').
boolean	hasMsgFilteringLatencies() Checks for the presence of 'msgFilteringLatencies' Field Description Records latencies for application message filtering times (by a message filter) (aka 'mfilt').
boolean	hasMsgPreProcLatencies() Checks for the presence of 'msgPreProcLatencies' Field Description Records the time (in microseconds) spent by the engine dispatching the message to an application (aka 'mpproc').
boolean	hasMsgProcessingLatencies() Checks for the presence of 'msgProcessingLatencies' Field Description Records latencies for application message process times (in an EventHandler) (aka 'mproc').
boolean	hasMsgSendCoreLatencies() Checks for the presence of 'msgSendCoreLatencies' Field Description Time spent in AepEngine.sendMessageCore() (aka 'msendc')
boolean	hasMsgSendLatencies() Checks for the presence of 'msgSendLatencies' Field Description Time spent in AepEngine.sendMessage() (aka 'msend').
boolean	hasNumCommitsCompleted() Checks for the presence of 'numCommitsCompleted' Field Description The number of transaction commits completed by the engine.
boolean	hasNumCommitsStarted() Checks for the presence of 'numCommitsStarted' Field Description The number of transaction commits started by the engine.
boolean	hasNumDupMsgsRcvd() Checks for the presence of 'numDupMsgsRcvd' Field Description The number of duplicate messages the application has received.
boolean	hasNumEventsProcessed() Checks for the presence of 'numEventsProcessed' Field Description The number of events processed by the engine
boolean	hasNumEventsRcvd() Checks for the presence of 'numEventsRcvd' Field Description The number of events received by the engine
boolean	hasNumFlowEventsProcComplete() Checks for the presence of 'numFlowEventsProcComplete' Field Description The number of flow related events that have completely processed by the engine
boolean	hasNumFlowEventsProcFail() Checks for the presence of 'numFlowEventsProcFail' Field Description The number of flow related events unsuccessfully processed by the engine
boolean	hasNumFlowEventsProcSuccess() Checks for the presence of 'numFlowEventsProcSuccess' Field Description The number of flow related events successfully processed by the engine
boolean	hasNumFlowEventsRcvd() Checks for the presence of 'numFlowEventsRcvd' Field Description The number of flow related events processed by the engine
boolean	hasNumFlows() Checks for the presence of 'numFlows' Field Description The number of active flows in the application.
boolean	hasNumMsgsFiltered() Checks for the presence of 'numMsgsFiltered' Field Description The number of messages that were filtered.
boolean	hasNumMsgsRcvdBestEffort() Checks for the presence of 'numMsgsRcvdBestEffort' Field Description The number of best effort messages the application has received.
boolean	hasNumMsgsRcvdGuaranteed() Checks for the presence of 'numMsgsRcvdGuaranteed' Field Description The number of guaranteed messages the application has received.
boolean	hasNumMsgsResent() Checks for the presence of 'numMsgsResent' Field Description The number of messages the application has retransmitted.
boolean	hasNumMsgsSentBestEffort() Checks for the presence of 'numMsgsSentBestEffort' Field Description The number of best effort messages sent by the application.
boolean	hasNumMsgsSentGuaranteed() Checks for the presence of 'numMsgsSentGuaranteed' Field Description The number of guaranteed messages sent by the application.
boolean	hasNumMsgsSourced() Checks for the presence of 'numMsgsSourced' Field Description The number of messages that were sourced.
boolean	hasNumPartialRollbacks() Checks for the presence of 'numPartialRollbacks' Field Description The number of partial (savepoint) transaction rollback that have been initiated.
boolean	hasNumRollbacks() Checks for the presence of 'numRollbacks' Field Description The number of transactions that have been rolled back.
boolean	hasNumSendCommitsCompleted() Checks for the presence of 'numSendCommitsCompleted' Field Description The number of send (message bus) commits completed by the engine.
boolean	hasNumSendCommitsStarted() Checks for the presence of 'numSendCommitsStarted' Field Description The number of send (message bus) commits started by the engine.
boolean	hasNumStoreCommitsCompleted() Checks for the presence of 'numStoreCommitsCompleted' Field Description The number of store commits completed by the engine.
boolean	hasNumStoreCommitsStarted() Checks for the presence of 'numStoreCommitsStarted' Field Description The number of store commits started by the engine.
boolean	hasNumTransactions() Checks for the presence of 'numTransactions' Field Description The number of transactions created by the engine.
boolean	hasOutboundMessageLoggerStats() Checks for the presence of 'outboundMessageLoggerStats' Field Description Outbound message logger stats for applications with outbound message logging enabled.
boolean	hasOutboundSno() Checks for the presence of 'outboundSno' Field Description The current outbound sequence number for the engine.
boolean	hasOutboundStableSno() Checks for the presence of 'outboundStableSno' Field Description The current stable outbound sequence number for the engine.
boolean	hasSendCommitCompletionQueueSize() Checks for the presence of 'sendCommitCompletionQueueSize' Field Description The number of send commits pending completion.
boolean	hasStoreCommitCompletionQueueSize() Checks for the presence of 'storeCommitCompletionQueueSize' Field Description The number of store commits pending completion for the engine.
boolean	hasTransactionLeg1ProcessingTimes() Checks for the presence of 'transactionLeg1ProcessingTimes' Field Description Records latencies for the first transaction processing leg.
boolean	hasTransactionLeg2ProcessingTimes() Checks for the presence of 'transactionLeg2ProcessingTimes' Field Description Records latencies for the second transaction processing leg.
boolean	hasTransactionLeg3ProcessingTimes() Checks for the presence of 'transactionLeg3ProcessingTimes' Field Description Transaction Leg Three includes time spent from the point where the store/store commit completion is received to the completion of the transaction commit (aka 'tleg3') .
void	lendCommitEpilogueLatencies(SrvMonIntSeries val) 'Lends' a reference of the SrvMonIntSeries to the message for this field.
void	lendCommitFullLatencies(SrvMonIntSeries val) 'Lends' a reference of the SrvMonIntSeries to the message for this field.
void	lendCommitPrologueLatencies(SrvMonIntSeries val) 'Lends' a reference of the SrvMonIntSeries to the message for this field.
void	lendCommitSendLatencies(SrvMonIntSeries val) 'Lends' a reference of the SrvMonIntSeries to the message for this field.
void	lendCommitStartLatencies(SrvMonIntSeries val) 'Lends' a reference of the SrvMonIntSeries to the message for this field.
void	lendCommitStoreLatencies(SrvMonIntSeries val) 'Lends' a reference of the SrvMonIntSeries to the message for this field.
void	lendCommitTransactionLatencies(SrvMonIntSeries val) Deprecated. - This field should not be used (it was a meant to be commitTransitionLatencies which should be used instead).
void	lendCommitTransitionLatencies(SrvMonIntSeries val) 'Lends' a reference of the SrvMonIntSeries to the message for this field.
void	lendInAckLatencies(SrvMonIntSeries val) 'Lends' a reference of the SrvMonIntSeries to the message for this field.
void	lendInboundMessageLoggerStats(SrvMonAppMessageLoggerStats val) 'Lends' a reference of the SrvMonAppMessageLoggerStats to the message for this field.
void	lendInOutLatencies(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	lendMsgPreProcLatencies(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	lendMsgSendCoreLatencies(SrvMonIntSeries val) 'Lends' a reference of the SrvMonIntSeries to the message for this field.
void	lendMsgSendLatencies(SrvMonIntSeries val) 'Lends' a reference of the SrvMonIntSeries to the message for this field.
void	lendMsgTypeStats(SrvMonMsgTypeStats val) Adds the provided value to the list of 'msgTypeStats' values and acquires a reference to it.
void	lendMsgTypeStats(SrvMonMsgTypeStats[] val) Lends the value of 'msgTypeStats' Field Description Per message type stats (when enabled and included in heartbeats) Per message type stats are included in heartbeats only when the XVM is configured to include them, they are collected for the application, and there was activity for the message type in the collection interval.
void	lendMsgTypeStatsFrom(XIterator<SrvMonMsgTypeStats> val) Sets the value of 'msgTypeStats' by lending the values from the provided iterator.
void	lendOutboundMessageLoggerStats(SrvMonAppMessageLoggerStats val) 'Lends' a reference of the SrvMonAppMessageLoggerStats to the message for this field.
void	lendTransactionLeg1ProcessingTimes(SrvMonIntSeries val) 'Lends' a reference of the SrvMonIntSeries to the message for this field.
void	lendTransactionLeg2ProcessingTimes(SrvMonIntSeries val) 'Lends' a reference of the SrvMonIntSeries to the message for this field.
void	lendTransactionLeg3ProcessingTimes(SrvMonIntSeries val) 'Lends' a reference of the SrvMonIntSeries to the message for this field.
void	setBackupOutboundLogQueueSize(long val) Sets the value of 'backupOutboundLogQueueSize' Field Description Number of messages in backup outbound loq queue The backup log queue holds messages that have not been stabilized and are pending for write to an outbound message logger.
void	setBackupOutboundQueueSize(long val) Sets the value of 'backupOutboundQueueSize' Field Description Number of messages in backup outbound queue The backup outbound queue holds messages that have not been stabilized and will be restransmitted in the event that an engine becomes the Primary cluster member.
void	setCommitEpilogueLatencies(SrvMonIntSeries val) Sets the value of 'commitEpilogueLatencies' Field Description Time spent from the point the store or send commit completes, whichever is last, to commit completion (aka 'cepilo').
void	setCommitFullLatencies(SrvMonIntSeries val) Sets the value of 'commitFullLatencies' Field Description Time spent from the time the first message of a transaction is received to commit completion (aka 'cfull').
void	setCommitPrologueLatencies(SrvMonIntSeries val) Sets the value of 'commitPrologueLatencies' Field Description Time spent from the point where transaction commit is started to send or store commit whichever is first (aka 'cprolo').
void	setCommitSendLatencies(SrvMonIntSeries val) Sets the value of 'commitSendLatencies' Field Description Time spent for send commits to complete i.e. time from when send commit is initiated to receipt of send completion event (aka 'csend').
void	setCommitStartLatencies(SrvMonIntSeries val) Sets the value of 'commitStartLatencies' Field Description Time spent from the point the first message of a transaction is received to the time the transaction is committed (aka 'cstart').
void	setCommitStoreLatencies(SrvMonIntSeries val) Sets the value of 'commitStoreLatencies' Field Description Time spent in store commit i.e. time from when store commit is initiated to receipt of store completion event (aka 'cstore').
void	setCommitTransactionLatencies(SrvMonIntSeries val) Deprecated. - This field should not be used (it was a meant to be commitTransitionLatencies which should be used instead).
void	setCommitTransitionLatencies(SrvMonIntSeries val) Sets the value of 'commitTransitionLatencies' Field Description Time spent from the point the store or send commit completes, whichever is first to the start of next stage - send or commit (aka 'ctrans').
void	setInAckLatencies(SrvMonIntSeries val) Sets the value of 'inAckLatencies' Field Description Records latencies for receipt of a message to stabilization (and upstream acknowledgement for Guaranteed) (aka 'inack').
void	setInboundMessageLoggerStats(SrvMonAppMessageLoggerStats val) Sets the value of 'inboundMessageLoggerStats' Field Description Inbound message logger stats for applications with inbound message logging enabled.
void	setInOutLatencies(SrvMonIntSeries val) Sets the value of 'inOutLatencies' Field Description Records latencies for receipt of a message to transmission of the last outbound message (aka 'inout').
void	setMsgFilteringLatencies(SrvMonIntSeries val) Sets the value of 'msgFilteringLatencies' Field Description Records latencies for application message filtering times (by a message filter) (aka 'mfilt').
void	setMsgPreProcLatencies(SrvMonIntSeries val) Sets the value of 'msgPreProcLatencies' Field Description Records the time (in microseconds) spent by the engine dispatching the message to an application (aka 'mpproc').
void	setMsgProcessingLatencies(SrvMonIntSeries val) Sets the value of 'msgProcessingLatencies' Field Description Records latencies for application message process times (in an EventHandler) (aka 'mproc').
void	setMsgSendCoreLatencies(SrvMonIntSeries val) Sets the value of 'msgSendCoreLatencies' Field Description Time spent in AepEngine.sendMessageCore() (aka 'msendc')
void	setMsgSendLatencies(SrvMonIntSeries val) Sets the value of 'msgSendLatencies' Field Description Time spent in AepEngine.sendMessage() (aka 'msend').
void	setMsgTypeStats(SrvMonMsgTypeStats[] val) Sets the value of 'msgTypeStats' Field Description Per message type stats (when enabled and included in heartbeats) Per message type stats are included in heartbeats only when the XVM is configured to include them, they are collected for the application, and there was activity for the message type in the collection interval.
void	setMsgTypeStatsFrom(XIterator<SrvMonMsgTypeStats> val) Sets the value of 'msgTypeStats' using the values from the provided iterator.
void	setNumCommitsCompleted(long val) Sets the value of 'numCommitsCompleted' Field Description The number of transaction commits completed by the engine.
void	setNumCommitsStarted(long val) Sets the value of 'numCommitsStarted' Field Description The number of transaction commits started by the engine.
void	setNumDupMsgsRcvd(long val) Sets the value of 'numDupMsgsRcvd' Field Description The number of duplicate messages the application has received.
void	setNumEventsProcessed(long val) Sets the value of 'numEventsProcessed' Field Description The number of events processed by the engine
void	setNumEventsRcvd(long val) Sets the value of 'numEventsRcvd' Field Description The number of events received by the engine
void	setNumFlowEventsProcComplete(long val) Sets the value of 'numFlowEventsProcComplete' Field Description The number of flow related events that have completely processed by the engine
void	setNumFlowEventsProcFail(long val) Sets the value of 'numFlowEventsProcFail' Field Description The number of flow related events unsuccessfully processed by the engine
void	setNumFlowEventsProcSuccess(long val) Sets the value of 'numFlowEventsProcSuccess' Field Description The number of flow related events successfully processed by the engine
void	setNumFlowEventsRcvd(long val) Sets the value of 'numFlowEventsRcvd' Field Description The number of flow related events processed by the engine
void	setNumFlows(int val) Sets the value of 'numFlows' Field Description The number of active flows in the application.
void	setNumMsgsFiltered(long val) Sets the value of 'numMsgsFiltered' Field Description The number of messages that were filtered.
void	setNumMsgsRcvdBestEffort(long val) Sets the value of 'numMsgsRcvdBestEffort' Field Description The number of best effort messages the application has received.
void	setNumMsgsRcvdGuaranteed(long val) Sets the value of 'numMsgsRcvdGuaranteed' Field Description The number of guaranteed messages the application has received.
void	setNumMsgsResent(long val) Sets the value of 'numMsgsResent' Field Description The number of messages the application has retransmitted.
void	setNumMsgsSentBestEffort(long val) Sets the value of 'numMsgsSentBestEffort' Field Description The number of best effort messages sent by the application.
void	setNumMsgsSentGuaranteed(long val) Sets the value of 'numMsgsSentGuaranteed' Field Description The number of guaranteed messages sent by the application.
void	setNumMsgsSourced(long val) Sets the value of 'numMsgsSourced' Field Description The number of messages that were sourced.
void	setNumPartialRollbacks(long val) Sets the value of 'numPartialRollbacks' Field Description The number of partial (savepoint) transaction rollback that have been initiated.
void	setNumRollbacks(long val) Sets the value of 'numRollbacks' Field Description The number of transactions that have been rolled back.
void	setNumSendCommitsCompleted(long val) Sets the value of 'numSendCommitsCompleted' Field Description The number of send (message bus) commits completed by the engine.
void	setNumSendCommitsStarted(long val) Sets the value of 'numSendCommitsStarted' Field Description The number of send (message bus) commits started by the engine.
void	setNumStoreCommitsCompleted(long val) Sets the value of 'numStoreCommitsCompleted' Field Description The number of store commits completed by the engine.
void	setNumStoreCommitsStarted(long val) Sets the value of 'numStoreCommitsStarted' Field Description The number of store commits started by the engine.
void	setNumTransactions(long val) Sets the value of 'numTransactions' Field Description The number of transactions created by the engine.
void	setOutboundMessageLoggerStats(SrvMonAppMessageLoggerStats val) Sets the value of 'outboundMessageLoggerStats' Field Description Outbound message logger stats for applications with outbound message logging enabled.
void	setOutboundSno(long val) Sets the value of 'outboundSno' Field Description The current outbound sequence number for the engine.
void	setOutboundStableSno(long val) Sets the value of 'outboundStableSno' Field Description The current stable outbound sequence number for the engine.
void	setSendCommitCompletionQueueSize(int val) Sets the value of 'sendCommitCompletionQueueSize' Field Description The number of send commits pending completion.
void	setStoreCommitCompletionQueueSize(int val) Sets the value of 'storeCommitCompletionQueueSize' Field Description The number of store commits pending completion for the engine.
void	setTransactionLeg1ProcessingTimes(SrvMonIntSeries val) Sets the value of 'transactionLeg1ProcessingTimes' Field Description Records latencies for the first transaction processing leg.
void	setTransactionLeg2ProcessingTimes(SrvMonIntSeries val) Sets the value of 'transactionLeg2ProcessingTimes' Field Description Records latencies for the second transaction processing leg.
void	setTransactionLeg3ProcessingTimes(SrvMonIntSeries val) Sets the value of 'transactionLeg3ProcessingTimes' Field Description Transaction Leg Three includes time spent from the point where the store/store commit completion is received to the completion of the transaction commit (aka 'tleg3') .
SrvMonIntSeries	takeCommitEpilogueLatencies() 'Takes' a reference to the commitEpilogueLatencies field from the message.
SrvMonIntSeries	takeCommitFullLatencies() 'Takes' a reference to the commitFullLatencies field from the message.
SrvMonIntSeries	takeCommitPrologueLatencies() 'Takes' a reference to the commitPrologueLatencies field from the message.
SrvMonIntSeries	takeCommitSendLatencies() 'Takes' a reference to the commitSendLatencies field from the message.
SrvMonIntSeries	takeCommitStartLatencies() 'Takes' a reference to the commitStartLatencies field from the message.
SrvMonIntSeries	takeCommitStoreLatencies() 'Takes' a reference to the commitStoreLatencies field from the message.
SrvMonIntSeries	takeCommitTransactionLatencies() Deprecated. - This field should not be used (it was a meant to be commitTransitionLatencies which should be used instead).
SrvMonIntSeries	takeCommitTransitionLatencies() 'Takes' a reference to the commitTransitionLatencies field from the message.
SrvMonIntSeries	takeInAckLatencies() 'Takes' a reference to the inAckLatencies field from the message.
SrvMonAppMessageLoggerStats	takeInboundMessageLoggerStats() 'Takes' a reference to the inboundMessageLoggerStats field from the message.
SrvMonIntSeries	takeInOutLatencies() 'Takes' a reference to the inOutLatencies field from the message.
SrvMonIntSeries	takeMsgFilteringLatencies() 'Takes' a reference to the msgFilteringLatencies field from the message.
SrvMonIntSeries	takeMsgPreProcLatencies() 'Takes' a reference to the msgPreProcLatencies field from the message.
SrvMonIntSeries	takeMsgProcessingLatencies() 'Takes' a reference to the msgProcessingLatencies field from the message.
SrvMonIntSeries	takeMsgSendCoreLatencies() 'Takes' a reference to the msgSendCoreLatencies field from the message.
SrvMonIntSeries	takeMsgSendLatencies() 'Takes' a reference to the msgSendLatencies field from the message.
SrvMonMsgTypeStats[]	takeMsgTypeStats() Takes the value of 'msgTypeStats' Field Description Per message type stats (when enabled and included in heartbeats) Per message type stats are included in heartbeats only when the XVM is configured to include them, they are collected for the application, and there was activity for the message type in the collection interval.
SrvMonAppMessageLoggerStats	takeOutboundMessageLoggerStats() 'Takes' a reference to the outboundMessageLoggerStats field from the message.
SrvMonIntSeries	takeTransactionLeg1ProcessingTimes() 'Takes' a reference to the transactionLeg1ProcessingTimes field from the message.
SrvMonIntSeries	takeTransactionLeg2ProcessingTimes() 'Takes' a reference to the transactionLeg2ProcessingTimes field from the message.
SrvMonIntSeries	takeTransactionLeg3ProcessingTimes() 'Takes' a reference to the transactionLeg3ProcessingTimes field from the message.

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

setNumFlows

void setNumFlows(int val)

Sets the value of 'numFlows'

Field Description

The number of active flows in the application.

Parameters:

val - The value to set.

getNumFlows

int getNumFlows()

Gets the value of 'numFlows'

Field Description

The number of active flows in the application.

Returns:

The number of active flows in the application.

clearNumFlows

void clearNumFlows()

Clears the value of 'numFlows'

Field Description

The number of active flows in the application.

See Also:

setNumFlows(int)

hasNumFlows

boolean hasNumFlows()

Checks for the presence of 'numFlows'

Field Description

The number of active flows in the application.

See Also:

getNumFlows()

setNumMsgsRcvdBestEffort

void setNumMsgsRcvdBestEffort(long val)

Sets the value of 'numMsgsRcvdBestEffort'

Field Description

The number of best effort messages the application has received.

Parameters:

val - The value to set.

getNumMsgsRcvdBestEffort

long getNumMsgsRcvdBestEffort()

Gets the value of 'numMsgsRcvdBestEffort'

Field Description

The number of best effort messages the application has received.

Returns:

The number of best effort messages the application has received.

clearNumMsgsRcvdBestEffort

void clearNumMsgsRcvdBestEffort()

Clears the value of 'numMsgsRcvdBestEffort'

Field Description

The number of best effort messages the application has received.

See Also:

setNumMsgsRcvdBestEffort(long)

hasNumMsgsRcvdBestEffort

boolean hasNumMsgsRcvdBestEffort()

Checks for the presence of 'numMsgsRcvdBestEffort'

Field Description

The number of best effort messages the application has received.

See Also:

getNumMsgsRcvdBestEffort()

setNumMsgsRcvdGuaranteed

void setNumMsgsRcvdGuaranteed(long val)

Sets the value of 'numMsgsRcvdGuaranteed'

Field Description

The number of guaranteed messages the application has received.

Parameters:

val - The value to set.

getNumMsgsRcvdGuaranteed

long getNumMsgsRcvdGuaranteed()

Gets the value of 'numMsgsRcvdGuaranteed'

Field Description

The number of guaranteed messages the application has received.

Returns:

The number of guaranteed messages the application has received.

clearNumMsgsRcvdGuaranteed

void clearNumMsgsRcvdGuaranteed()

Clears the value of 'numMsgsRcvdGuaranteed'

Field Description

The number of guaranteed messages the application has received.

See Also:

setNumMsgsRcvdGuaranteed(long)

hasNumMsgsRcvdGuaranteed

boolean hasNumMsgsRcvdGuaranteed()

Checks for the presence of 'numMsgsRcvdGuaranteed'

Field Description

The number of guaranteed messages the application has received.

See Also:

getNumMsgsRcvdGuaranteed()

setNumDupMsgsRcvd

void setNumDupMsgsRcvd(long val)

Sets the value of 'numDupMsgsRcvd'

Field Description

The number of duplicate messages the application has received.

Parameters:

val - The value to set.

getNumDupMsgsRcvd

long getNumDupMsgsRcvd()

Gets the value of 'numDupMsgsRcvd'

Field Description

The number of duplicate messages the application has received.

Returns:

The number of duplicate messages the application has received.

clearNumDupMsgsRcvd

void clearNumDupMsgsRcvd()

Clears the value of 'numDupMsgsRcvd'

Field Description

The number of duplicate messages the application has received.

See Also:

setNumDupMsgsRcvd(long)

hasNumDupMsgsRcvd

boolean hasNumDupMsgsRcvd()

Checks for the presence of 'numDupMsgsRcvd'

Field Description

The number of duplicate messages the application has received.

See Also:

getNumDupMsgsRcvd()

setNumMsgsSentBestEffort

void setNumMsgsSentBestEffort(long val)

Sets the value of 'numMsgsSentBestEffort'

Field Description

The number of best effort messages sent by the application.

Parameters:

val - The value to set.

getNumMsgsSentBestEffort

long getNumMsgsSentBestEffort()

Gets the value of 'numMsgsSentBestEffort'

Field Description

The number of best effort messages sent by the application.

Returns:

The number of best effort messages sent by the application.

clearNumMsgsSentBestEffort

void clearNumMsgsSentBestEffort()

Clears the value of 'numMsgsSentBestEffort'

Field Description

The number of best effort messages sent by the application.

See Also:

setNumMsgsSentBestEffort(long)

hasNumMsgsSentBestEffort

boolean hasNumMsgsSentBestEffort()

Checks for the presence of 'numMsgsSentBestEffort'

Field Description

The number of best effort messages sent by the application.

See Also:

getNumMsgsSentBestEffort()

setNumMsgsSentGuaranteed

void setNumMsgsSentGuaranteed(long val)

Sets the value of 'numMsgsSentGuaranteed'

Field Description

The number of guaranteed messages sent by the application.

Parameters:

val - The value to set.

getNumMsgsSentGuaranteed

long getNumMsgsSentGuaranteed()

Gets the value of 'numMsgsSentGuaranteed'

Field Description

The number of guaranteed messages sent by the application.

Returns:

The number of guaranteed messages sent by the application.

clearNumMsgsSentGuaranteed

void clearNumMsgsSentGuaranteed()

Clears the value of 'numMsgsSentGuaranteed'

Field Description

The number of guaranteed messages sent by the application.

See Also:

setNumMsgsSentGuaranteed(long)

hasNumMsgsSentGuaranteed

boolean hasNumMsgsSentGuaranteed()

Checks for the presence of 'numMsgsSentGuaranteed'

Field Description

The number of guaranteed messages sent by the application.

See Also:

getNumMsgsSentGuaranteed()

setNumMsgsResent

void setNumMsgsResent(long val)

Sets the value of 'numMsgsResent'

Field Description

The number of messages the application has retransmitted.

Parameters:

val - The value to set.

getNumMsgsResent

long getNumMsgsResent()

Gets the value of 'numMsgsResent'

Field Description

The number of messages the application has retransmitted.

Returns:

The number of messages the application has retransmitted.

clearNumMsgsResent

void clearNumMsgsResent()

Clears the value of 'numMsgsResent'

Field Description

The number of messages the application has retransmitted.

See Also:

setNumMsgsResent(long)

hasNumMsgsResent

boolean hasNumMsgsResent()

Checks for the presence of 'numMsgsResent'

Field Description

The number of messages the application has retransmitted.

See Also:

getNumMsgsResent()

setNumEventsRcvd

void setNumEventsRcvd(long val)

Sets the value of 'numEventsRcvd'

Field Description

The number of events received by the engine

Parameters:

val - The value to set.

getNumEventsRcvd

long getNumEventsRcvd()

Gets the value of 'numEventsRcvd'

Field Description

The number of events received by the engine

Returns:

The number of events received by the engine

clearNumEventsRcvd

void clearNumEventsRcvd()

Clears the value of 'numEventsRcvd'

Field Description

The number of events received by the engine

See Also:

setNumEventsRcvd(long)

hasNumEventsRcvd

boolean hasNumEventsRcvd()

Checks for the presence of 'numEventsRcvd'

Field Description

The number of events received by the engine

See Also:

getNumEventsRcvd()

setNumFlowEventsRcvd

void setNumFlowEventsRcvd(long val)

Sets the value of 'numFlowEventsRcvd'

Field Description

The number of flow related events processed by the engine

Parameters:

val - The value to set.

getNumFlowEventsRcvd

long getNumFlowEventsRcvd()

Gets the value of 'numFlowEventsRcvd'

Field Description

The number of flow related events processed by the engine

Returns:

The number of flow related events processed by the engine

clearNumFlowEventsRcvd

void clearNumFlowEventsRcvd()

Clears the value of 'numFlowEventsRcvd'

Field Description

The number of flow related events processed by the engine

See Also:

setNumFlowEventsRcvd(long)

hasNumFlowEventsRcvd

boolean hasNumFlowEventsRcvd()

Checks for the presence of 'numFlowEventsRcvd'

Field Description

The number of flow related events processed by the engine

See Also:

getNumFlowEventsRcvd()

setNumFlowEventsProcSuccess

void setNumFlowEventsProcSuccess(long val)

Sets the value of 'numFlowEventsProcSuccess'

Field Description

The number of flow related events successfully processed by the engine

Parameters:

val - The value to set.

getNumFlowEventsProcSuccess

long getNumFlowEventsProcSuccess()

Gets the value of 'numFlowEventsProcSuccess'

Field Description

The number of flow related events successfully processed by the engine

Returns:

The number of flow related events successfully processed by the engine

clearNumFlowEventsProcSuccess

void clearNumFlowEventsProcSuccess()

Clears the value of 'numFlowEventsProcSuccess'

Field Description

The number of flow related events successfully processed by the engine

See Also:

setNumFlowEventsProcSuccess(long)

hasNumFlowEventsProcSuccess

boolean hasNumFlowEventsProcSuccess()

Checks for the presence of 'numFlowEventsProcSuccess'

Field Description

The number of flow related events successfully processed by the engine

See Also:

getNumFlowEventsProcSuccess()

setNumFlowEventsProcFail

void setNumFlowEventsProcFail(long val)

Sets the value of 'numFlowEventsProcFail'

Field Description

The number of flow related events unsuccessfully processed by the engine

Parameters:

val - The value to set.

getNumFlowEventsProcFail

long getNumFlowEventsProcFail()

Gets the value of 'numFlowEventsProcFail'

Field Description

The number of flow related events unsuccessfully processed by the engine

Returns:

The number of flow related events unsuccessfully processed by the engine

clearNumFlowEventsProcFail

void clearNumFlowEventsProcFail()

Clears the value of 'numFlowEventsProcFail'

Field Description

The number of flow related events unsuccessfully processed by the engine

See Also:

setNumFlowEventsProcFail(long)

hasNumFlowEventsProcFail

boolean hasNumFlowEventsProcFail()

Checks for the presence of 'numFlowEventsProcFail'

Field Description

The number of flow related events unsuccessfully processed by the engine

See Also:

getNumFlowEventsProcFail()

setNumFlowEventsProcComplete

void setNumFlowEventsProcComplete(long val)

Sets the value of 'numFlowEventsProcComplete'

Field Description

The number of flow related events that have completely processed by the engine

Parameters:

val - The value to set.

getNumFlowEventsProcComplete

long getNumFlowEventsProcComplete()

Gets the value of 'numFlowEventsProcComplete'

Field Description

The number of flow related events that have completely processed by the engine

Returns:

The number of flow related events that have completely processed by the engine

clearNumFlowEventsProcComplete

void clearNumFlowEventsProcComplete()

Clears the value of 'numFlowEventsProcComplete'

Field Description

The number of flow related events that have completely processed by the engine

See Also:

setNumFlowEventsProcComplete(long)

hasNumFlowEventsProcComplete

boolean hasNumFlowEventsProcComplete()

Checks for the presence of 'numFlowEventsProcComplete'

Field Description

The number of flow related events that have completely processed by the engine

See Also:

getNumFlowEventsProcComplete()

setNumTransactions

void setNumTransactions(long val)

Sets the value of 'numTransactions'

Field Description

The number of transactions created by the engine.

Parameters:

val - The value to set.

getNumTransactions

long getNumTransactions()

Gets the value of 'numTransactions'

Field Description

The number of transactions created by the engine.

Returns:

The number of transactions created by the engine.

clearNumTransactions

void clearNumTransactions()

Clears the value of 'numTransactions'

Field Description

The number of transactions created by the engine.

See Also:

setNumTransactions(long)

hasNumTransactions

boolean hasNumTransactions()

Checks for the presence of 'numTransactions'

Field Description

The number of transactions created by the engine.

See Also:

getNumTransactions()

setNumCommitsStarted

void setNumCommitsStarted(long val)

Sets the value of 'numCommitsStarted'

Field Description

The number of transaction commits started by the engine.

Parameters:

val - The value to set.

getNumCommitsStarted

long getNumCommitsStarted()

Gets the value of 'numCommitsStarted'

Field Description

The number of transaction commits started by the engine.

Returns:

The number of transaction commits started by the engine.

clearNumCommitsStarted

void clearNumCommitsStarted()

Clears the value of 'numCommitsStarted'

Field Description

The number of transaction commits started by the engine.

See Also:

setNumCommitsStarted(long)

hasNumCommitsStarted

boolean hasNumCommitsStarted()

Checks for the presence of 'numCommitsStarted'

Field Description

The number of transaction commits started by the engine.

See Also:

getNumCommitsStarted()

setNumCommitsCompleted

void setNumCommitsCompleted(long val)

Sets the value of 'numCommitsCompleted'

Field Description

The number of transaction commits completed by the engine.

Parameters:

val - The value to set.

getNumCommitsCompleted

long getNumCommitsCompleted()

Gets the value of 'numCommitsCompleted'

Field Description

The number of transaction commits completed by the engine.

Returns:

The number of transaction commits completed by the engine.

clearNumCommitsCompleted

void clearNumCommitsCompleted()

Clears the value of 'numCommitsCompleted'

Field Description

The number of transaction commits completed by the engine.

See Also:

setNumCommitsCompleted(long)

hasNumCommitsCompleted

boolean hasNumCommitsCompleted()

Checks for the presence of 'numCommitsCompleted'

Field Description

The number of transaction commits completed by the engine.

See Also:

getNumCommitsCompleted()

setNumSendCommitsStarted

void setNumSendCommitsStarted(long val)

Sets the value of 'numSendCommitsStarted'

Field Description

The number of send (message bus) commits started by the engine.

Parameters:

val - The value to set.

getNumSendCommitsStarted

long getNumSendCommitsStarted()

Gets the value of 'numSendCommitsStarted'

Field Description

The number of send (message bus) commits started by the engine.

Returns:

The number of send (message bus) commits started by the engine.

clearNumSendCommitsStarted

void clearNumSendCommitsStarted()

Clears the value of 'numSendCommitsStarted'

Field Description

The number of send (message bus) commits started by the engine.

See Also:

setNumSendCommitsStarted(long)

hasNumSendCommitsStarted

boolean hasNumSendCommitsStarted()

Checks for the presence of 'numSendCommitsStarted'

Field Description

The number of send (message bus) commits started by the engine.

See Also:

getNumSendCommitsStarted()

setNumSendCommitsCompleted

void setNumSendCommitsCompleted(long val)

Sets the value of 'numSendCommitsCompleted'

Field Description

The number of send (message bus) commits completed by the engine.

Parameters:

val - The value to set.

getNumSendCommitsCompleted

long getNumSendCommitsCompleted()

Gets the value of 'numSendCommitsCompleted'

Field Description

The number of send (message bus) commits completed by the engine.

Returns:

The number of send (message bus) commits completed by the engine.

clearNumSendCommitsCompleted

void clearNumSendCommitsCompleted()

Clears the value of 'numSendCommitsCompleted'

Field Description

The number of send (message bus) commits completed by the engine.

See Also:

setNumSendCommitsCompleted(long)

hasNumSendCommitsCompleted

boolean hasNumSendCommitsCompleted()

Checks for the presence of 'numSendCommitsCompleted'

Field Description

The number of send (message bus) commits completed by the engine.

See Also:

getNumSendCommitsCompleted()

setSendCommitCompletionQueueSize

void setSendCommitCompletionQueueSize(int val)

Sets the value of 'sendCommitCompletionQueueSize'

Field Description

The number of send commits pending completion.

Parameters:

val - The value to set.

getSendCommitCompletionQueueSize

int getSendCommitCompletionQueueSize()

Gets the value of 'sendCommitCompletionQueueSize'

Field Description

The number of send commits pending completion.

Returns:

The number of send commits pending completion.

clearSendCommitCompletionQueueSize

void clearSendCommitCompletionQueueSize()

Clears the value of 'sendCommitCompletionQueueSize'

Field Description

The number of send commits pending completion.

See Also:

setSendCommitCompletionQueueSize(int)

hasSendCommitCompletionQueueSize

boolean hasSendCommitCompletionQueueSize()

Checks for the presence of 'sendCommitCompletionQueueSize'

Field Description

The number of send commits pending completion.

See Also:

getSendCommitCompletionQueueSize()

setNumStoreCommitsStarted

void setNumStoreCommitsStarted(long val)

Sets the value of 'numStoreCommitsStarted'

Field Description

The number of store commits started by the engine.

Parameters:

val - The value to set.

getNumStoreCommitsStarted

long getNumStoreCommitsStarted()

Gets the value of 'numStoreCommitsStarted'

Field Description

The number of store commits started by the engine.

Returns:

The number of store commits started by the engine.

clearNumStoreCommitsStarted

void clearNumStoreCommitsStarted()

Clears the value of 'numStoreCommitsStarted'

Field Description

The number of store commits started by the engine.

See Also:

setNumStoreCommitsStarted(long)

hasNumStoreCommitsStarted

boolean hasNumStoreCommitsStarted()

Checks for the presence of 'numStoreCommitsStarted'

Field Description

The number of store commits started by the engine.

See Also:

getNumStoreCommitsStarted()

setNumStoreCommitsCompleted

void setNumStoreCommitsCompleted(long val)

Sets the value of 'numStoreCommitsCompleted'

Field Description

The number of store commits completed by the engine.

Parameters:

val - The value to set.

getNumStoreCommitsCompleted

long getNumStoreCommitsCompleted()

Gets the value of 'numStoreCommitsCompleted'

Field Description

The number of store commits completed by the engine.

Returns:

The number of store commits completed by the engine.

clearNumStoreCommitsCompleted

void clearNumStoreCommitsCompleted()

Clears the value of 'numStoreCommitsCompleted'

Field Description

The number of store commits completed by the engine.

See Also:

setNumStoreCommitsCompleted(long)

hasNumStoreCommitsCompleted

boolean hasNumStoreCommitsCompleted()

Checks for the presence of 'numStoreCommitsCompleted'

Field Description

The number of store commits completed by the engine.

See Also:

getNumStoreCommitsCompleted()

setStoreCommitCompletionQueueSize

void setStoreCommitCompletionQueueSize(int val)

Sets the value of 'storeCommitCompletionQueueSize'

Field Description

The number of store commits pending completion for the engine.

Parameters:

val - The value to set.

getStoreCommitCompletionQueueSize

int getStoreCommitCompletionQueueSize()

Gets the value of 'storeCommitCompletionQueueSize'

Field Description

The number of store commits pending completion for the engine.

Returns:

The number of store commits pending completion for the engine.

clearStoreCommitCompletionQueueSize

void clearStoreCommitCompletionQueueSize()

Clears the value of 'storeCommitCompletionQueueSize'

Field Description

The number of store commits pending completion for the engine.

See Also:

setStoreCommitCompletionQueueSize(int)

hasStoreCommitCompletionQueueSize

boolean hasStoreCommitCompletionQueueSize()

Checks for the presence of 'storeCommitCompletionQueueSize'

Field Description

The number of store commits pending completion for the engine.

See Also:

getStoreCommitCompletionQueueSize()

setNumRollbacks

void setNumRollbacks(long val)

Sets the value of 'numRollbacks'

Field Description

The number of transactions that have been rolled back.

Parameters:

val - The value to set.

getNumRollbacks

long getNumRollbacks()

Gets the value of 'numRollbacks'

Field Description

The number of transactions that have been rolled back.

Returns:

The number of transactions that have been rolled back.

clearNumRollbacks

void clearNumRollbacks()

Clears the value of 'numRollbacks'

Field Description

The number of transactions that have been rolled back.

See Also:

setNumRollbacks(long)

hasNumRollbacks

boolean hasNumRollbacks()

Checks for the presence of 'numRollbacks'

Field Description

The number of transactions that have been rolled back.

See Also:

getNumRollbacks()

setBackupOutboundQueueSize

void setBackupOutboundQueueSize(long val)

Sets the value of 'backupOutboundQueueSize'

Field Description

Number of messages in backup outbound queue

The backup outbound queue holds messages that have not been stabilized and will be restransmitted in the event that an engine becomes the Primary cluster member.

Parameters:

val - The value to set.

getBackupOutboundQueueSize

long getBackupOutboundQueueSize()

Gets the value of 'backupOutboundQueueSize'

Field Description

Number of messages in backup outbound queue

The backup outbound queue holds messages that have not been stabilized and will be restransmitted in the event that an engine becomes the Primary cluster member.

Returns:

Number of messages in backup outbound queue

clearBackupOutboundQueueSize

void clearBackupOutboundQueueSize()

Clears the value of 'backupOutboundQueueSize'

Field Description

Number of messages in backup outbound queue

The backup outbound queue holds messages that have not been stabilized and will be restransmitted in the event that an engine becomes the Primary cluster member.

See Also:

setBackupOutboundQueueSize(long)

hasBackupOutboundQueueSize

boolean hasBackupOutboundQueueSize()

Checks for the presence of 'backupOutboundQueueSize'

Field Description

Number of messages in backup outbound queue

The backup outbound queue holds messages that have not been stabilized and will be restransmitted in the event that an engine becomes the Primary cluster member.

See Also:

getBackupOutboundQueueSize()

setBackupOutboundLogQueueSize

void setBackupOutboundLogQueueSize(long val)

Sets the value of 'backupOutboundLogQueueSize'

Field Description

Number of messages in backup outbound loq queue

The backup log queue holds messages that have not been stabilized and are pending for write to an outbound message logger.

Parameters:

val - The value to set.

getBackupOutboundLogQueueSize

long getBackupOutboundLogQueueSize()

Gets the value of 'backupOutboundLogQueueSize'

Field Description

Number of messages in backup outbound loq queue

The backup log queue holds messages that have not been stabilized and are pending for write to an outbound message logger.

Returns:

Number of messages in backup outbound loq queue

clearBackupOutboundLogQueueSize

void clearBackupOutboundLogQueueSize()

Clears the value of 'backupOutboundLogQueueSize'

Field Description

Number of messages in backup outbound loq queue

The backup log queue holds messages that have not been stabilized and are pending for write to an outbound message logger.

See Also:

setBackupOutboundLogQueueSize(long)

hasBackupOutboundLogQueueSize

boolean hasBackupOutboundLogQueueSize()

Checks for the presence of 'backupOutboundLogQueueSize'

Field Description

Number of messages in backup outbound loq queue

The backup log queue holds messages that have not been stabilized and are pending for write to an outbound message logger.

See Also:

getBackupOutboundLogQueueSize()

setOutboundSno

void setOutboundSno(long val)

Sets the value of 'outboundSno'

Field Description

The current outbound sequence number for the engine.

The outbound sequence number is used for doubt resolution and duplicate detection in the event of message retransmission.

Parameters:

val - The value to set.

getOutboundSno

long getOutboundSno()

Gets the value of 'outboundSno'

Field Description

The current outbound sequence number for the engine.

The outbound sequence number is used for doubt resolution and duplicate detection in the event of message retransmission.

Returns:

The current outbound sequence number for the engine.

clearOutboundSno

void clearOutboundSno()

Clears the value of 'outboundSno'

Field Description

The current outbound sequence number for the engine.

The outbound sequence number is used for doubt resolution and duplicate detection in the event of message retransmission.

See Also:

setOutboundSno(long)

hasOutboundSno

boolean hasOutboundSno()

Checks for the presence of 'outboundSno'

Field Description

The current outbound sequence number for the engine.

The outbound sequence number is used for doubt resolution and duplicate detection in the event of message retransmission.

See Also:

getOutboundSno()

setOutboundStableSno

void setOutboundStableSno(long val)

Sets the value of 'outboundStableSno'

Field Description

The current stable outbound sequence number for the engine.

The stable outbound sequence number represents messages that have been acknowledged downstream, and need not be retramitted or retained in the event of reconnect.

Parameters:

val - The value to set.

getOutboundStableSno

long getOutboundStableSno()

Gets the value of 'outboundStableSno'

Field Description

The current stable outbound sequence number for the engine.

The stable outbound sequence number represents messages that have been acknowledged downstream, and need not be retramitted or retained in the event of reconnect.

Returns:

The current stable outbound sequence number for the engine.

clearOutboundStableSno

void clearOutboundStableSno()

Clears the value of 'outboundStableSno'

Field Description

The current stable outbound sequence number for the engine.

The stable outbound sequence number represents messages that have been acknowledged downstream, and need not be retramitted or retained in the event of reconnect.

See Also:

setOutboundStableSno(long)

hasOutboundStableSno

boolean hasOutboundStableSno()

Checks for the presence of 'outboundStableSno'

Field Description

The current stable outbound sequence number for the engine.

The stable outbound sequence number represents messages that have been acknowledged downstream, and need not be retramitted or retained in the event of reconnect.

See Also:

getOutboundStableSno()

setNumEventsProcessed

void setNumEventsProcessed(long val)

Sets the value of 'numEventsProcessed'

Field Description

The number of events processed by the engine

Parameters:

val - The value to set.

getNumEventsProcessed

long getNumEventsProcessed()

Gets the value of 'numEventsProcessed'

Field Description

The number of events processed by the engine

Returns:

The number of events processed by the engine

clearNumEventsProcessed

void clearNumEventsProcessed()

Clears the value of 'numEventsProcessed'

Field Description

The number of events processed by the engine

See Also:

setNumEventsProcessed(long)

hasNumEventsProcessed

boolean hasNumEventsProcessed()

Checks for the presence of 'numEventsProcessed'

Field Description

The number of events processed by the engine

See Also:

getNumEventsProcessed()

setNumMsgsSourced

void setNumMsgsSourced(long val)

Sets the value of 'numMsgsSourced'

Field Description

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.

Parameters:

val - The value to set.

getNumMsgsSourced

long getNumMsgsSourced()

Gets the value of 'numMsgsSourced'

Field Description

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.

Returns:

The number of messages that were sourced.

clearNumMsgsSourced

void clearNumMsgsSourced()

Clears the value of 'numMsgsSourced'

Field Description

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.

See Also:

setNumMsgsSourced(long)

hasNumMsgsSourced

boolean hasNumMsgsSourced()

Checks for the presence of 'numMsgsSourced'

Field Description

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.

See Also:

getNumMsgsSourced()

setNumMsgsFiltered

void setNumMsgsFiltered(long val)

Sets the value of 'numMsgsFiltered'

Field Description

The number of messages that were filtered.

Parameters:

val - The value to set.

getNumMsgsFiltered

long getNumMsgsFiltered()

Gets the value of 'numMsgsFiltered'

Field Description

The number of messages that were filtered.

Returns:

The number of messages that were filtered.

clearNumMsgsFiltered

void clearNumMsgsFiltered()

Clears the value of 'numMsgsFiltered'

Field Description

The number of messages that were filtered.

See Also:

setNumMsgsFiltered(long)

hasNumMsgsFiltered

boolean hasNumMsgsFiltered()

Checks for the presence of 'numMsgsFiltered'

Field Description

The number of messages that were filtered.

See Also:

getNumMsgsFiltered()

setNumPartialRollbacks

void setNumPartialRollbacks(long val)

Sets the value of 'numPartialRollbacks'

Field Description

The number of partial (savepoint) transaction rollback that have been initiated.

Parameters:

val - The value to set.

getNumPartialRollbacks

long getNumPartialRollbacks()

Gets the value of 'numPartialRollbacks'

Field Description

The number of partial (savepoint) transaction rollback that have been initiated.

Returns:

The number of partial (savepoint) transaction rollback that have been initiated.

clearNumPartialRollbacks

void clearNumPartialRollbacks()

Clears the value of 'numPartialRollbacks'

Field Description

The number of partial (savepoint) transaction rollback that have been initiated.

See Also:

setNumPartialRollbacks(long)

hasNumPartialRollbacks

boolean hasNumPartialRollbacks()

Checks for the presence of 'numPartialRollbacks'

Field Description

The number of partial (savepoint) transaction rollback that have been initiated.

See Also:

getNumPartialRollbacks()

setMsgPreProcLatencies

void setMsgPreProcLatencies(SrvMonIntSeries val)

Sets the value of 'msgPreProcLatencies'

Field Description

Records the time (in microseconds) spent by the engine dispatching the message to an application (aka 'mpproc').

Parameters:

val - The value to set.

lendMsgPreProcLatencies

void lendMsgPreProcLatencies(SrvMonIntSeries val)

'Lends' a reference of the SrvMonIntSeries to the message for this field.

Field Description

Records the time (in microseconds) spent by the engine dispatching the message to an application (aka 'mpproc').

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.

Parameters:

val - the value to 'lend' to lend.

getMsgPreProcLatencies

SrvMonIntSeries getMsgPreProcLatencies()

Gets the value of 'msgPreProcLatencies'

Field Description

Records the time (in microseconds) spent by the engine dispatching the message to an application (aka 'mpproc').

Returns:

Records the time (in microseconds) spent by the engine dispatching the message to an application (aka 'mpproc').

getMsgPreProcLatenciesTo

void getMsgPreProcLatenciesTo(SrvMonIntSeries val)

Copies the value of SrvMonIntSeries into the provided value.

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

Parameters:

val - the value to copy into

See Also:

SrvMonIntSeries.copyInto(SrvMonIntSeries)

takeMsgPreProcLatencies

SrvMonIntSeries takeMsgPreProcLatencies()

'Takes' a reference to the msgPreProcLatencies field from the message.

Field Description

Records the time (in microseconds) spent by the engine dispatching the message to an application (aka 'mpproc').

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.

Returns:

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

hasMsgPreProcLatencies

boolean hasMsgPreProcLatencies()

Checks for the presence of 'msgPreProcLatencies'

Field Description

Records the time (in microseconds) spent by the engine dispatching the message to an application (aka 'mpproc').

See Also:

getMsgPreProcLatencies()

clearMsgPreProcLatencies

void clearMsgPreProcLatencies()

Clears the value of 'msgPreProcLatencies'

Field Description

Records the time (in microseconds) spent by the engine dispatching the message to an application (aka 'mpproc').

See Also:

setMsgPreProcLatencies(SrvMonIntSeries)

setMsgProcessingLatencies

void setMsgProcessingLatencies(SrvMonIntSeries val)

Sets the value of 'msgProcessingLatencies'

Field Description

Records latencies for application message process times (in an EventHandler) (aka 'mproc').

Parameters:

val - The value to set.

lendMsgProcessingLatencies

void lendMsgProcessingLatencies(SrvMonIntSeries val)

'Lends' a reference of the SrvMonIntSeries to the message for this field.

Field Description

Records latencies for application message process times (in an EventHandler) (aka 'mproc').

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.

Parameters:

val - the value to 'lend' to lend.

getMsgProcessingLatencies

SrvMonIntSeries getMsgProcessingLatencies()

Gets the value of 'msgProcessingLatencies'

Field Description

Records latencies for application message process times (in an EventHandler) (aka 'mproc').

Returns:

Records latencies for application message process times (in an EventHandler) (aka 'mproc').

getMsgProcessingLatenciesTo

void getMsgProcessingLatenciesTo(SrvMonIntSeries val)

Copies the value of SrvMonIntSeries into the provided value.

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

Parameters:

val - the value to copy into

See Also:

SrvMonIntSeries.copyInto(SrvMonIntSeries)

takeMsgProcessingLatencies

SrvMonIntSeries takeMsgProcessingLatencies()

'Takes' a reference to the msgProcessingLatencies field from the message.

Field Description

Records latencies for application message process times (in an EventHandler) (aka 'mproc').

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.

Returns:

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

hasMsgProcessingLatencies

boolean hasMsgProcessingLatencies()

Checks for the presence of 'msgProcessingLatencies'

Field Description

Records latencies for application message process times (in an EventHandler) (aka 'mproc').

See Also:

getMsgProcessingLatencies()

clearMsgProcessingLatencies

void clearMsgProcessingLatencies()

Clears the value of 'msgProcessingLatencies'

Field Description

Records latencies for application message process times (in an EventHandler) (aka 'mproc').

See Also:

setMsgProcessingLatencies(SrvMonIntSeries)

setMsgSendLatencies

void setMsgSendLatencies(SrvMonIntSeries val)

Sets the value of 'msgSendLatencies'

Field Description

Time spent in AepEngine.sendMessage() (aka 'msend').

Parameters:

val - The value to set.

lendMsgSendLatencies

void lendMsgSendLatencies(SrvMonIntSeries val)

'Lends' a reference of the SrvMonIntSeries to the message for this field.

Field Description

Time spent in AepEngine.sendMessage() (aka 'msend').

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.

Parameters:

val - the value to 'lend' to lend.

getMsgSendLatencies

SrvMonIntSeries getMsgSendLatencies()

Gets the value of 'msgSendLatencies'

Field Description

Time spent in AepEngine.sendMessage() (aka 'msend').

Returns:

Time spent in AepEngine.sendMessage() (aka 'msend').

getMsgSendLatenciesTo

void getMsgSendLatenciesTo(SrvMonIntSeries val)

Copies the value of SrvMonIntSeries into the provided value.

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

Parameters:

val - the value to copy into

See Also:

SrvMonIntSeries.copyInto(SrvMonIntSeries)

takeMsgSendLatencies

SrvMonIntSeries takeMsgSendLatencies()

'Takes' a reference to the msgSendLatencies field from the message.

Field Description

Time spent in AepEngine.sendMessage() (aka 'msend').

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.

Returns:

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

hasMsgSendLatencies

boolean hasMsgSendLatencies()

Checks for the presence of 'msgSendLatencies'

Field Description

Time spent in AepEngine.sendMessage() (aka 'msend').

See Also:

getMsgSendLatencies()

clearMsgSendLatencies

void clearMsgSendLatencies()

Clears the value of 'msgSendLatencies'

Field Description

Time spent in AepEngine.sendMessage() (aka 'msend').

See Also:

setMsgSendLatencies(SrvMonIntSeries)

setMsgSendCoreLatencies

void setMsgSendCoreLatencies(SrvMonIntSeries val)

Sets the value of 'msgSendCoreLatencies'

Field Description

Time spent in AepEngine.sendMessageCore() (aka 'msendc')

Parameters:

val - The value to set.

lendMsgSendCoreLatencies

void lendMsgSendCoreLatencies(SrvMonIntSeries val)

'Lends' a reference of the SrvMonIntSeries to the message for this field.

Field Description

Time spent in AepEngine.sendMessageCore() (aka 'msendc')

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.

Parameters:

val - the value to 'lend' to lend.

getMsgSendCoreLatencies

SrvMonIntSeries getMsgSendCoreLatencies()

Gets the value of 'msgSendCoreLatencies'

Field Description

Time spent in AepEngine.sendMessageCore() (aka 'msendc')

Returns:

Time spent in AepEngine.sendMessageCore() (aka 'msendc')

getMsgSendCoreLatenciesTo

void getMsgSendCoreLatenciesTo(SrvMonIntSeries val)

Copies the value of SrvMonIntSeries into the provided value.

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

Parameters:

val - the value to copy into

See Also:

SrvMonIntSeries.copyInto(SrvMonIntSeries)

takeMsgSendCoreLatencies

SrvMonIntSeries takeMsgSendCoreLatencies()

'Takes' a reference to the msgSendCoreLatencies field from the message.

Field Description

Time spent in AepEngine.sendMessageCore() (aka 'msendc')

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.

Returns:

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

hasMsgSendCoreLatencies

boolean hasMsgSendCoreLatencies()

Checks for the presence of 'msgSendCoreLatencies'

Field Description

Time spent in AepEngine.sendMessageCore() (aka 'msendc')

See Also:

getMsgSendCoreLatencies()

clearMsgSendCoreLatencies

void clearMsgSendCoreLatencies()

Clears the value of 'msgSendCoreLatencies'

Field Description

Time spent in AepEngine.sendMessageCore() (aka 'msendc')

See Also:

setMsgSendCoreLatencies(SrvMonIntSeries)

setCommitStartLatencies

void setCommitStartLatencies(SrvMonIntSeries val)

Sets the value of 'commitStartLatencies'

Field Description

Time spent from the point the first message of a transaction is received to the time the transaction is committed (aka 'cstart').

Parameters:

val - The value to set.

lendCommitStartLatencies

void lendCommitStartLatencies(SrvMonIntSeries val)

'Lends' a reference of the SrvMonIntSeries to the message for this field.

Field Description

Time spent from the point the first message of a transaction is received to the time the transaction is committed (aka 'cstart').

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.

Parameters:

val - the value to 'lend' to lend.

getCommitStartLatencies

SrvMonIntSeries getCommitStartLatencies()

Gets the value of 'commitStartLatencies'

Field Description

Time spent from the point the first message of a transaction is received to the time the transaction is committed (aka 'cstart').

Returns:

Time spent from the point the first message of a transaction is received to the time the transaction is committed (aka 'cstart').

getCommitStartLatenciesTo

void getCommitStartLatenciesTo(SrvMonIntSeries val)

Copies the value of SrvMonIntSeries into the provided value.

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

Parameters:

val - the value to copy into

See Also:

SrvMonIntSeries.copyInto(SrvMonIntSeries)

takeCommitStartLatencies

SrvMonIntSeries takeCommitStartLatencies()

'Takes' a reference to the commitStartLatencies field from the message.

Field Description

Time spent from the point the first message of a transaction is received to the time the transaction is committed (aka 'cstart').

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.

Returns:

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

hasCommitStartLatencies

boolean hasCommitStartLatencies()

Checks for the presence of 'commitStartLatencies'

Field Description

Time spent from the point the first message of a transaction is received to the time the transaction is committed (aka 'cstart').

See Also:

getCommitStartLatencies()

clearCommitStartLatencies

void clearCommitStartLatencies()

Clears the value of 'commitStartLatencies'

Field Description

Time spent from the point the first message of a transaction is received to the time the transaction is committed (aka 'cstart').

See Also:

setCommitStartLatencies(SrvMonIntSeries)

setCommitPrologueLatencies

void setCommitPrologueLatencies(SrvMonIntSeries val)

Sets the value of 'commitPrologueLatencies'

Field Description

Time spent from the point where transaction commit is started to send or store commit whichever is first (aka 'cprolo').

Parameters:

val - The value to set.

lendCommitPrologueLatencies

void lendCommitPrologueLatencies(SrvMonIntSeries val)

'Lends' a reference of the SrvMonIntSeries to the message for this field.

Field Description

Time spent from the point where transaction commit is started to send or store commit whichever is first (aka 'cprolo').

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.

Parameters:

val - the value to 'lend' to lend.

getCommitPrologueLatencies

SrvMonIntSeries getCommitPrologueLatencies()

Gets the value of 'commitPrologueLatencies'

Field Description

Time spent from the point where transaction commit is started to send or store commit whichever is first (aka 'cprolo').

Returns:

Time spent from the point where transaction commit is started to send or store commit whichever is first (aka 'cprolo').

getCommitPrologueLatenciesTo

void getCommitPrologueLatenciesTo(SrvMonIntSeries val)

Copies the value of SrvMonIntSeries into the provided value.

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

Parameters:

val - the value to copy into

See Also:

SrvMonIntSeries.copyInto(SrvMonIntSeries)

takeCommitPrologueLatencies

SrvMonIntSeries takeCommitPrologueLatencies()

'Takes' a reference to the commitPrologueLatencies field from the message.

Field Description

Time spent from the point where transaction commit is started to send or store commit whichever is first (aka 'cprolo').

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.

Returns:

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

hasCommitPrologueLatencies

boolean hasCommitPrologueLatencies()

Checks for the presence of 'commitPrologueLatencies'

Field Description

Time spent from the point where transaction commit is started to send or store commit whichever is first (aka 'cprolo').

See Also:

getCommitPrologueLatencies()

clearCommitPrologueLatencies

void clearCommitPrologueLatencies()

Clears the value of 'commitPrologueLatencies'

Field Description

Time spent from the point where transaction commit is started to send or store commit whichever is first (aka 'cprolo').

See Also:

setCommitPrologueLatencies(SrvMonIntSeries)

setCommitSendLatencies

void setCommitSendLatencies(SrvMonIntSeries val)

Sets the value of 'commitSendLatencies'

Field Description

Time spent for send commits to complete i.e. time from when send commit is initiated to receipt of send completion event (aka 'csend').

Because commit send latencies include the time until an acknowledgement is received, a high value here does not necessarily mean that outbound sends will exhibit a high latency.

Parameters:

val - The value to set.

lendCommitSendLatencies

void lendCommitSendLatencies(SrvMonIntSeries val)

'Lends' a reference of the SrvMonIntSeries to the message for this field.

Field Description

Time spent for send commits to complete i.e. time from when send commit is initiated to receipt of send completion event (aka 'csend').

Because commit send latencies include the time until an acknowledgement is received, a high value here does not necessarily mean that outbound sends will exhibit a high latency.

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.

Parameters:

val - the value to 'lend' to lend.

getCommitSendLatencies

SrvMonIntSeries getCommitSendLatencies()

Gets the value of 'commitSendLatencies'

Field Description

Time spent for send commits to complete i.e. time from when send commit is initiated to receipt of send completion event (aka 'csend').

Because commit send latencies include the time until an acknowledgement is received, a high value here does not necessarily mean that outbound sends will exhibit a high latency.

Returns:

Time spent for send commits to complete i.e. time from when send commit is initiated to receipt of send completion event (aka 'csend').

getCommitSendLatenciesTo

void getCommitSendLatenciesTo(SrvMonIntSeries val)

Copies the value of SrvMonIntSeries into the provided value.

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

Parameters:

val - the value to copy into

See Also:

SrvMonIntSeries.copyInto(SrvMonIntSeries)

takeCommitSendLatencies

SrvMonIntSeries takeCommitSendLatencies()

'Takes' a reference to the commitSendLatencies field from the message.

Field Description

Time spent for send commits to complete i.e. time from when send commit is initiated to receipt of send completion event (aka 'csend').

Because commit send latencies include the time until an acknowledgement is received, a high value here does not necessarily mean that outbound sends will exhibit a high latency.

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.

Returns:

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

hasCommitSendLatencies

boolean hasCommitSendLatencies()

Checks for the presence of 'commitSendLatencies'

Field Description

Time spent for send commits to complete i.e. time from when send commit is initiated to receipt of send completion event (aka 'csend').

Because commit send latencies include the time until an acknowledgement is received, a high value here does not necessarily mean that outbound sends will exhibit a high latency.

See Also:

getCommitSendLatencies()

clearCommitSendLatencies

void clearCommitSendLatencies()

Clears the value of 'commitSendLatencies'

Field Description

Time spent for send commits to complete i.e. time from when send commit is initiated to receipt of send completion event (aka 'csend').

Because commit send latencies include the time until an acknowledgement is received, a high value here does not necessarily mean that outbound sends will exhibit a high latency.

See Also:

setCommitSendLatencies(SrvMonIntSeries)

setCommitStoreLatencies

void setCommitStoreLatencies(SrvMonIntSeries val)

Sets the value of 'commitStoreLatencies'

Field Description

Time spent in store commit i.e. time from when store commit is initiated to receipt of store completion event (aka 'cstore').

Parameters:

val - The value to set.

lendCommitStoreLatencies

void lendCommitStoreLatencies(SrvMonIntSeries val)

'Lends' a reference of the SrvMonIntSeries to the message for this field.

Field Description

Time spent in store commit i.e. time from when store commit is initiated to receipt of store completion event (aka 'cstore').

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.

Parameters:

val - the value to 'lend' to lend.

getCommitStoreLatencies

SrvMonIntSeries getCommitStoreLatencies()

Gets the value of 'commitStoreLatencies'

Field Description

Time spent in store commit i.e. time from when store commit is initiated to receipt of store completion event (aka 'cstore').

Returns:

Time spent in store commit i.e. time from when store commit is initiated to receipt of store completion event (aka 'cstore').

getCommitStoreLatenciesTo

void getCommitStoreLatenciesTo(SrvMonIntSeries val)

Copies the value of SrvMonIntSeries into the provided value.

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

Parameters:

val - the value to copy into

See Also:

SrvMonIntSeries.copyInto(SrvMonIntSeries)

takeCommitStoreLatencies

SrvMonIntSeries takeCommitStoreLatencies()

'Takes' a reference to the commitStoreLatencies field from the message.

Field Description

Time spent in store commit i.e. time from when store commit is initiated to receipt of store completion event (aka 'cstore').

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.

Returns:

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

hasCommitStoreLatencies

boolean hasCommitStoreLatencies()

Checks for the presence of 'commitStoreLatencies'

Field Description

Time spent in store commit i.e. time from when store commit is initiated to receipt of store completion event (aka 'cstore').

See Also:

getCommitStoreLatencies()

clearCommitStoreLatencies

void clearCommitStoreLatencies()

Clears the value of 'commitStoreLatencies'

Field Description

Time spent in store commit i.e. time from when store commit is initiated to receipt of store completion event (aka 'cstore').

See Also:

setCommitStoreLatencies(SrvMonIntSeries)

setCommitEpilogueLatencies

void setCommitEpilogueLatencies(SrvMonIntSeries val)

Sets the value of 'commitEpilogueLatencies'

Field Description

Time spent from the point the store or send commit completes, whichever is last, to commit completion (aka 'cepilo').

Parameters:

val - The value to set.

lendCommitEpilogueLatencies

void lendCommitEpilogueLatencies(SrvMonIntSeries val)

'Lends' a reference of the SrvMonIntSeries to the message for this field.

Field Description

Time spent from the point the store or send commit completes, whichever is last, to commit completion (aka 'cepilo').

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.

Parameters:

val - the value to 'lend' to lend.

getCommitEpilogueLatencies

SrvMonIntSeries getCommitEpilogueLatencies()

Gets the value of 'commitEpilogueLatencies'

Field Description

Time spent from the point the store or send commit completes, whichever is last, to commit completion (aka 'cepilo').

Returns:

Time spent from the point the store or send commit completes, whichever is last, to commit completion (aka 'cepilo').

getCommitEpilogueLatenciesTo

void getCommitEpilogueLatenciesTo(SrvMonIntSeries val)

Copies the value of SrvMonIntSeries into the provided value.

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

Parameters:

val - the value to copy into

See Also:

SrvMonIntSeries.copyInto(SrvMonIntSeries)

takeCommitEpilogueLatencies

SrvMonIntSeries takeCommitEpilogueLatencies()

'Takes' a reference to the commitEpilogueLatencies field from the message.

Field Description

Time spent from the point the store or send commit completes, whichever is last, to commit completion (aka 'cepilo').

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.

Returns:

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

hasCommitEpilogueLatencies

boolean hasCommitEpilogueLatencies()

Checks for the presence of 'commitEpilogueLatencies'

Field Description

Time spent from the point the store or send commit completes, whichever is last, to commit completion (aka 'cepilo').

See Also:

getCommitEpilogueLatencies()

clearCommitEpilogueLatencies

void clearCommitEpilogueLatencies()

Clears the value of 'commitEpilogueLatencies'

Field Description

Time spent from the point the store or send commit completes, whichever is last, to commit completion (aka 'cepilo').

See Also:

setCommitEpilogueLatencies(SrvMonIntSeries)

setCommitFullLatencies

void setCommitFullLatencies(SrvMonIntSeries val)

Sets the value of 'commitFullLatencies'

Field Description

Time spent from the time the first message of a transaction is received to commit completion (aka 'cfull').

Parameters:

val - The value to set.

lendCommitFullLatencies

void lendCommitFullLatencies(SrvMonIntSeries val)

'Lends' a reference of the SrvMonIntSeries to the message for this field.

Field Description

Time spent from the time the first message of a transaction is received to commit completion (aka 'cfull').

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.

Parameters:

val - the value to 'lend' to lend.

getCommitFullLatencies

SrvMonIntSeries getCommitFullLatencies()

Gets the value of 'commitFullLatencies'

Field Description

Time spent from the time the first message of a transaction is received to commit completion (aka 'cfull').

Returns:

Time spent from the time the first message of a transaction is received to commit completion (aka 'cfull').

getCommitFullLatenciesTo

void getCommitFullLatenciesTo(SrvMonIntSeries val)

Copies the value of SrvMonIntSeries into the provided value.

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

Parameters:

val - the value to copy into

See Also:

SrvMonIntSeries.copyInto(SrvMonIntSeries)

takeCommitFullLatencies

SrvMonIntSeries takeCommitFullLatencies()

'Takes' a reference to the commitFullLatencies field from the message.

Field Description

Time spent from the time the first message of a transaction is received to commit completion (aka 'cfull').

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.

Returns:

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

hasCommitFullLatencies

boolean hasCommitFullLatencies()

Checks for the presence of 'commitFullLatencies'

Field Description

Time spent from the time the first message of a transaction is received to commit completion (aka 'cfull').

See Also:

getCommitFullLatencies()

clearCommitFullLatencies

void clearCommitFullLatencies()

Clears the value of 'commitFullLatencies'

Field Description

Time spent from the time the first message of a transaction is received to commit completion (aka 'cfull').

See Also:

setCommitFullLatencies(SrvMonIntSeries)

setInOutLatencies

void setInOutLatencies(SrvMonIntSeries val)

Sets the value of 'inOutLatencies'

Field Description

Records latencies for receipt of a message to transmission of the last outbound message (aka 'inout').

Parameters:

val - The value to set.

lendInOutLatencies

void lendInOutLatencies(SrvMonIntSeries val)

'Lends' a reference of the SrvMonIntSeries to the message for this field.

Field Description

Records latencies for receipt of a message to transmission of the last outbound message (aka 'inout').

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.

Parameters:

val - the value to 'lend' to lend.

getInOutLatencies

SrvMonIntSeries getInOutLatencies()

Gets the value of 'inOutLatencies'

Field Description

Records latencies for receipt of a message to transmission of the last outbound message (aka 'inout').

Returns:

Records latencies for receipt of a message to transmission of the last outbound message (aka 'inout').

getInOutLatenciesTo

void getInOutLatenciesTo(SrvMonIntSeries val)

Copies the value of SrvMonIntSeries into the provided value.

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

Parameters:

val - the value to copy into

See Also:

SrvMonIntSeries.copyInto(SrvMonIntSeries)

takeInOutLatencies

SrvMonIntSeries takeInOutLatencies()

'Takes' a reference to the inOutLatencies field from the message.

Field Description

Records latencies for receipt of a message to transmission of the last outbound message (aka 'inout').

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.

Returns:

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

hasInOutLatencies

boolean hasInOutLatencies()

Checks for the presence of 'inOutLatencies'

Field Description

Records latencies for receipt of a message to transmission of the last outbound message (aka 'inout').

See Also:

getInOutLatencies()

clearInOutLatencies

void clearInOutLatencies()

Clears the value of 'inOutLatencies'

Field Description

Records latencies for receipt of a message to transmission of the last outbound message (aka 'inout').

See Also:

setInOutLatencies(SrvMonIntSeries)

setInAckLatencies

void setInAckLatencies(SrvMonIntSeries val)

Sets the value of 'inAckLatencies'

Field Description

Records latencies for receipt of a message to stabilization (and upstream acknowledgement for Guaranteed) (aka 'inack').

Parameters:

val - The value to set.

lendInAckLatencies

void lendInAckLatencies(SrvMonIntSeries val)

'Lends' a reference of the SrvMonIntSeries to the message for this field.

Field Description

Records latencies for receipt of a message to stabilization (and upstream acknowledgement for Guaranteed) (aka 'inack').

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.

Parameters:

val - the value to 'lend' to lend.

getInAckLatencies

SrvMonIntSeries getInAckLatencies()

Gets the value of 'inAckLatencies'

Field Description

Records latencies for receipt of a message to stabilization (and upstream acknowledgement for Guaranteed) (aka 'inack').

Returns:

Records latencies for receipt of a message to stabilization (and upstream acknowledgement for Guaranteed) (aka 'inack').

getInAckLatenciesTo

void getInAckLatenciesTo(SrvMonIntSeries val)

Copies the value of SrvMonIntSeries into the provided value.

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

Parameters:

val - the value to copy into

See Also:

SrvMonIntSeries.copyInto(SrvMonIntSeries)

takeInAckLatencies

SrvMonIntSeries takeInAckLatencies()

'Takes' a reference to the inAckLatencies field from the message.

Field Description

Records latencies for receipt of a message to stabilization (and upstream acknowledgement for Guaranteed) (aka 'inack').

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.

Returns:

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

hasInAckLatencies

boolean hasInAckLatencies()

Checks for the presence of 'inAckLatencies'

Field Description

Records latencies for receipt of a message to stabilization (and upstream acknowledgement for Guaranteed) (aka 'inack').

See Also:

getInAckLatencies()

clearInAckLatencies

void clearInAckLatencies()

Clears the value of 'inAckLatencies'

Field Description

Records latencies for receipt of a message to stabilization (and upstream acknowledgement for Guaranteed) (aka 'inack').

See Also:

setInAckLatencies(SrvMonIntSeries)

setTransactionLeg1ProcessingTimes

void setTransactionLeg1ProcessingTimes(SrvMonIntSeries val)

Sets the value of 'transactionLeg1ProcessingTimes'

Field Description

Records latencies for the first transaction processing leg.

Transaction Leg One includes time spent from the point where the first message of a transaction is received to submission of send/store commit (aka 'tleg1'). It includes message processing and and any overhead associated with transactional book keeping done by the engine. Note that each transaction leg is a portion of the overall commit time that is processed on the Aep Engine's thread. The sum of the transaction leg stats are important in that they determine the overall throughput that an application can sustain in terms of transactions per second.

Parameters:

val - The value to set.

lendTransactionLeg1ProcessingTimes

void lendTransactionLeg1ProcessingTimes(SrvMonIntSeries val)

'Lends' a reference of the SrvMonIntSeries to the message for this field.

Field Description

Records latencies for the first transaction processing leg.

Transaction Leg One includes time spent from the point where the first message of a transaction is received to submission of send/store commit (aka 'tleg1'). It includes message processing and and any overhead associated with transactional book keeping done by the engine. Note that each transaction leg is a portion of the overall commit time that is processed on the Aep Engine's thread. The sum of the transaction leg stats are important in that they determine the overall throughput that an application can sustain in terms of transactions per second.

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.

Parameters:

val - the value to 'lend' to lend.

getTransactionLeg1ProcessingTimes

SrvMonIntSeries getTransactionLeg1ProcessingTimes()

Gets the value of 'transactionLeg1ProcessingTimes'

Field Description

Records latencies for the first transaction processing leg.

Transaction Leg One includes time spent from the point where the first message of a transaction is received to submission of send/store commit (aka 'tleg1'). It includes message processing and and any overhead associated with transactional book keeping done by the engine. Note that each transaction leg is a portion of the overall commit time that is processed on the Aep Engine's thread. The sum of the transaction leg stats are important in that they determine the overall throughput that an application can sustain in terms of transactions per second.

Returns:

Records latencies for the first transaction processing leg.

getTransactionLeg1ProcessingTimesTo

void getTransactionLeg1ProcessingTimesTo(SrvMonIntSeries val)

Copies the value of SrvMonIntSeries into the provided value.

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

Parameters:

val - the value to copy into

See Also:

SrvMonIntSeries.copyInto(SrvMonIntSeries)

takeTransactionLeg1ProcessingTimes

SrvMonIntSeries takeTransactionLeg1ProcessingTimes()

'Takes' a reference to the transactionLeg1ProcessingTimes field from the message.

Field Description

Records latencies for the first transaction processing leg.

Transaction Leg One includes time spent from the point where the first message of a transaction is received to submission of send/store commit (aka 'tleg1'). It includes message processing and and any overhead associated with transactional book keeping done by the engine. Note that each transaction leg is a portion of the overall commit time that is processed on the Aep Engine's thread. The sum of the transaction leg stats are important in that they determine the overall throughput that an application can sustain in terms of transactions per second.

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.

Returns:

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

hasTransactionLeg1ProcessingTimes

boolean hasTransactionLeg1ProcessingTimes()

Checks for the presence of 'transactionLeg1ProcessingTimes'

Field Description

Records latencies for the first transaction processing leg.

Transaction Leg One includes time spent from the point where the first message of a transaction is received to submission of send/store commit (aka 'tleg1'). It includes message processing and and any overhead associated with transactional book keeping done by the engine. Note that each transaction leg is a portion of the overall commit time that is processed on the Aep Engine's thread. The sum of the transaction leg stats are important in that they determine the overall throughput that an application can sustain in terms of transactions per second.

See Also:

getTransactionLeg1ProcessingTimes()

clearTransactionLeg1ProcessingTimes

void clearTransactionLeg1ProcessingTimes()

Clears the value of 'transactionLeg1ProcessingTimes'

Field Description

Records latencies for the first transaction processing leg.

Transaction Leg One includes time spent from the point where the first message of a transaction is received to submission of send/store commit (aka 'tleg1'). It includes message processing and and any overhead associated with transactional book keeping done by the engine. Note that each transaction leg is a portion of the overall commit time that is processed on the Aep Engine's thread. The sum of the transaction leg stats are important in that they determine the overall throughput that an application can sustain in terms of transactions per second.

See Also:

setTransactionLeg1ProcessingTimes(SrvMonIntSeries)

setTransactionLeg2ProcessingTimes

void setTransactionLeg2ProcessingTimes(SrvMonIntSeries val)

Sets the value of 'transactionLeg2ProcessingTimes'

Field Description

Records latencies for the second transaction processing leg.

Transaction Leg Two includes time spent from the point where the send/store commit completion is received to the submission of store/send commit (aka 'tleg2'). Note that each transaction leg is a portion of the overall commit time that is processed on the Aep Engine's thread. The sum of the transaction leg stats are important in that they determine the overall throughput that an application can sustain in terms of transactions per second.

Parameters:

val - The value to set.

lendTransactionLeg2ProcessingTimes

void lendTransactionLeg2ProcessingTimes(SrvMonIntSeries val)

'Lends' a reference of the SrvMonIntSeries to the message for this field.

Field Description

Records latencies for the second transaction processing leg.

Transaction Leg Two includes time spent from the point where the send/store commit completion is received to the submission of store/send commit (aka 'tleg2'). Note that each transaction leg is a portion of the overall commit time that is processed on the Aep Engine's thread. The sum of the transaction leg stats are important in that they determine the overall throughput that an application can sustain in terms of transactions per second.

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.

Parameters:

val - the value to 'lend' to lend.

getTransactionLeg2ProcessingTimes

SrvMonIntSeries getTransactionLeg2ProcessingTimes()

Gets the value of 'transactionLeg2ProcessingTimes'

Field Description

Records latencies for the second transaction processing leg.

Transaction Leg Two includes time spent from the point where the send/store commit completion is received to the submission of store/send commit (aka 'tleg2'). Note that each transaction leg is a portion of the overall commit time that is processed on the Aep Engine's thread. The sum of the transaction leg stats are important in that they determine the overall throughput that an application can sustain in terms of transactions per second.

Returns:

Records latencies for the second transaction processing leg.

getTransactionLeg2ProcessingTimesTo

void getTransactionLeg2ProcessingTimesTo(SrvMonIntSeries val)

Copies the value of SrvMonIntSeries into the provided value.

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

Parameters:

val - the value to copy into

See Also:

SrvMonIntSeries.copyInto(SrvMonIntSeries)

takeTransactionLeg2ProcessingTimes

SrvMonIntSeries takeTransactionLeg2ProcessingTimes()

'Takes' a reference to the transactionLeg2ProcessingTimes field from the message.

Field Description

Records latencies for the second transaction processing leg.

Transaction Leg Two includes time spent from the point where the send/store commit completion is received to the submission of store/send commit (aka 'tleg2'). Note that each transaction leg is a portion of the overall commit time that is processed on the Aep Engine's thread. The sum of the transaction leg stats are important in that they determine the overall throughput that an application can sustain in terms of transactions per second.

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.

Returns:

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

hasTransactionLeg2ProcessingTimes

boolean hasTransactionLeg2ProcessingTimes()

Checks for the presence of 'transactionLeg2ProcessingTimes'

Field Description

Records latencies for the second transaction processing leg.

Transaction Leg Two includes time spent from the point where the send/store commit completion is received to the submission of store/send commit (aka 'tleg2'). Note that each transaction leg is a portion of the overall commit time that is processed on the Aep Engine's thread. The sum of the transaction leg stats are important in that they determine the overall throughput that an application can sustain in terms of transactions per second.

See Also:

getTransactionLeg2ProcessingTimes()

clearTransactionLeg2ProcessingTimes

void clearTransactionLeg2ProcessingTimes()

Clears the value of 'transactionLeg2ProcessingTimes'

Field Description

Records latencies for the second transaction processing leg.

Transaction Leg Two includes time spent from the point where the send/store commit completion is received to the submission of store/send commit (aka 'tleg2'). Note that each transaction leg is a portion of the overall commit time that is processed on the Aep Engine's thread. The sum of the transaction leg stats are important in that they determine the overall throughput that an application can sustain in terms of transactions per second.

See Also:

setTransactionLeg2ProcessingTimes(SrvMonIntSeries)

setTransactionLeg3ProcessingTimes

void setTransactionLeg3ProcessingTimes(SrvMonIntSeries val)

Sets the value of 'transactionLeg3ProcessingTimes'

Field Description

Transaction Leg Three includes time spent from the point where the store/store commit completion is received to the completion of the transaction commit (aka 'tleg3') . Note that each transaction leg is a portion of the overall commit time that is processed on the Aep Engine's thread. The sum of the transaction leg stats are important in that they determine the overall throughput that an application can sustain in terms of transactions per second.

Parameters:

val - The value to set.

lendTransactionLeg3ProcessingTimes

void lendTransactionLeg3ProcessingTimes(SrvMonIntSeries val)

'Lends' a reference of the SrvMonIntSeries to the message for this field.

Field Description

Transaction Leg Three includes time spent from the point where the store/store commit completion is received to the completion of the transaction commit (aka 'tleg3') . Note that each transaction leg is a portion of the overall commit time that is processed on the Aep Engine's thread. The sum of the transaction leg stats are important in that they determine the overall throughput that an application can sustain in terms of transactions per second.

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.

Parameters:

val - the value to 'lend' to lend.

getTransactionLeg3ProcessingTimes

SrvMonIntSeries getTransactionLeg3ProcessingTimes()

Gets the value of 'transactionLeg3ProcessingTimes'

Field Description

Transaction Leg Three includes time spent from the point where the store/store commit completion is received to the completion of the transaction commit (aka 'tleg3') . Note that each transaction leg is a portion of the overall commit time that is processed on the Aep Engine's thread. The sum of the transaction leg stats are important in that they determine the overall throughput that an application can sustain in terms of transactions per second.

Returns:

The value of 'transactionLeg3ProcessingTimes'

getTransactionLeg3ProcessingTimesTo

void getTransactionLeg3ProcessingTimesTo(SrvMonIntSeries val)

Copies the value of SrvMonIntSeries into the provided value.

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

Parameters:

val - the value to copy into

See Also:

SrvMonIntSeries.copyInto(SrvMonIntSeries)

takeTransactionLeg3ProcessingTimes

SrvMonIntSeries takeTransactionLeg3ProcessingTimes()

'Takes' a reference to the transactionLeg3ProcessingTimes field from the message.

Field Description

Transaction Leg Three includes time spent from the point where the store/store commit completion is received to the completion of the transaction commit (aka 'tleg3') . Note that each transaction leg is a portion of the overall commit time that is processed on the Aep Engine's thread. The sum of the transaction leg stats are important in that they determine the overall throughput that an application can sustain in terms of transactions per second.

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.

Returns:

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

hasTransactionLeg3ProcessingTimes

boolean hasTransactionLeg3ProcessingTimes()

Checks for the presence of 'transactionLeg3ProcessingTimes'

Field Description

Transaction Leg Three includes time spent from the point where the store/store commit completion is received to the completion of the transaction commit (aka 'tleg3') . Note that each transaction leg is a portion of the overall commit time that is processed on the Aep Engine's thread. The sum of the transaction leg stats are important in that they determine the overall throughput that an application can sustain in terms of transactions per second.

See Also:

getTransactionLeg3ProcessingTimes()

clearTransactionLeg3ProcessingTimes

void clearTransactionLeg3ProcessingTimes()

Clears the value of 'transactionLeg3ProcessingTimes'

Field Description

Transaction Leg Three includes time spent from the point where the store/store commit completion is received to the completion of the transaction commit (aka 'tleg3') . Note that each transaction leg is a portion of the overall commit time that is processed on the Aep Engine's thread. The sum of the transaction leg stats are important in that they determine the overall throughput that an application can sustain in terms of transactions per second.

See Also:

setTransactionLeg3ProcessingTimes(SrvMonIntSeries)

setCommitTransactionLatencies

@Deprecated
void setCommitTransactionLatencies(SrvMonIntSeries val)

Deprecated. - This field should not be used (it was a meant to be commitTransitionLatencies which should be used instead).

Sets the value of 'commitTransactionLatencies'

Parameters:

val - The value to set.

lendCommitTransactionLatencies

@Deprecated
void lendCommitTransactionLatencies(SrvMonIntSeries val)

Deprecated. - This field should not be used (it was a meant to be commitTransitionLatencies which should be used instead).

'Lends' a reference of the SrvMonIntSeries to the message for this field.

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.

Parameters:

val - the value to 'lend' to lend.

getCommitTransactionLatencies

@Deprecated
SrvMonIntSeries getCommitTransactionLatencies()

Deprecated. - This field should not be used (it was a meant to be commitTransitionLatencies which should be used instead).

Gets the value of 'commitTransactionLatencies'

Returns:

The value of 'commitTransactionLatencies'

getCommitTransactionLatenciesTo

@Deprecated
void getCommitTransactionLatenciesTo(SrvMonIntSeries val)

Deprecated. - This field should not be used (it was a meant to be commitTransitionLatencies which should be used instead).

Copies the value of SrvMonIntSeries into the provided value.

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

Parameters:

val - the value to copy into

See Also:

SrvMonIntSeries.copyInto(SrvMonIntSeries)

takeCommitTransactionLatencies

@Deprecated
SrvMonIntSeries takeCommitTransactionLatencies()

Deprecated. - This field should not be used (it was a meant to be commitTransitionLatencies which should be used instead).

'Takes' a reference to the commitTransactionLatencies field from the message.

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.

Returns:

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

hasCommitTransactionLatencies

@Deprecated
boolean hasCommitTransactionLatencies()

Deprecated. - This field should not be used (it was a meant to be commitTransitionLatencies which should be used instead).

Checks for the presence of 'commitTransactionLatencies'

See Also:

getCommitTransactionLatencies()

clearCommitTransactionLatencies

@Deprecated
void clearCommitTransactionLatencies()

Deprecated. - This field should not be used (it was a meant to be commitTransitionLatencies which should be used instead).

Clears the value of 'commitTransactionLatencies'

See Also:

setCommitTransactionLatencies(SrvMonIntSeries)

setMsgFilteringLatencies

void setMsgFilteringLatencies(SrvMonIntSeries val)

Sets the value of 'msgFilteringLatencies'

Field Description

Records latencies for application message filtering times (by a message filter) (aka 'mfilt').

Parameters:

val - The value to set.

lendMsgFilteringLatencies

void lendMsgFilteringLatencies(SrvMonIntSeries val)

'Lends' a reference of the SrvMonIntSeries to the message for this field.

Field Description

Records latencies for application message filtering times (by a message filter) (aka 'mfilt').

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.

Parameters:

val - the value to 'lend' to lend.

getMsgFilteringLatencies

SrvMonIntSeries getMsgFilteringLatencies()

Gets the value of 'msgFilteringLatencies'

Field Description

Records latencies for application message filtering times (by a message filter) (aka 'mfilt').

Returns:

Records latencies for application message filtering times (by a message filter) (aka 'mfilt').

getMsgFilteringLatenciesTo

void getMsgFilteringLatenciesTo(SrvMonIntSeries val)

Copies the value of SrvMonIntSeries into the provided value.

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

Parameters:

val - the value to copy into

See Also:

SrvMonIntSeries.copyInto(SrvMonIntSeries)

takeMsgFilteringLatencies

SrvMonIntSeries takeMsgFilteringLatencies()

'Takes' a reference to the msgFilteringLatencies field from the message.

Field Description

Records latencies for application message filtering times (by a message filter) (aka 'mfilt').

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.

Returns:

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

hasMsgFilteringLatencies

boolean hasMsgFilteringLatencies()

Checks for the presence of 'msgFilteringLatencies'

Field Description

Records latencies for application message filtering times (by a message filter) (aka 'mfilt').

See Also:

getMsgFilteringLatencies()

clearMsgFilteringLatencies

void clearMsgFilteringLatencies()

Clears the value of 'msgFilteringLatencies'

Field Description

Records latencies for application message filtering times (by a message filter) (aka 'mfilt').

See Also:

setMsgFilteringLatencies(SrvMonIntSeries)

setCommitTransitionLatencies

void setCommitTransitionLatencies(SrvMonIntSeries val)

Sets the value of 'commitTransitionLatencies'

Field Description

Time spent from the point the store or send commit completes, whichever is first to the start of next stage - send or commit (aka 'ctrans').

Parameters:

val - The value to set.

lendCommitTransitionLatencies

void lendCommitTransitionLatencies(SrvMonIntSeries val)

'Lends' a reference of the SrvMonIntSeries to the message for this field.

Field Description

Time spent from the point the store or send commit completes, whichever is first to the start of next stage - send or commit (aka 'ctrans').

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.

Parameters:

val - the value to 'lend' to lend.

getCommitTransitionLatencies

SrvMonIntSeries getCommitTransitionLatencies()

Gets the value of 'commitTransitionLatencies'

Field Description

Time spent from the point the store or send commit completes, whichever is first to the start of next stage - send or commit (aka 'ctrans').

Returns:

Time spent from the point the store or send commit completes, whichever is first to the start of next stage - send or commit (aka 'ctrans').

getCommitTransitionLatenciesTo

void getCommitTransitionLatenciesTo(SrvMonIntSeries val)

Copies the value of SrvMonIntSeries into the provided value.

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

Parameters:

val - the value to copy into

See Also:

SrvMonIntSeries.copyInto(SrvMonIntSeries)

takeCommitTransitionLatencies

SrvMonIntSeries takeCommitTransitionLatencies()

'Takes' a reference to the commitTransitionLatencies field from the message.

Field Description

Time spent from the point the store or send commit completes, whichever is first to the start of next stage - send or commit (aka 'ctrans').

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.

Returns:

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

hasCommitTransitionLatencies

boolean hasCommitTransitionLatencies()

Checks for the presence of 'commitTransitionLatencies'

Field Description

Time spent from the point the store or send commit completes, whichever is first to the start of next stage - send or commit (aka 'ctrans').

See Also:

getCommitTransitionLatencies()

clearCommitTransitionLatencies

void clearCommitTransitionLatencies()

Clears the value of 'commitTransitionLatencies'

Field Description

Time spent from the point the store or send commit completes, whichever is first to the start of next stage - send or commit (aka 'ctrans').

See Also:

setCommitTransitionLatencies(SrvMonIntSeries)

setInboundMessageLoggerStats

void setInboundMessageLoggerStats(SrvMonAppMessageLoggerStats val)

Sets the value of 'inboundMessageLoggerStats'

Field Description

Inbound message logger stats for applications with inbound message logging enabled.

Parameters:

val - The value to set.

lendInboundMessageLoggerStats

void lendInboundMessageLoggerStats(SrvMonAppMessageLoggerStats val)

'Lends' a reference of the SrvMonAppMessageLoggerStats to the message for this field.

Field Description

Inbound message logger stats for applications with inbound message logging enabled.

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.

Parameters:

val - the value to 'lend' to lend.

getInboundMessageLoggerStats

SrvMonAppMessageLoggerStats getInboundMessageLoggerStats()

Gets the value of 'inboundMessageLoggerStats'

Field Description

Inbound message logger stats for applications with inbound message logging enabled.

Returns:

Inbound message logger stats for applications with inbound message logging enabled.

getInboundMessageLoggerStatsTo

void getInboundMessageLoggerStatsTo(SrvMonAppMessageLoggerStats val)

Copies the value of SrvMonAppMessageLoggerStats into the provided value.

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

Parameters:

val - the value to copy into

See Also:

SrvMonAppMessageLoggerStats.copyInto(SrvMonAppMessageLoggerStats)

takeInboundMessageLoggerStats

SrvMonAppMessageLoggerStats takeInboundMessageLoggerStats()

'Takes' a reference to the inboundMessageLoggerStats field from the message.

Field Description

Inbound message logger stats for applications with inbound message logging enabled.

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.

Returns:

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

hasInboundMessageLoggerStats

boolean hasInboundMessageLoggerStats()

Checks for the presence of 'inboundMessageLoggerStats'

Field Description

Inbound message logger stats for applications with inbound message logging enabled.

See Also:

getInboundMessageLoggerStats()

clearInboundMessageLoggerStats

void clearInboundMessageLoggerStats()

Clears the value of 'inboundMessageLoggerStats'

Field Description

Inbound message logger stats for applications with inbound message logging enabled.

See Also:

setInboundMessageLoggerStats(SrvMonAppMessageLoggerStats)

setOutboundMessageLoggerStats

void setOutboundMessageLoggerStats(SrvMonAppMessageLoggerStats val)

Sets the value of 'outboundMessageLoggerStats'

Field Description

Outbound message logger stats for applications with outbound message logging enabled.

Parameters:

val - The value to set.

lendOutboundMessageLoggerStats

void lendOutboundMessageLoggerStats(SrvMonAppMessageLoggerStats val)

'Lends' a reference of the SrvMonAppMessageLoggerStats to the message for this field.

Field Description

Outbound message logger stats for applications with outbound message logging enabled.

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.

Parameters:

val - the value to 'lend' to lend.

getOutboundMessageLoggerStats

SrvMonAppMessageLoggerStats getOutboundMessageLoggerStats()

Gets the value of 'outboundMessageLoggerStats'

Field Description

Outbound message logger stats for applications with outbound message logging enabled.

Returns:

Outbound message logger stats for applications with outbound message logging enabled.

getOutboundMessageLoggerStatsTo

void getOutboundMessageLoggerStatsTo(SrvMonAppMessageLoggerStats val)

Copies the value of SrvMonAppMessageLoggerStats into the provided value.

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

Parameters:

val - the value to copy into

See Also:

SrvMonAppMessageLoggerStats.copyInto(SrvMonAppMessageLoggerStats)

takeOutboundMessageLoggerStats

SrvMonAppMessageLoggerStats takeOutboundMessageLoggerStats()

'Takes' a reference to the outboundMessageLoggerStats field from the message.

Field Description

Outbound message logger stats for applications with outbound message logging enabled.

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.

Returns:

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

hasOutboundMessageLoggerStats

boolean hasOutboundMessageLoggerStats()

Checks for the presence of 'outboundMessageLoggerStats'

Field Description

Outbound message logger stats for applications with outbound message logging enabled.

See Also:

getOutboundMessageLoggerStats()

clearOutboundMessageLoggerStats

void clearOutboundMessageLoggerStats()

Clears the value of 'outboundMessageLoggerStats'

Field Description

Outbound message logger stats for applications with outbound message logging enabled.

See Also:

setOutboundMessageLoggerStats(SrvMonAppMessageLoggerStats)

setMsgTypeStats

void setMsgTypeStats(SrvMonMsgTypeStats[] val)

Sets the value of 'msgTypeStats'

Field Description

Per message type stats (when enabled and included in heartbeats)

Per message type stats are included in heartbeats only when the XVM is configured to include them, they are collected for the application, and there was activity for the message type in the collection interval.

Parameters:

val - The value to set.

setMsgTypeStatsFrom

void setMsgTypeStatsFrom(XIterator<SrvMonMsgTypeStats> val)

Sets the value of 'msgTypeStats' using the values from the provided iterator.

This method will call XIterator.toFirst() before and after setting the values, meaning that all values from the iterator will be set and the iterator will be reset on return.

This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'msgTypeStats' accessor can copy the values without iteration.

Field Description

Per message type stats (when enabled and included in heartbeats)

Per message type stats are included in heartbeats only when the XVM is configured to include them, they are collected for the application, and there was activity for the message type in the collection interval.

NOTE:
Passing a null or empty list has the same affect as calling setMsgTypeStats(SrvMonMsgTypeStats[]) with a value of null.

Parameters:

val - the values to set.

lendMsgTypeStatsFrom

void lendMsgTypeStatsFrom(XIterator<SrvMonMsgTypeStats> val)

Sets the value of 'msgTypeStats' by lending the values from the provided iterator.

This method will call XIterator.toFirst() before and after setting the values, meaning that all values from the iterator will be set and the iterator will be reset on return.

This method will acquire references to each non null value in the provided iterator making it suitable for cases where the values come from another message that may be disposed.

This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'msgTypeStats' accessor can copy the values without iteration.

Field Description

Per message type stats (when enabled and included in heartbeats)

Per message type stats are included in heartbeats only when the XVM is configured to include them, they are collected for the application, and there was activity for the message type in the collection interval.

NOTE:
Passing a null or empty list has the same affect as calling setMsgTypeStats(SrvMonMsgTypeStats[]) with a value of null.

Parameters:

val - the values to set.

addMsgTypeStats

void addMsgTypeStats(SrvMonMsgTypeStats val)

Adds the provided value to the list of 'msgTypeStats' values.

This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'msgTypeStats' accessor can copy the values without iteration.

For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.

Field Description

Per message type stats (when enabled and included in heartbeats)

Per message type stats are included in heartbeats only when the XVM is configured to include them, they are collected for the application, and there was activity for the message type in the collection interval.

Parameters:

val - the value to add.

lendMsgTypeStats

void lendMsgTypeStats(SrvMonMsgTypeStats val)

Adds the provided value to the list of 'msgTypeStats' values and acquires a reference to it.

Lending of an added value is useful in cases where a field is being added from a source message to provide dispose of the source value when the source message is disposed.

This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'msgTypeStats' accessor can copy the values without iteration.

For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.

Field Description

Per message type stats (when enabled and included in heartbeats)

Per message type stats are included in heartbeats only when the XVM is configured to include them, they are collected for the application, and there was activity for the message type in the collection interval.

Parameters:

val - the value to add.

getMsgTypeStatsIterator

XIterator<SrvMonMsgTypeStats> getMsgTypeStatsIterator()

Gets the value of 'msgTypeStats' as iterator of values.

This method will always return a non null iterator value. The returned iterator is not threadsafe, and the caller may not hold on to it beyond the pooling lifespan of this object. Depending on the implementation, the same iterator instance may be returned by this object on each call to avoid garbage. Each time this method is called the iterator is reset by calling its toFirst() method. Callers should therefore be especially careful about calling this method while iterating on the iterator returned by this method.

The elements returned by this iterator are owned by and pooled along with this object. The caller. must call acquire() on each returned object that this object intends to keep beyond the lifespan. of this object (unless the element is lent to another object in which that object will acquire it then).

This method is zero garbage for Xbuf generated classes, and this method is optimized such that passing the returned iterator to another object's setXXX(XIterator method can perform a direct copy of the underlying values without iteration.

Field Description

Per message type stats (when enabled and included in heartbeats)

Per message type stats are included in heartbeats only when the XVM is configured to include them, they are collected for the application, and there was activity for the message type in the collection interval.

Returns:

An iterator containing this field values.

lendMsgTypeStats

void lendMsgTypeStats(SrvMonMsgTypeStats[] val)

Lends the value of 'msgTypeStats'

Field Description

Per message type stats (when enabled and included in heartbeats)

Per message type stats are included in heartbeats only when the XVM is configured to include them, they are collected for the application, and there was activity for the message type in the collection interval.

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.

Parameters:

val - the value to 'lend' to lend.

getMsgTypeStats

SrvMonMsgTypeStats[] getMsgTypeStats()

Gets the value of 'msgTypeStats'

If the field is not set this method will return null.

Field Description

Per message type stats (when enabled and included in heartbeats)

Per message type stats are included in heartbeats only when the XVM is configured to include them, they are collected for the application, and there was activity for the message type in the collection interval.

Returns:

Per message type stats (when enabled and included in heartbeats) If the field is not set this method will return null.

getMsgTypeStatsEmptyIfNull

SrvMonMsgTypeStats[] getMsgTypeStatsEmptyIfNull()

Gets the value of 'msgTypeStats' or an empty array if the value is null or not set.

Field Description

Per message type stats (when enabled and included in heartbeats)

Per message type stats are included in heartbeats only when the XVM is configured to include them, they are collected for the application, and there was activity for the message type in the collection interval.

Returns:

Per message type stats (when enabled and included in heartbeats) or an empty array if null if not set.

See Also:

getMsgTypeStats()

takeMsgTypeStats

SrvMonMsgTypeStats[] takeMsgTypeStats()

Takes the value of 'msgTypeStats'

Field Description

Per message type stats (when enabled and included in heartbeats)

Per message type stats are included in heartbeats only when the XVM is configured to include them, they are collected for the application, and there was activity for the message type in the collection interval.

NOTE:
A nested entity reference returned by getMsgTypeStats() 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.

Returns:

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

clearMsgTypeStats

void clearMsgTypeStats()

Clears the value of 'msgTypeStats'

Field Description

Per message type stats (when enabled and included in heartbeats)

Per message type stats are included in heartbeats only when the XVM is configured to include them, they are collected for the application, and there was activity for the message type in the collection interval.

See Also:

setMsgTypeStats(SrvMonMsgTypeStats[])