com.neeve.server.mon
Interface ISrvMonAppBusBindingStats

All Superinterfaces:

IRogValidatable

All Known Implementing Classes:

SrvMonAppBusBindingStats

@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 ISrvMonAppBusBindingStats
extends IRogValidatable

Records statistics for a message bus binding.

Method Summary

void	clearBusBindingName() Clears the value of 'busBindingName' Field Description The name of the bus
void	clearCreateToSendLatencies() Clears the value of 'createToSendLatencies' Field Description The create to send latencies in microseconds, the time in microseconds from message creation to when send was called for it (aka 'c2o').
void	clearDeserializeLatencies() Clears the value of 'deserializeLatencies' Field Description The time (in microseconds) spent deserializing the message and wrapping it in a MessageView (aka: 'd').
void	clearDeserializeToReceiveLatencies() Clears the value of 'deserializeToReceiveLatencies' Field Description The time (in microseconds) from when the message was deserialized to when it is received by the engine (aka: 'd2i').
void	clearDetachedCommit() Clears the value of 'detachedCommit' Field Description If the bus binding is operating in detached mode
void	clearDisruptorStats() Clears the value of 'disruptorStats' Field Description Disruptor statistics for the bus when operating in detached mode
void	clearInternal() Clears the value of 'internal' Field Description Indicates if this is an internal bus
void	clearNumAcksSent() Clears the value of 'numAcksSent' Field Description The number of inbound messages acknowledged by the bus
void	clearNumAsyncFlushCompletions() Clears the value of 'numAsyncFlushCompletions' Field Description The number of asynchronous flushes for this that have completed.
void	clearNumBindingFailures() Clears the value of 'numBindingFailures' Field Description The number of binding failures that have occurred for this bus.
void	clearNumChannelsUp() Clears the value of 'numChannelsUp' Field Description The number of channels brought up by this bus.
void	clearNumClients() Clears the value of 'numClients' Field Description The number of connected clients (if applicable)
void	clearNumCommits() Clears the value of 'numCommits' Field Description The number transactions committed by the bus.
void	clearNumFlushesAsync() Clears the value of 'numFlushesAsync' Field Description The number of times this bus has been asynchronously flushed.
void	clearNumFlushesSync() Clears the value of 'numFlushesSync' Field Description The number of times this bus has been synchronously flushed.
void	clearNumMsgBatchesRcvd() Clears the value of 'numMsgBatchesRcvd' Field Description The number of batch message received by the bus.
void	clearNumMsgsEnqueued() Clears the value of 'numMsgsEnqueued' Field Description The total number of batch messages enqueued for delivery by this bus.
void	clearNumMsgsFlushedAsync() Clears the value of 'numMsgsFlushedAsync' Field Description The number of messages flushed by asynchronous flushes.
void	clearNumMsgsFlushedSync() Clears the value of 'numMsgsFlushedSync' Field Description The number of messages flushed by synchronous flushes.
void	clearNumMsgsInBatchesRcvd() Clears the value of 'numMsgsInBatchesRcvd' Field Description The number of message received by the bus that were part of a batch
void	clearNumMsgsRcvd() Clears the value of 'numMsgsRcvd' Field Description The number of message received by the bus
void	clearNumMsgsSent() Clears the value of 'numMsgsSent' Field Description The total number of batch messages enqueued message that were actually sent by the bus.
void	clearNumPacketsRcvd() Clears the value of 'numPacketsRcvd' Field Description The number of raw packets received by the bus.
void	clearNumPartialRollbacks() Clears the value of 'numPartialRollbacks' Field Description The number of partial (savepoint) transaction roll back for the bus.
void	clearNumRollbacks() Clears the value of 'numRollbacks' Field Description The number transactions rolled back for the bus.
void	clearNumStabilityBatchesRcvd() Clears the value of 'numStabilityBatchesRcvd' Field Description The number of batched stability events received by this bus.
void	clearNumStabilityInBatchesRcvd() Clears the value of 'numStabilityInBatchesRcvd' Field Description The number of stability events received by this bus that were part of a stability batch.
void	clearNumStabilityRcvd() Clears the value of 'numStabilityRcvd' Field Description The number of stability events (acks) received by this bus.
void	clearOriginToReceiveLatencies() Clears the value of 'originToReceiveLatencies' Field Description The origin to receive latencies in microseconds (aka: 'o2i').
void	clearSendToPollLatencies() Clears the value of 'sendToPollLatencies' Field Description When the bus is operating in a detached mode, the time from when the message was offered for send until it is picked up send is started (aka: 'o2p').
void	clearSendToSerializeLatencies() Clears the value of 'sendToSerializeLatencies' Field Description The send to serialize latencies in microseconds, the time from when the message send is started until it was serialized in preparation for transmission on the wire (aka: 'o2s').
void	clearSerializeLatencies() Clears the value of 'serializeLatencies' Field Description The serialize latencies in microseconds, the spent serializing the MessageView to its transport encoding (aka: 's').
void	clearSerializeToWireLatencies() Clears the value of 'serializeToWireLatencies' Field Description The serialize to wire latencies in microseconds, the time post deserialize to when just before the message is written to the wire (aka: 's2w').
void	clearWireLatencies() Clears the value of 'wireLatencies' Field Description The wire latencies in microseconds, the time an inbound message spent on the wire (aka: 'w').
void	clearWireSendLatencies() Clears the value of 'wireSendLatencies' Field Description The wire send latencies in microseconds, he time spent by the message bus provider writing the message to the wire.
void	clearWireToDeserializeLatencies() Clears the value of 'wireToDeserializeLatencies' Field Description The time from when the serialized form was received from the wire to deserialization (aka: 'w2d').
void	clearWireToWireLatencies() Clears the value of 'wireToWireLatencies' Field Description The wire to wire latencies in microseconds, for outbound messages the time from when the corresponding inbound message was received off the wire to when the outbound message was written to the wire.
String	getBusBindingName() Gets the value of 'busBindingName' Field Description The name of the bus
<T extends XString> T	getBusBindingNameTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getBusBindingNameTo(XString val) Copies the value of 'busBindingName' into the provided XString.
XString	getBusBindingNameUnsafe() Gets the raw value of 'busBindingName'.
SrvMonIntSeries	getCreateToSendLatencies() Gets the value of 'createToSendLatencies' Field Description The create to send latencies in microseconds, the time in microseconds from message creation to when send was called for it (aka 'c2o').
void	getCreateToSendLatenciesTo(SrvMonIntSeries val) Copies the value of SrvMonIntSeries into the provided value.
SrvMonIntSeries	getDeserializeLatencies() Gets the value of 'deserializeLatencies' Field Description The time (in microseconds) spent deserializing the message and wrapping it in a MessageView (aka: 'd').
void	getDeserializeLatenciesTo(SrvMonIntSeries val) Copies the value of SrvMonIntSeries into the provided value.
SrvMonIntSeries	getDeserializeToReceiveLatencies() Gets the value of 'deserializeToReceiveLatencies' Field Description The time (in microseconds) from when the message was deserialized to when it is received by the engine (aka: 'd2i').
void	getDeserializeToReceiveLatenciesTo(SrvMonIntSeries val) Copies the value of SrvMonIntSeries into the provided value.
boolean	getDetachedCommit() Gets the value of 'detachedCommit' Field Description If the bus binding is operating in detached mode
SrvMonDisruptorStats	getDisruptorStats() Gets the value of 'disruptorStats' Field Description Disruptor statistics for the bus when operating in detached mode
void	getDisruptorStatsTo(SrvMonDisruptorStats val) Copies the value of SrvMonDisruptorStats into the provided value.
boolean	getInternal() Gets the value of 'internal' Field Description Indicates if this is an internal bus
long	getNumAcksSent() Gets the value of 'numAcksSent' Field Description The number of inbound messages acknowledged by the bus
long	getNumAsyncFlushCompletions() Gets the value of 'numAsyncFlushCompletions' Field Description The number of asynchronous flushes for this that have completed.
int	getNumBindingFailures() Gets the value of 'numBindingFailures' Field Description The number of binding failures that have occurred for this bus.
int	getNumChannelsUp() Gets the value of 'numChannelsUp' Field Description The number of channels brought up by this bus.
int	getNumClients() Gets the value of 'numClients' Field Description The number of connected clients (if applicable)
long	getNumCommits() Gets the value of 'numCommits' Field Description The number transactions committed by the bus.
long	getNumFlushesAsync() Gets the value of 'numFlushesAsync' Field Description The number of times this bus has been asynchronously flushed.
long	getNumFlushesSync() Gets the value of 'numFlushesSync' Field Description The number of times this bus has been synchronously flushed.
long	getNumMsgBatchesRcvd() Gets the value of 'numMsgBatchesRcvd' Field Description The number of batch message received by the bus.
long	getNumMsgsEnqueued() Gets the value of 'numMsgsEnqueued' Field Description The total number of batch messages enqueued for delivery by this bus.
long	getNumMsgsFlushedAsync() Gets the value of 'numMsgsFlushedAsync' Field Description The number of messages flushed by asynchronous flushes.
long	getNumMsgsFlushedSync() Gets the value of 'numMsgsFlushedSync' Field Description The number of messages flushed by synchronous flushes.
long	getNumMsgsInBatchesRcvd() Gets the value of 'numMsgsInBatchesRcvd' Field Description The number of message received by the bus that were part of a batch
long	getNumMsgsRcvd() Gets the value of 'numMsgsRcvd' Field Description The number of message received by the bus
long	getNumMsgsSent() Gets the value of 'numMsgsSent' Field Description The total number of batch messages enqueued message that were actually sent by the bus.
long	getNumPacketsRcvd() Gets the value of 'numPacketsRcvd' Field Description The number of raw packets received by the bus.
long	getNumPartialRollbacks() Gets the value of 'numPartialRollbacks' Field Description The number of partial (savepoint) transaction roll back for the bus.
long	getNumRollbacks() Gets the value of 'numRollbacks' Field Description The number transactions rolled back for the bus.
long	getNumStabilityBatchesRcvd() Gets the value of 'numStabilityBatchesRcvd' Field Description The number of batched stability events received by this bus.
long	getNumStabilityInBatchesRcvd() Gets the value of 'numStabilityInBatchesRcvd' Field Description The number of stability events received by this bus that were part of a stability batch.
long	getNumStabilityRcvd() Gets the value of 'numStabilityRcvd' Field Description The number of stability events (acks) received by this bus.
SrvMonIntSeries	getOriginToReceiveLatencies() Gets the value of 'originToReceiveLatencies' Field Description The origin to receive latencies in microseconds (aka: 'o2i').
void	getOriginToReceiveLatenciesTo(SrvMonIntSeries val) Copies the value of SrvMonIntSeries into the provided value.
SrvMonIntSeries	getSendToPollLatencies() Gets the value of 'sendToPollLatencies' Field Description When the bus is operating in a detached mode, the time from when the message was offered for send until it is picked up send is started (aka: 'o2p').
void	getSendToPollLatenciesTo(SrvMonIntSeries val) Copies the value of SrvMonIntSeries into the provided value.
SrvMonIntSeries	getSendToSerializeLatencies() Gets the value of 'sendToSerializeLatencies' Field Description The send to serialize latencies in microseconds, the time from when the message send is started until it was serialized in preparation for transmission on the wire (aka: 'o2s').
void	getSendToSerializeLatenciesTo(SrvMonIntSeries val) Copies the value of SrvMonIntSeries into the provided value.
SrvMonIntSeries	getSerializeLatencies() Gets the value of 'serializeLatencies' Field Description The serialize latencies in microseconds, the spent serializing the MessageView to its transport encoding (aka: 's').
void	getSerializeLatenciesTo(SrvMonIntSeries val) Copies the value of SrvMonIntSeries into the provided value.
SrvMonIntSeries	getSerializeToWireLatencies() Gets the value of 'serializeToWireLatencies' Field Description The serialize to wire latencies in microseconds, the time post deserialize to when just before the message is written to the wire (aka: 's2w').
void	getSerializeToWireLatenciesTo(SrvMonIntSeries val) Copies the value of SrvMonIntSeries into the provided value.
SrvMonIntSeries	getWireLatencies() Gets the value of 'wireLatencies' Field Description The wire latencies in microseconds, the time an inbound message spent on the wire (aka: 'w').
void	getWireLatenciesTo(SrvMonIntSeries val) Copies the value of SrvMonIntSeries into the provided value.
SrvMonIntSeries	getWireSendLatencies() Gets the value of 'wireSendLatencies' Field Description The wire send latencies in microseconds, he time spent by the message bus provider writing the message to the wire.
void	getWireSendLatenciesTo(SrvMonIntSeries val) Copies the value of SrvMonIntSeries into the provided value.
SrvMonIntSeries	getWireToDeserializeLatencies() Gets the value of 'wireToDeserializeLatencies' Field Description The time from when the serialized form was received from the wire to deserialization (aka: 'w2d').
void	getWireToDeserializeLatenciesTo(SrvMonIntSeries val) Copies the value of SrvMonIntSeries into the provided value.
SrvMonIntSeries	getWireToWireLatencies() Gets the value of 'wireToWireLatencies' Field Description The wire to wire latencies in microseconds, for outbound messages the time from when the corresponding inbound message was received off the wire to when the outbound message was written to the wire.
void	getWireToWireLatenciesTo(SrvMonIntSeries val) Copies the value of SrvMonIntSeries into the provided value.
boolean	hasBusBindingName() Checks for the presence of 'busBindingName' Field Description The name of the bus
boolean	hasCreateToSendLatencies() Checks for the presence of 'createToSendLatencies' Field Description The create to send latencies in microseconds, the time in microseconds from message creation to when send was called for it (aka 'c2o').
boolean	hasDeserializeLatencies() Checks for the presence of 'deserializeLatencies' Field Description The time (in microseconds) spent deserializing the message and wrapping it in a MessageView (aka: 'd').
boolean	hasDeserializeToReceiveLatencies() Checks for the presence of 'deserializeToReceiveLatencies' Field Description The time (in microseconds) from when the message was deserialized to when it is received by the engine (aka: 'd2i').
boolean	hasDetachedCommit() Checks for the presence of 'detachedCommit' Field Description If the bus binding is operating in detached mode
boolean	hasDisruptorStats() Checks for the presence of 'disruptorStats' Field Description Disruptor statistics for the bus when operating in detached mode
boolean	hasInternal() Checks for the presence of 'internal' Field Description Indicates if this is an internal bus
boolean	hasNumAcksSent() Checks for the presence of 'numAcksSent' Field Description The number of inbound messages acknowledged by the bus
boolean	hasNumAsyncFlushCompletions() Checks for the presence of 'numAsyncFlushCompletions' Field Description The number of asynchronous flushes for this that have completed.
boolean	hasNumBindingFailures() Checks for the presence of 'numBindingFailures' Field Description The number of binding failures that have occurred for this bus.
boolean	hasNumChannelsUp() Checks for the presence of 'numChannelsUp' Field Description The number of channels brought up by this bus.
boolean	hasNumClients() Checks for the presence of 'numClients' Field Description The number of connected clients (if applicable)
boolean	hasNumCommits() Checks for the presence of 'numCommits' Field Description The number transactions committed by the bus.
boolean	hasNumFlushesAsync() Checks for the presence of 'numFlushesAsync' Field Description The number of times this bus has been asynchronously flushed.
boolean	hasNumFlushesSync() Checks for the presence of 'numFlushesSync' Field Description The number of times this bus has been synchronously flushed.
boolean	hasNumMsgBatchesRcvd() Checks for the presence of 'numMsgBatchesRcvd' Field Description The number of batch message received by the bus.
boolean	hasNumMsgsEnqueued() Checks for the presence of 'numMsgsEnqueued' Field Description The total number of batch messages enqueued for delivery by this bus.
boolean	hasNumMsgsFlushedAsync() Checks for the presence of 'numMsgsFlushedAsync' Field Description The number of messages flushed by asynchronous flushes.
boolean	hasNumMsgsFlushedSync() Checks for the presence of 'numMsgsFlushedSync' Field Description The number of messages flushed by synchronous flushes.
boolean	hasNumMsgsInBatchesRcvd() Checks for the presence of 'numMsgsInBatchesRcvd' Field Description The number of message received by the bus that were part of a batch
boolean	hasNumMsgsRcvd() Checks for the presence of 'numMsgsRcvd' Field Description The number of message received by the bus
boolean	hasNumMsgsSent() Checks for the presence of 'numMsgsSent' Field Description The total number of batch messages enqueued message that were actually sent by the bus.
boolean	hasNumPacketsRcvd() Checks for the presence of 'numPacketsRcvd' Field Description The number of raw packets received by the bus.
boolean	hasNumPartialRollbacks() Checks for the presence of 'numPartialRollbacks' Field Description The number of partial (savepoint) transaction roll back for the bus.
boolean	hasNumRollbacks() Checks for the presence of 'numRollbacks' Field Description The number transactions rolled back for the bus.
boolean	hasNumStabilityBatchesRcvd() Checks for the presence of 'numStabilityBatchesRcvd' Field Description The number of batched stability events received by this bus.
boolean	hasNumStabilityInBatchesRcvd() Checks for the presence of 'numStabilityInBatchesRcvd' Field Description The number of stability events received by this bus that were part of a stability batch.
boolean	hasNumStabilityRcvd() Checks for the presence of 'numStabilityRcvd' Field Description The number of stability events (acks) received by this bus.
boolean	hasOriginToReceiveLatencies() Checks for the presence of 'originToReceiveLatencies' Field Description The origin to receive latencies in microseconds (aka: 'o2i').
boolean	hasSendToPollLatencies() Checks for the presence of 'sendToPollLatencies' Field Description When the bus is operating in a detached mode, the time from when the message was offered for send until it is picked up send is started (aka: 'o2p').
boolean	hasSendToSerializeLatencies() Checks for the presence of 'sendToSerializeLatencies' Field Description The send to serialize latencies in microseconds, the time from when the message send is started until it was serialized in preparation for transmission on the wire (aka: 'o2s').
boolean	hasSerializeLatencies() Checks for the presence of 'serializeLatencies' Field Description The serialize latencies in microseconds, the spent serializing the MessageView to its transport encoding (aka: 's').
boolean	hasSerializeToWireLatencies() Checks for the presence of 'serializeToWireLatencies' Field Description The serialize to wire latencies in microseconds, the time post deserialize to when just before the message is written to the wire (aka: 's2w').
boolean	hasWireLatencies() Checks for the presence of 'wireLatencies' Field Description The wire latencies in microseconds, the time an inbound message spent on the wire (aka: 'w').
boolean	hasWireSendLatencies() Checks for the presence of 'wireSendLatencies' Field Description The wire send latencies in microseconds, he time spent by the message bus provider writing the message to the wire.
boolean	hasWireToDeserializeLatencies() Checks for the presence of 'wireToDeserializeLatencies' Field Description The time from when the serialized form was received from the wire to deserialization (aka: 'w2d').
boolean	hasWireToWireLatencies() Checks for the presence of 'wireToWireLatencies' Field Description The wire to wire latencies in microseconds, for outbound messages the time from when the corresponding inbound message was received off the wire to when the outbound message was written to the wire.
void	lendBusBindingName(XString val) Sets the value of 'busBindingName' Field Description The name of the bus
void	lendCreateToSendLatencies(SrvMonIntSeries val) 'Lends' a reference of the SrvMonIntSeries to the message for this field.
void	lendDeserializeLatencies(SrvMonIntSeries val) 'Lends' a reference of the SrvMonIntSeries to the message for this field.
void	lendDeserializeToReceiveLatencies(SrvMonIntSeries val) 'Lends' a reference of the SrvMonIntSeries to the message for this field.
void	lendDisruptorStats(SrvMonDisruptorStats val) 'Lends' a reference of the SrvMonDisruptorStats to the message for this field.
void	lendOriginToReceiveLatencies(SrvMonIntSeries val) 'Lends' a reference of the SrvMonIntSeries to the message for this field.
void	lendSendToPollLatencies(SrvMonIntSeries val) 'Lends' a reference of the SrvMonIntSeries to the message for this field.
void	lendSendToSerializeLatencies(SrvMonIntSeries val) 'Lends' a reference of the SrvMonIntSeries to the message for this field.
void	lendSerializeLatencies(SrvMonIntSeries val) 'Lends' a reference of the SrvMonIntSeries to the message for this field.
void	lendSerializeToWireLatencies(SrvMonIntSeries val) 'Lends' a reference of the SrvMonIntSeries to the message for this field.
void	lendWireLatencies(SrvMonIntSeries val) 'Lends' a reference of the SrvMonIntSeries to the message for this field.
void	lendWireSendLatencies(SrvMonIntSeries val) 'Lends' a reference of the SrvMonIntSeries to the message for this field.
void	lendWireToDeserializeLatencies(SrvMonIntSeries val) 'Lends' a reference of the SrvMonIntSeries to the message for this field.
void	lendWireToWireLatencies(SrvMonIntSeries val) 'Lends' a reference of the SrvMonIntSeries to the message for this field.
void	setBusBindingName(String val) Sets the value of 'busBindingName' Field Description The name of the bus
void	setBusBindingNameFrom(long val) Sets the value of this String field to the given numeric value.
void	setBusBindingNameFrom(XString val) Copies the provided XString value into this object's 'busBindingName'.
void	setCreateToSendLatencies(SrvMonIntSeries val) Sets the value of 'createToSendLatencies' Field Description The create to send latencies in microseconds, the time in microseconds from message creation to when send was called for it (aka 'c2o').
void	setDeserializeLatencies(SrvMonIntSeries val) Sets the value of 'deserializeLatencies' Field Description The time (in microseconds) spent deserializing the message and wrapping it in a MessageView (aka: 'd').
void	setDeserializeToReceiveLatencies(SrvMonIntSeries val) Sets the value of 'deserializeToReceiveLatencies' Field Description The time (in microseconds) from when the message was deserialized to when it is received by the engine (aka: 'd2i').
void	setDetachedCommit(boolean val) Sets the value of 'detachedCommit' Field Description If the bus binding is operating in detached mode
void	setDisruptorStats(SrvMonDisruptorStats val) Sets the value of 'disruptorStats' Field Description Disruptor statistics for the bus when operating in detached mode
void	setInternal(boolean val) Sets the value of 'internal' Field Description Indicates if this is an internal bus
void	setNumAcksSent(long val) Sets the value of 'numAcksSent' Field Description The number of inbound messages acknowledged by the bus
void	setNumAsyncFlushCompletions(long val) Sets the value of 'numAsyncFlushCompletions' Field Description The number of asynchronous flushes for this that have completed.
void	setNumBindingFailures(int val) Sets the value of 'numBindingFailures' Field Description The number of binding failures that have occurred for this bus.
void	setNumChannelsUp(int val) Sets the value of 'numChannelsUp' Field Description The number of channels brought up by this bus.
void	setNumClients(int val) Sets the value of 'numClients' Field Description The number of connected clients (if applicable)
void	setNumCommits(long val) Sets the value of 'numCommits' Field Description The number transactions committed by the bus.
void	setNumFlushesAsync(long val) Sets the value of 'numFlushesAsync' Field Description The number of times this bus has been asynchronously flushed.
void	setNumFlushesSync(long val) Sets the value of 'numFlushesSync' Field Description The number of times this bus has been synchronously flushed.
void	setNumMsgBatchesRcvd(long val) Sets the value of 'numMsgBatchesRcvd' Field Description The number of batch message received by the bus.
void	setNumMsgsEnqueued(long val) Sets the value of 'numMsgsEnqueued' Field Description The total number of batch messages enqueued for delivery by this bus.
void	setNumMsgsFlushedAsync(long val) Sets the value of 'numMsgsFlushedAsync' Field Description The number of messages flushed by asynchronous flushes.
void	setNumMsgsFlushedSync(long val) Sets the value of 'numMsgsFlushedSync' Field Description The number of messages flushed by synchronous flushes.
void	setNumMsgsInBatchesRcvd(long val) Sets the value of 'numMsgsInBatchesRcvd' Field Description The number of message received by the bus that were part of a batch
void	setNumMsgsRcvd(long val) Sets the value of 'numMsgsRcvd' Field Description The number of message received by the bus
void	setNumMsgsSent(long val) Sets the value of 'numMsgsSent' Field Description The total number of batch messages enqueued message that were actually sent by the bus.
void	setNumPacketsRcvd(long val) Sets the value of 'numPacketsRcvd' Field Description The number of raw packets received by the bus.
void	setNumPartialRollbacks(long val) Sets the value of 'numPartialRollbacks' Field Description The number of partial (savepoint) transaction roll back for the bus.
void	setNumRollbacks(long val) Sets the value of 'numRollbacks' Field Description The number transactions rolled back for the bus.
void	setNumStabilityBatchesRcvd(long val) Sets the value of 'numStabilityBatchesRcvd' Field Description The number of batched stability events received by this bus.
void	setNumStabilityInBatchesRcvd(long val) Sets the value of 'numStabilityInBatchesRcvd' Field Description The number of stability events received by this bus that were part of a stability batch.
void	setNumStabilityRcvd(long val) Sets the value of 'numStabilityRcvd' Field Description The number of stability events (acks) received by this bus.
void	setOriginToReceiveLatencies(SrvMonIntSeries val) Sets the value of 'originToReceiveLatencies' Field Description The origin to receive latencies in microseconds (aka: 'o2i').
void	setSendToPollLatencies(SrvMonIntSeries val) Sets the value of 'sendToPollLatencies' Field Description When the bus is operating in a detached mode, the time from when the message was offered for send until it is picked up send is started (aka: 'o2p').
void	setSendToSerializeLatencies(SrvMonIntSeries val) Sets the value of 'sendToSerializeLatencies' Field Description The send to serialize latencies in microseconds, the time from when the message send is started until it was serialized in preparation for transmission on the wire (aka: 'o2s').
void	setSerializeLatencies(SrvMonIntSeries val) Sets the value of 'serializeLatencies' Field Description The serialize latencies in microseconds, the spent serializing the MessageView to its transport encoding (aka: 's').
void	setSerializeToWireLatencies(SrvMonIntSeries val) Sets the value of 'serializeToWireLatencies' Field Description The serialize to wire latencies in microseconds, the time post deserialize to when just before the message is written to the wire (aka: 's2w').
void	setWireLatencies(SrvMonIntSeries val) Sets the value of 'wireLatencies' Field Description The wire latencies in microseconds, the time an inbound message spent on the wire (aka: 'w').
void	setWireSendLatencies(SrvMonIntSeries val) Sets the value of 'wireSendLatencies' Field Description The wire send latencies in microseconds, he time spent by the message bus provider writing the message to the wire.
void	setWireToDeserializeLatencies(SrvMonIntSeries val) Sets the value of 'wireToDeserializeLatencies' Field Description The time from when the serialized form was received from the wire to deserialization (aka: 'w2d').
void	setWireToWireLatencies(SrvMonIntSeries val) Sets the value of 'wireToWireLatencies' Field Description The wire to wire latencies in microseconds, for outbound messages the time from when the corresponding inbound message was received off the wire to when the outbound message was written to the wire.
SrvMonIntSeries	takeCreateToSendLatencies() 'Takes' a reference to the createToSendLatencies field from the message.
SrvMonIntSeries	takeDeserializeLatencies() 'Takes' a reference to the deserializeLatencies field from the message.
SrvMonIntSeries	takeDeserializeToReceiveLatencies() 'Takes' a reference to the deserializeToReceiveLatencies field from the message.
SrvMonDisruptorStats	takeDisruptorStats() 'Takes' a reference to the disruptorStats field from the message.
SrvMonIntSeries	takeOriginToReceiveLatencies() 'Takes' a reference to the originToReceiveLatencies field from the message.
SrvMonIntSeries	takeSendToPollLatencies() 'Takes' a reference to the sendToPollLatencies field from the message.
SrvMonIntSeries	takeSendToSerializeLatencies() 'Takes' a reference to the sendToSerializeLatencies field from the message.
SrvMonIntSeries	takeSerializeLatencies() 'Takes' a reference to the serializeLatencies field from the message.
SrvMonIntSeries	takeSerializeToWireLatencies() 'Takes' a reference to the serializeToWireLatencies field from the message.
SrvMonIntSeries	takeWireLatencies() 'Takes' a reference to the wireLatencies field from the message.
SrvMonIntSeries	takeWireSendLatencies() 'Takes' a reference to the wireSendLatencies field from the message.
SrvMonIntSeries	takeWireToDeserializeLatencies() 'Takes' a reference to the wireToDeserializeLatencies field from the message.
SrvMonIntSeries	takeWireToWireLatencies() 'Takes' a reference to the wireToWireLatencies field from the message.

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

setNumMsgsRcvd

void setNumMsgsRcvd(long val)

Sets the value of 'numMsgsRcvd'

Field Description

The number of message received by the bus

Parameters:

val - The value to set.

getNumMsgsRcvd

long getNumMsgsRcvd()

Gets the value of 'numMsgsRcvd'

Field Description

The number of message received by the bus

Returns:

The number of message received by the bus

clearNumMsgsRcvd

void clearNumMsgsRcvd()

Clears the value of 'numMsgsRcvd'

Field Description

The number of message received by the bus

See Also:

setNumMsgsRcvd(long)

hasNumMsgsRcvd

boolean hasNumMsgsRcvd()

Checks for the presence of 'numMsgsRcvd'

Field Description

The number of message received by the bus

See Also:

getNumMsgsRcvd()

setNumMsgsInBatchesRcvd

void setNumMsgsInBatchesRcvd(long val)

Sets the value of 'numMsgsInBatchesRcvd'

Field Description

The number of message received by the bus that were part of a batch

Parameters:

val - The value to set.

getNumMsgsInBatchesRcvd

long getNumMsgsInBatchesRcvd()

Gets the value of 'numMsgsInBatchesRcvd'

Field Description

The number of message received by the bus that were part of a batch

Returns:

The number of message received by the bus that were part of a batch

clearNumMsgsInBatchesRcvd

void clearNumMsgsInBatchesRcvd()

Clears the value of 'numMsgsInBatchesRcvd'

Field Description

The number of message received by the bus that were part of a batch

See Also:

setNumMsgsInBatchesRcvd(long)

hasNumMsgsInBatchesRcvd

boolean hasNumMsgsInBatchesRcvd()

Checks for the presence of 'numMsgsInBatchesRcvd'

Field Description

The number of message received by the bus that were part of a batch

See Also:

getNumMsgsInBatchesRcvd()

setNumMsgBatchesRcvd

void setNumMsgBatchesRcvd(long val)

Sets the value of 'numMsgBatchesRcvd'

Field Description

The number of batch message received by the bus.

Parameters:

val - The value to set.

getNumMsgBatchesRcvd

long getNumMsgBatchesRcvd()

Gets the value of 'numMsgBatchesRcvd'

Field Description

The number of batch message received by the bus.

Returns:

The number of batch message received by the bus.

clearNumMsgBatchesRcvd

void clearNumMsgBatchesRcvd()

Clears the value of 'numMsgBatchesRcvd'

Field Description

The number of batch message received by the bus.

See Also:

setNumMsgBatchesRcvd(long)

hasNumMsgBatchesRcvd

boolean hasNumMsgBatchesRcvd()

Checks for the presence of 'numMsgBatchesRcvd'

Field Description

The number of batch message received by the bus.

See Also:

getNumMsgBatchesRcvd()

setNumMsgsEnqueued

void setNumMsgsEnqueued(long val)

Sets the value of 'numMsgsEnqueued'

Field Description

The total number of batch messages enqueued for delivery by this bus.

Parameters:

val - The value to set.

getNumMsgsEnqueued

long getNumMsgsEnqueued()

Gets the value of 'numMsgsEnqueued'

Field Description

The total number of batch messages enqueued for delivery by this bus.

Returns:

The total number of batch messages enqueued for delivery by this bus.

clearNumMsgsEnqueued

void clearNumMsgsEnqueued()

Clears the value of 'numMsgsEnqueued'

Field Description

The total number of batch messages enqueued for delivery by this bus.

See Also:

setNumMsgsEnqueued(long)

hasNumMsgsEnqueued

boolean hasNumMsgsEnqueued()

Checks for the presence of 'numMsgsEnqueued'

Field Description

The total number of batch messages enqueued for delivery by this bus.

See Also:

getNumMsgsEnqueued()

setNumMsgsSent

void setNumMsgsSent(long val)

Sets the value of 'numMsgsSent'

Field Description

The total number of batch messages enqueued message that were actually sent by the bus.

Parameters:

val - The value to set.

getNumMsgsSent

long getNumMsgsSent()

Gets the value of 'numMsgsSent'

Field Description

The total number of batch messages enqueued message that were actually sent by the bus.

Returns:

The total number of batch messages enqueued message that were actually sent by the bus.

clearNumMsgsSent

void clearNumMsgsSent()

Clears the value of 'numMsgsSent'

Field Description

The total number of batch messages enqueued message that were actually sent by the bus.

See Also:

setNumMsgsSent(long)

hasNumMsgsSent

boolean hasNumMsgsSent()

Checks for the presence of 'numMsgsSent'

Field Description

The total number of batch messages enqueued message that were actually sent by the bus.

See Also:

getNumMsgsSent()

setNumFlushesSync

void setNumFlushesSync(long val)

Sets the value of 'numFlushesSync'

Field Description

The number of times this bus has been synchronously flushed.

Parameters:

val - The value to set.

getNumFlushesSync

long getNumFlushesSync()

Gets the value of 'numFlushesSync'

Field Description

The number of times this bus has been synchronously flushed.

Returns:

The number of times this bus has been synchronously flushed.

clearNumFlushesSync

void clearNumFlushesSync()

Clears the value of 'numFlushesSync'

Field Description

The number of times this bus has been synchronously flushed.

See Also:

setNumFlushesSync(long)

hasNumFlushesSync

boolean hasNumFlushesSync()

Checks for the presence of 'numFlushesSync'

Field Description

The number of times this bus has been synchronously flushed.

See Also:

getNumFlushesSync()

setNumMsgsFlushedSync

void setNumMsgsFlushedSync(long val)

Sets the value of 'numMsgsFlushedSync'

Field Description

The number of messages flushed by synchronous flushes.

Parameters:

val - The value to set.

getNumMsgsFlushedSync

long getNumMsgsFlushedSync()

Gets the value of 'numMsgsFlushedSync'

Field Description

The number of messages flushed by synchronous flushes.

Returns:

The number of messages flushed by synchronous flushes.

clearNumMsgsFlushedSync

void clearNumMsgsFlushedSync()

Clears the value of 'numMsgsFlushedSync'

Field Description

The number of messages flushed by synchronous flushes.

See Also:

setNumMsgsFlushedSync(long)

hasNumMsgsFlushedSync

boolean hasNumMsgsFlushedSync()

Checks for the presence of 'numMsgsFlushedSync'

Field Description

The number of messages flushed by synchronous flushes.

See Also:

getNumMsgsFlushedSync()

setNumFlushesAsync

void setNumFlushesAsync(long val)

Sets the value of 'numFlushesAsync'

Field Description

The number of times this bus has been asynchronously flushed.

Parameters:

val - The value to set.

getNumFlushesAsync

long getNumFlushesAsync()

Gets the value of 'numFlushesAsync'

Field Description

The number of times this bus has been asynchronously flushed.

Returns:

The number of times this bus has been asynchronously flushed.

clearNumFlushesAsync

void clearNumFlushesAsync()

Clears the value of 'numFlushesAsync'

Field Description

The number of times this bus has been asynchronously flushed.

See Also:

setNumFlushesAsync(long)

hasNumFlushesAsync

boolean hasNumFlushesAsync()

Checks for the presence of 'numFlushesAsync'

Field Description

The number of times this bus has been asynchronously flushed.

See Also:

getNumFlushesAsync()

setNumAsyncFlushCompletions

void setNumAsyncFlushCompletions(long val)

Sets the value of 'numAsyncFlushCompletions'

Field Description

The number of asynchronous flushes for this that have completed.

Parameters:

val - The value to set.

getNumAsyncFlushCompletions

long getNumAsyncFlushCompletions()

Gets the value of 'numAsyncFlushCompletions'

Field Description

The number of asynchronous flushes for this that have completed.

Returns:

The number of asynchronous flushes for this that have completed.

clearNumAsyncFlushCompletions

void clearNumAsyncFlushCompletions()

Clears the value of 'numAsyncFlushCompletions'

Field Description

The number of asynchronous flushes for this that have completed.

See Also:

setNumAsyncFlushCompletions(long)

hasNumAsyncFlushCompletions

boolean hasNumAsyncFlushCompletions()

Checks for the presence of 'numAsyncFlushCompletions'

Field Description

The number of asynchronous flushes for this that have completed.

See Also:

getNumAsyncFlushCompletions()

setNumMsgsFlushedAsync

void setNumMsgsFlushedAsync(long val)

Sets the value of 'numMsgsFlushedAsync'

Field Description

The number of messages flushed by asynchronous flushes.

Parameters:

val - The value to set.

getNumMsgsFlushedAsync

long getNumMsgsFlushedAsync()

Gets the value of 'numMsgsFlushedAsync'

Field Description

The number of messages flushed by asynchronous flushes.

Returns:

The number of messages flushed by asynchronous flushes.

clearNumMsgsFlushedAsync

void clearNumMsgsFlushedAsync()

Clears the value of 'numMsgsFlushedAsync'

Field Description

The number of messages flushed by asynchronous flushes.

See Also:

setNumMsgsFlushedAsync(long)

hasNumMsgsFlushedAsync

boolean hasNumMsgsFlushedAsync()

Checks for the presence of 'numMsgsFlushedAsync'

Field Description

The number of messages flushed by asynchronous flushes.

See Also:

getNumMsgsFlushedAsync()

setNumStabilityRcvd

void setNumStabilityRcvd(long val)

Sets the value of 'numStabilityRcvd'

Field Description

The number of stability events (acks) received by this bus.

Parameters:

val - The value to set.

getNumStabilityRcvd

long getNumStabilityRcvd()

Gets the value of 'numStabilityRcvd'

Field Description

The number of stability events (acks) received by this bus.

Returns:

The number of stability events (acks) received by this bus.

clearNumStabilityRcvd

void clearNumStabilityRcvd()

Clears the value of 'numStabilityRcvd'

Field Description

The number of stability events (acks) received by this bus.

See Also:

setNumStabilityRcvd(long)

hasNumStabilityRcvd

boolean hasNumStabilityRcvd()

Checks for the presence of 'numStabilityRcvd'

Field Description

The number of stability events (acks) received by this bus.

See Also:

getNumStabilityRcvd()

setNumStabilityInBatchesRcvd

void setNumStabilityInBatchesRcvd(long val)

Sets the value of 'numStabilityInBatchesRcvd'

Field Description

The number of stability events received by this bus that were part of a stability batch.

Parameters:

val - The value to set.

getNumStabilityInBatchesRcvd

long getNumStabilityInBatchesRcvd()

Gets the value of 'numStabilityInBatchesRcvd'

Field Description

The number of stability events received by this bus that were part of a stability batch.

Returns:

The number of stability events received by this bus that were part of a stability batch.

clearNumStabilityInBatchesRcvd

void clearNumStabilityInBatchesRcvd()

Clears the value of 'numStabilityInBatchesRcvd'

Field Description

The number of stability events received by this bus that were part of a stability batch.

See Also:

setNumStabilityInBatchesRcvd(long)

hasNumStabilityInBatchesRcvd

boolean hasNumStabilityInBatchesRcvd()

Checks for the presence of 'numStabilityInBatchesRcvd'

Field Description

The number of stability events received by this bus that were part of a stability batch.

See Also:

getNumStabilityInBatchesRcvd()

setNumStabilityBatchesRcvd

void setNumStabilityBatchesRcvd(long val)

Sets the value of 'numStabilityBatchesRcvd'

Field Description

The number of batched stability events received by this bus.

Parameters:

val - The value to set.

getNumStabilityBatchesRcvd

long getNumStabilityBatchesRcvd()

Gets the value of 'numStabilityBatchesRcvd'

Field Description

The number of batched stability events received by this bus.

Returns:

The number of batched stability events received by this bus.

clearNumStabilityBatchesRcvd

void clearNumStabilityBatchesRcvd()

Clears the value of 'numStabilityBatchesRcvd'

Field Description

The number of batched stability events received by this bus.

See Also:

setNumStabilityBatchesRcvd(long)

hasNumStabilityBatchesRcvd

boolean hasNumStabilityBatchesRcvd()

Checks for the presence of 'numStabilityBatchesRcvd'

Field Description

The number of batched stability events received by this bus.

See Also:

getNumStabilityBatchesRcvd()

setNumPacketsRcvd

void setNumPacketsRcvd(long val)

Sets the value of 'numPacketsRcvd'

Field Description

The number of raw packets received by the bus.

Parameters:

val - The value to set.

getNumPacketsRcvd

long getNumPacketsRcvd()

Gets the value of 'numPacketsRcvd'

Field Description

The number of raw packets received by the bus.

Returns:

The number of raw packets received by the bus.

clearNumPacketsRcvd

void clearNumPacketsRcvd()

Clears the value of 'numPacketsRcvd'

Field Description

The number of raw packets received by the bus.

See Also:

setNumPacketsRcvd(long)

hasNumPacketsRcvd

boolean hasNumPacketsRcvd()

Checks for the presence of 'numPacketsRcvd'

Field Description

The number of raw packets received by the bus.

See Also:

getNumPacketsRcvd()

setNumCommits

void setNumCommits(long val)

Sets the value of 'numCommits'

Field Description

The number transactions committed by the bus.

Parameters:

val - The value to set.

getNumCommits

long getNumCommits()

Gets the value of 'numCommits'

Field Description

The number transactions committed by the bus.

Returns:

The number transactions committed by the bus.

clearNumCommits

void clearNumCommits()

Clears the value of 'numCommits'

Field Description

The number transactions committed by the bus.

See Also:

setNumCommits(long)

hasNumCommits

boolean hasNumCommits()

Checks for the presence of 'numCommits'

Field Description

The number transactions committed by the bus.

See Also:

getNumCommits()

setNumRollbacks

void setNumRollbacks(long val)

Sets the value of 'numRollbacks'

Field Description

The number transactions rolled back for the bus.

Parameters:

val - The value to set.

getNumRollbacks

long getNumRollbacks()

Gets the value of 'numRollbacks'

Field Description

The number transactions rolled back for the bus.

Returns:

The number transactions rolled back for the bus.

clearNumRollbacks

void clearNumRollbacks()

Clears the value of 'numRollbacks'

Field Description

The number transactions rolled back for the bus.

See Also:

setNumRollbacks(long)

hasNumRollbacks

boolean hasNumRollbacks()

Checks for the presence of 'numRollbacks'

Field Description

The number transactions rolled back for the bus.

See Also:

getNumRollbacks()

setNumClients

void setNumClients(int val)

Sets the value of 'numClients'

Field Description

The number of connected clients (if applicable)

Parameters:

val - The value to set.

getNumClients

int getNumClients()

Gets the value of 'numClients'

Field Description

The number of connected clients (if applicable)

Returns:

The number of connected clients (if applicable)

clearNumClients

void clearNumClients()

Clears the value of 'numClients'

Field Description

The number of connected clients (if applicable)

See Also:

setNumClients(int)

hasNumClients

boolean hasNumClients()

Checks for the presence of 'numClients'

Field Description

The number of connected clients (if applicable)

See Also:

getNumClients()

setNumChannelsUp

void setNumChannelsUp(int val)

Sets the value of 'numChannelsUp'

Field Description

The number of channels brought up by this bus.

Parameters:

val - The value to set.

getNumChannelsUp

int getNumChannelsUp()

Gets the value of 'numChannelsUp'

Field Description

The number of channels brought up by this bus.

Returns:

The number of channels brought up by this bus.

clearNumChannelsUp

void clearNumChannelsUp()

Clears the value of 'numChannelsUp'

Field Description

The number of channels brought up by this bus.

See Also:

setNumChannelsUp(int)

hasNumChannelsUp

boolean hasNumChannelsUp()

Checks for the presence of 'numChannelsUp'

Field Description

The number of channels brought up by this bus.

See Also:

getNumChannelsUp()

setNumBindingFailures

void setNumBindingFailures(int val)

Sets the value of 'numBindingFailures'

Field Description

The number of binding failures that have occurred for this bus.

Parameters:

val - The value to set.

getNumBindingFailures

int getNumBindingFailures()

Gets the value of 'numBindingFailures'

Field Description

The number of binding failures that have occurred for this bus.

Returns:

The number of binding failures that have occurred for this bus.

clearNumBindingFailures

void clearNumBindingFailures()

Clears the value of 'numBindingFailures'

Field Description

The number of binding failures that have occurred for this bus.

See Also:

setNumBindingFailures(int)

hasNumBindingFailures

boolean hasNumBindingFailures()

Checks for the presence of 'numBindingFailures'

Field Description

The number of binding failures that have occurred for this bus.

See Also:

getNumBindingFailures()

setDetachedCommit

void setDetachedCommit(boolean val)

Sets the value of 'detachedCommit'

Field Description

If the bus binding is operating in detached mode

Parameters:

val - The value to set.

getDetachedCommit

boolean getDetachedCommit()

Gets the value of 'detachedCommit'

Field Description

If the bus binding is operating in detached mode

Returns:

If the bus binding is operating in detached mode

clearDetachedCommit

void clearDetachedCommit()

Clears the value of 'detachedCommit'

Field Description

If the bus binding is operating in detached mode

See Also:

setDetachedCommit(boolean)

hasDetachedCommit

boolean hasDetachedCommit()

Checks for the presence of 'detachedCommit'

Field Description

If the bus binding is operating in detached mode

See Also:

getDetachedCommit()

setInternal

void setInternal(boolean val)

Sets the value of 'internal'

Field Description

Indicates if this is an internal bus

Parameters:

val - The value to set.

getInternal

boolean getInternal()

Gets the value of 'internal'

Field Description

Indicates if this is an internal bus

Returns:

Indicates if this is an internal bus

clearInternal

void clearInternal()

Clears the value of 'internal'

Field Description

Indicates if this is an internal bus

See Also:

setInternal(boolean)

hasInternal

boolean hasInternal()

Checks for the presence of 'internal'

Field Description

Indicates if this is an internal bus

See Also:

getInternal()

setNumAcksSent

void setNumAcksSent(long val)

Sets the value of 'numAcksSent'

Field Description

The number of inbound messages acknowledged by the bus

Parameters:

val - The value to set.

getNumAcksSent

long getNumAcksSent()

Gets the value of 'numAcksSent'

Field Description

The number of inbound messages acknowledged by the bus

Returns:

The number of inbound messages acknowledged by the bus

clearNumAcksSent

void clearNumAcksSent()

Clears the value of 'numAcksSent'

Field Description

The number of inbound messages acknowledged by the bus

See Also:

setNumAcksSent(long)

hasNumAcksSent

boolean hasNumAcksSent()

Checks for the presence of 'numAcksSent'

Field Description

The number of inbound messages acknowledged by the bus

See Also:

getNumAcksSent()

setNumPartialRollbacks

void setNumPartialRollbacks(long val)

Sets the value of 'numPartialRollbacks'

Field Description

The number of partial (savepoint) transaction roll back for the bus.

Parameters:

val - The value to set.

getNumPartialRollbacks

long getNumPartialRollbacks()

Gets the value of 'numPartialRollbacks'

Field Description

The number of partial (savepoint) transaction roll back for the bus.

Returns:

The number of partial (savepoint) transaction roll back for the bus.

clearNumPartialRollbacks

void clearNumPartialRollbacks()

Clears the value of 'numPartialRollbacks'

Field Description

The number of partial (savepoint) transaction roll back for the bus.

See Also:

setNumPartialRollbacks(long)

hasNumPartialRollbacks

boolean hasNumPartialRollbacks()

Checks for the presence of 'numPartialRollbacks'

Field Description

The number of partial (savepoint) transaction roll back for the bus.

See Also:

getNumPartialRollbacks()

setBusBindingName

void setBusBindingName(String val)

Sets the value of 'busBindingName'

Field Description

The name of the bus

Parameters:

val - The value to set.

getBusBindingName

String getBusBindingName()

Gets the value of 'busBindingName'

Field Description

The name of the bus

Returns:

The name of the bus

lendBusBindingName

void lendBusBindingName(XString val)

Sets the value of 'busBindingName'

Field Description

The name of the bus

Parameters:

val - The value to set.

setBusBindingNameFrom

void setBusBindingNameFrom(long val)

Sets the value of this String field to the given numeric value.

Field Description

The name of the bus

NOTE:
This is the same as calling setBusBindingName(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

getBusBindingNameTo

<T extends XString> T getBusBindingNameTo(XString.Factory<T> factory)

Copies the value of this String field into a new XString from the given factory.

Field Description

The name of the bus

If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);

This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;

Parameters:

factory - The factory from which to get the XString to copy into and return

Returns:

a new XString from the provided factory if this field is set or null.

Throws:

NullPointerException - if the provided factory is null

setBusBindingNameFrom

void setBusBindingNameFrom(XString val)

Copies the provided XString value into this object's 'busBindingName'.

Field Description

The name of the bus

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than setBusBindingName(String) because it avoids encoding the value into a String if the given XString is already encoded.

getBusBindingNameTo

void getBusBindingNameTo(XString val)

Copies the value of 'busBindingName' into the provided XString.

Field Description

The name of the bus

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than getBusBindingName() bec because it can avoid decoding the value into an String.

See Also:

getBusBindingName()

getBusBindingNameUnsafe

XString getBusBindingNameUnsafe()

Gets the raw value of 'busBindingName'.

Field Description

The name of the bus

NOTE:
This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.

However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.

Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.

Returns:

the field's raw value

See Also:

getBusBindingName()

clearBusBindingName

void clearBusBindingName()

Clears the value of 'busBindingName'

Field Description

The name of the bus

See Also:

setBusBindingName(String)

hasBusBindingName

boolean hasBusBindingName()

Checks for the presence of 'busBindingName'

Field Description

The name of the bus

See Also:

getBusBindingName()

setCreateToSendLatencies

void setCreateToSendLatencies(SrvMonIntSeries val)

Sets the value of 'createToSendLatencies'

Field Description

The create to send latencies in microseconds, the time in microseconds from message creation to when send was called for it (aka 'c2o').

Parameters:

val - The value to set.

lendCreateToSendLatencies

void lendCreateToSendLatencies(SrvMonIntSeries val)

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

Field Description

The create to send latencies in microseconds, the time in microseconds from message creation to when send was called for it (aka 'c2o').

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.

getCreateToSendLatencies

SrvMonIntSeries getCreateToSendLatencies()

Gets the value of 'createToSendLatencies'

Field Description

The create to send latencies in microseconds, the time in microseconds from message creation to when send was called for it (aka 'c2o').

Returns:

The create to send latencies in microseconds, the time in microseconds from message creation to when send was called for it (aka 'c2o').

getCreateToSendLatenciesTo

void getCreateToSendLatenciesTo(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)

takeCreateToSendLatencies

SrvMonIntSeries takeCreateToSendLatencies()

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

Field Description

The create to send latencies in microseconds, the time in microseconds from message creation to when send was called for it (aka 'c2o').

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.

hasCreateToSendLatencies

boolean hasCreateToSendLatencies()

Checks for the presence of 'createToSendLatencies'

Field Description

The create to send latencies in microseconds, the time in microseconds from message creation to when send was called for it (aka 'c2o').

See Also:

getCreateToSendLatencies()

clearCreateToSendLatencies

void clearCreateToSendLatencies()

Clears the value of 'createToSendLatencies'

Field Description

The create to send latencies in microseconds, the time in microseconds from message creation to when send was called for it (aka 'c2o').

See Also:

setCreateToSendLatencies(SrvMonIntSeries)

setSendToSerializeLatencies

void setSendToSerializeLatencies(SrvMonIntSeries val)

Sets the value of 'sendToSerializeLatencies'

Field Description

The send to serialize latencies in microseconds, the time from when the message send is started until it was serialized in preparation for transmission on the wire (aka: 'o2s').

Note that this time excludes o2p for the case where the binding is operating in detached mode.

Parameters:

val - The value to set.

lendSendToSerializeLatencies

void lendSendToSerializeLatencies(SrvMonIntSeries val)

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

Field Description

The send to serialize latencies in microseconds, the time from when the message send is started until it was serialized in preparation for transmission on the wire (aka: 'o2s').

Note that this time excludes o2p for the case where the binding is operating in detached mode.

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.

getSendToSerializeLatencies

SrvMonIntSeries getSendToSerializeLatencies()

Gets the value of 'sendToSerializeLatencies'

Field Description

The send to serialize latencies in microseconds, the time from when the message send is started until it was serialized in preparation for transmission on the wire (aka: 'o2s').

Note that this time excludes o2p for the case where the binding is operating in detached mode.

Returns:

The send to serialize latencies in microseconds, the time from when the message send is started until it was serialized in preparation for transmission on the wire (aka: 'o2s').

getSendToSerializeLatenciesTo

void getSendToSerializeLatenciesTo(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)

takeSendToSerializeLatencies

SrvMonIntSeries takeSendToSerializeLatencies()

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

Field Description

The send to serialize latencies in microseconds, the time from when the message send is started until it was serialized in preparation for transmission on the wire (aka: 'o2s').

Note that this time excludes o2p for the case where the binding is operating in detached mode.

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.

hasSendToSerializeLatencies

boolean hasSendToSerializeLatencies()

Checks for the presence of 'sendToSerializeLatencies'

Field Description

The send to serialize latencies in microseconds, the time from when the message send is started until it was serialized in preparation for transmission on the wire (aka: 'o2s').

Note that this time excludes o2p for the case where the binding is operating in detached mode.

See Also:

getSendToSerializeLatencies()

clearSendToSerializeLatencies

void clearSendToSerializeLatencies()

Clears the value of 'sendToSerializeLatencies'

Field Description

The send to serialize latencies in microseconds, the time from when the message send is started until it was serialized in preparation for transmission on the wire (aka: 'o2s').

Note that this time excludes o2p for the case where the binding is operating in detached mode.

See Also:

setSendToSerializeLatencies(SrvMonIntSeries)

setSerializeLatencies

void setSerializeLatencies(SrvMonIntSeries val)

Sets the value of 'serializeLatencies'

Field Description

The serialize latencies in microseconds, the spent serializing the MessageView to its transport encoding (aka: 's').

Parameters:

val - The value to set.

lendSerializeLatencies

void lendSerializeLatencies(SrvMonIntSeries val)

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

Field Description

The serialize latencies in microseconds, the spent serializing the MessageView to its transport encoding (aka: 's').

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.

getSerializeLatencies

SrvMonIntSeries getSerializeLatencies()

Gets the value of 'serializeLatencies'

Field Description

The serialize latencies in microseconds, the spent serializing the MessageView to its transport encoding (aka: 's').

Returns:

The serialize latencies in microseconds, the spent serializing the MessageView to its transport encoding (aka: 's').

getSerializeLatenciesTo

void getSerializeLatenciesTo(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)

takeSerializeLatencies

SrvMonIntSeries takeSerializeLatencies()

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

Field Description

The serialize latencies in microseconds, the spent serializing the MessageView to its transport encoding (aka: 's').

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.

hasSerializeLatencies

boolean hasSerializeLatencies()

Checks for the presence of 'serializeLatencies'

Field Description

The serialize latencies in microseconds, the spent serializing the MessageView to its transport encoding (aka: 's').

See Also:

getSerializeLatencies()

clearSerializeLatencies

void clearSerializeLatencies()

Clears the value of 'serializeLatencies'

Field Description

The serialize latencies in microseconds, the spent serializing the MessageView to its transport encoding (aka: 's').

See Also:

setSerializeLatencies(SrvMonIntSeries)

setSerializeToWireLatencies

void setSerializeToWireLatencies(SrvMonIntSeries val)

Sets the value of 'serializeToWireLatencies'

Field Description

The serialize to wire latencies in microseconds, the time post deserialize to when just before the message is written to the wire (aka: 's2w').

Parameters:

val - The value to set.

lendSerializeToWireLatencies

void lendSerializeToWireLatencies(SrvMonIntSeries val)

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

Field Description

The serialize to wire latencies in microseconds, the time post deserialize to when just before the message is written to the wire (aka: 's2w').

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.

getSerializeToWireLatencies

SrvMonIntSeries getSerializeToWireLatencies()

Gets the value of 'serializeToWireLatencies'

Field Description

The serialize to wire latencies in microseconds, the time post deserialize to when just before the message is written to the wire (aka: 's2w').

Returns:

The serialize to wire latencies in microseconds, the time post deserialize to when just before the message is written to the wire (aka: 's2w').

getSerializeToWireLatenciesTo

void getSerializeToWireLatenciesTo(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)

takeSerializeToWireLatencies

SrvMonIntSeries takeSerializeToWireLatencies()

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

Field Description

The serialize to wire latencies in microseconds, the time post deserialize to when just before the message is written to the wire (aka: 's2w').

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.

hasSerializeToWireLatencies

boolean hasSerializeToWireLatencies()

Checks for the presence of 'serializeToWireLatencies'

Field Description

The serialize to wire latencies in microseconds, the time post deserialize to when just before the message is written to the wire (aka: 's2w').

See Also:

getSerializeToWireLatencies()

clearSerializeToWireLatencies

void clearSerializeToWireLatencies()

Clears the value of 'serializeToWireLatencies'

Field Description

The serialize to wire latencies in microseconds, the time post deserialize to when just before the message is written to the wire (aka: 's2w').

See Also:

setSerializeToWireLatencies(SrvMonIntSeries)

setWireLatencies

void setWireLatencies(SrvMonIntSeries val)

Sets the value of 'wireLatencies'

Field Description

The wire latencies in microseconds, the time an inbound message spent on the wire (aka: 'w').

The time spent on the wire from when the message was written to the wire by the sender to the time it was received off the wire by the receiver. Note: that this metric is subject to clock skew when the sending and receivin sides are on different hosts.

Parameters:

val - The value to set.

lendWireLatencies

void lendWireLatencies(SrvMonIntSeries val)

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

Field Description

The wire latencies in microseconds, the time an inbound message spent on the wire (aka: 'w').

The time spent on the wire from when the message was written to the wire by the sender to the time it was received off the wire by the receiver. Note: that this metric is subject to clock skew when the sending and receivin sides are on different hosts.

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.

getWireLatencies

SrvMonIntSeries getWireLatencies()

Gets the value of 'wireLatencies'

Field Description

The wire latencies in microseconds, the time an inbound message spent on the wire (aka: 'w').

The time spent on the wire from when the message was written to the wire by the sender to the time it was received off the wire by the receiver. Note: that this metric is subject to clock skew when the sending and receivin sides are on different hosts.

Returns:

The wire latencies in microseconds, the time an inbound message spent on the wire (aka: 'w').

getWireLatenciesTo

void getWireLatenciesTo(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)

takeWireLatencies

SrvMonIntSeries takeWireLatencies()

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

Field Description

The wire latencies in microseconds, the time an inbound message spent on the wire (aka: 'w').

The time spent on the wire from when the message was written to the wire by the sender to the time it was received off the wire by the receiver. Note: that this metric is subject to clock skew when the sending and receivin sides are on different hosts.

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.

hasWireLatencies

boolean hasWireLatencies()

Checks for the presence of 'wireLatencies'

Field Description

The wire latencies in microseconds, the time an inbound message spent on the wire (aka: 'w').

The time spent on the wire from when the message was written to the wire by the sender to the time it was received off the wire by the receiver. Note: that this metric is subject to clock skew when the sending and receivin sides are on different hosts.

See Also:

getWireLatencies()

clearWireLatencies

void clearWireLatencies()

Clears the value of 'wireLatencies'

Field Description

The wire latencies in microseconds, the time an inbound message spent on the wire (aka: 'w').

The time spent on the wire from when the message was written to the wire by the sender to the time it was received off the wire by the receiver. Note: that this metric is subject to clock skew when the sending and receivin sides are on different hosts.

See Also:

setWireLatencies(SrvMonIntSeries)

setWireToDeserializeLatencies

void setWireToDeserializeLatencies(SrvMonIntSeries val)

Sets the value of 'wireToDeserializeLatencies'

Field Description

The time from when the serialized form was received from the wire to deserialization (aka: 'w2d').

Parameters:

val - The value to set.

lendWireToDeserializeLatencies

void lendWireToDeserializeLatencies(SrvMonIntSeries val)

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

Field Description

The time from when the serialized form was received from the wire to deserialization (aka: 'w2d').

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.

getWireToDeserializeLatencies

SrvMonIntSeries getWireToDeserializeLatencies()

Gets the value of 'wireToDeserializeLatencies'

Field Description

The time from when the serialized form was received from the wire to deserialization (aka: 'w2d').

Returns:

The time from when the serialized form was received from the wire to deserialization (aka: 'w2d').

getWireToDeserializeLatenciesTo

void getWireToDeserializeLatenciesTo(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)

takeWireToDeserializeLatencies

SrvMonIntSeries takeWireToDeserializeLatencies()

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

Field Description

The time from when the serialized form was received from the wire to deserialization (aka: 'w2d').

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.

hasWireToDeserializeLatencies

boolean hasWireToDeserializeLatencies()

Checks for the presence of 'wireToDeserializeLatencies'

Field Description

The time from when the serialized form was received from the wire to deserialization (aka: 'w2d').

See Also:

getWireToDeserializeLatencies()

clearWireToDeserializeLatencies

void clearWireToDeserializeLatencies()

Clears the value of 'wireToDeserializeLatencies'

Field Description

The time from when the serialized form was received from the wire to deserialization (aka: 'w2d').

See Also:

setWireToDeserializeLatencies(SrvMonIntSeries)

setDeserializeLatencies

void setDeserializeLatencies(SrvMonIntSeries val)

Sets the value of 'deserializeLatencies'

Field Description

The time (in microseconds) spent deserializing the message and wrapping it in a MessageView (aka: 'd').

Parameters:

val - The value to set.

lendDeserializeLatencies

void lendDeserializeLatencies(SrvMonIntSeries val)

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

Field Description

The time (in microseconds) spent deserializing the message and wrapping it in a MessageView (aka: 'd').

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.

getDeserializeLatencies

SrvMonIntSeries getDeserializeLatencies()

Gets the value of 'deserializeLatencies'

Field Description

The time (in microseconds) spent deserializing the message and wrapping it in a MessageView (aka: 'd').

Returns:

The time (in microseconds) spent deserializing the message and wrapping it in a MessageView (aka: 'd').

getDeserializeLatenciesTo

void getDeserializeLatenciesTo(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)

takeDeserializeLatencies

SrvMonIntSeries takeDeserializeLatencies()

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

Field Description

The time (in microseconds) spent deserializing the message and wrapping it in a MessageView (aka: 'd').

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.

hasDeserializeLatencies

boolean hasDeserializeLatencies()

Checks for the presence of 'deserializeLatencies'

Field Description

The time (in microseconds) spent deserializing the message and wrapping it in a MessageView (aka: 'd').

See Also:

getDeserializeLatencies()

clearDeserializeLatencies

void clearDeserializeLatencies()

Clears the value of 'deserializeLatencies'

Field Description

The time (in microseconds) spent deserializing the message and wrapping it in a MessageView (aka: 'd').

See Also:

setDeserializeLatencies(SrvMonIntSeries)

setDeserializeToReceiveLatencies

void setDeserializeToReceiveLatencies(SrvMonIntSeries val)

Sets the value of 'deserializeToReceiveLatencies'

Field Description

The time (in microseconds) from when the message was deserialized to when it is received by the engine (aka: 'd2i').

This measure the time from when the bus has deserialized by the bus to when the app's engine picks it up from it's input queue (before it dispatches it to an application) handler (it includes the o2p time of the engine's disruptor). Additional time spent by the engine dispatching the message to the application handler is covered by msgPreProcLatencies (mpproc).

Parameters:

val - The value to set.

lendDeserializeToReceiveLatencies

void lendDeserializeToReceiveLatencies(SrvMonIntSeries val)

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

Field Description

The time (in microseconds) from when the message was deserialized to when it is received by the engine (aka: 'd2i').

This measure the time from when the bus has deserialized by the bus to when the app's engine picks it up from it's input queue (before it dispatches it to an application) handler (it includes the o2p time of the engine's disruptor). Additional time spent by the engine dispatching the message to the application handler is covered by msgPreProcLatencies (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.

getDeserializeToReceiveLatencies

SrvMonIntSeries getDeserializeToReceiveLatencies()

Gets the value of 'deserializeToReceiveLatencies'

Field Description

The time (in microseconds) from when the message was deserialized to when it is received by the engine (aka: 'd2i').

This measure the time from when the bus has deserialized by the bus to when the app's engine picks it up from it's input queue (before it dispatches it to an application) handler (it includes the o2p time of the engine's disruptor). Additional time spent by the engine dispatching the message to the application handler is covered by msgPreProcLatencies (mpproc).

Returns:

the time (in microseconds) from when the message was deserialized to when it is received by the engine (aka: 'd2i').

getDeserializeToReceiveLatenciesTo

void getDeserializeToReceiveLatenciesTo(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)

takeDeserializeToReceiveLatencies

SrvMonIntSeries takeDeserializeToReceiveLatencies()

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

Field Description

The time (in microseconds) from when the message was deserialized to when it is received by the engine (aka: 'd2i').

This measure the time from when the bus has deserialized by the bus to when the app's engine picks it up from it's input queue (before it dispatches it to an application) handler (it includes the o2p time of the engine's disruptor). Additional time spent by the engine dispatching the message to the application handler is covered by msgPreProcLatencies (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.

hasDeserializeToReceiveLatencies

boolean hasDeserializeToReceiveLatencies()

Checks for the presence of 'deserializeToReceiveLatencies'

Field Description

The time (in microseconds) from when the message was deserialized to when it is received by the engine (aka: 'd2i').

This measure the time from when the bus has deserialized by the bus to when the app's engine picks it up from it's input queue (before it dispatches it to an application) handler (it includes the o2p time of the engine's disruptor). Additional time spent by the engine dispatching the message to the application handler is covered by msgPreProcLatencies (mpproc).

See Also:

getDeserializeToReceiveLatencies()

clearDeserializeToReceiveLatencies

void clearDeserializeToReceiveLatencies()

Clears the value of 'deserializeToReceiveLatencies'

Field Description

The time (in microseconds) from when the message was deserialized to when it is received by the engine (aka: 'd2i').

This measure the time from when the bus has deserialized by the bus to when the app's engine picks it up from it's input queue (before it dispatches it to an application) handler (it includes the o2p time of the engine's disruptor). Additional time spent by the engine dispatching the message to the application handler is covered by msgPreProcLatencies (mpproc).

See Also:

setDeserializeToReceiveLatencies(SrvMonIntSeries)

setOriginToReceiveLatencies

void setOriginToReceiveLatencies(SrvMonIntSeries val)

Sets the value of 'originToReceiveLatencies'

Field Description

The origin to receive latencies in microseconds (aka: 'o2i').

The time from when a message was originally created to when it was received by the binding.

Parameters:

val - The value to set.

lendOriginToReceiveLatencies

void lendOriginToReceiveLatencies(SrvMonIntSeries val)

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

Field Description

The origin to receive latencies in microseconds (aka: 'o2i').

The time from when a message was originally created to when it was received by the binding.

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.

getOriginToReceiveLatencies

SrvMonIntSeries getOriginToReceiveLatencies()

Gets the value of 'originToReceiveLatencies'

Field Description

The origin to receive latencies in microseconds (aka: 'o2i').

The time from when a message was originally created to when it was received by the binding.

Returns:

The origin to receive latencies in microseconds (aka: 'o2i').

getOriginToReceiveLatenciesTo

void getOriginToReceiveLatenciesTo(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)

takeOriginToReceiveLatencies

SrvMonIntSeries takeOriginToReceiveLatencies()

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

Field Description

The origin to receive latencies in microseconds (aka: 'o2i').

The time from when a message was originally created to when it was received by the binding.

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.

hasOriginToReceiveLatencies

boolean hasOriginToReceiveLatencies()

Checks for the presence of 'originToReceiveLatencies'

Field Description

The origin to receive latencies in microseconds (aka: 'o2i').

The time from when a message was originally created to when it was received by the binding.

See Also:

getOriginToReceiveLatencies()

clearOriginToReceiveLatencies

void clearOriginToReceiveLatencies()

Clears the value of 'originToReceiveLatencies'

Field Description

The origin to receive latencies in microseconds (aka: 'o2i').

The time from when a message was originally created to when it was received by the binding.

See Also:

setOriginToReceiveLatencies(SrvMonIntSeries)

setWireToWireLatencies

void setWireToWireLatencies(SrvMonIntSeries val)

Sets the value of 'wireToWireLatencies'

Field Description

The wire to wire latencies in microseconds, for outbound messages the time from when the corresponding inbound message was received off the wire to when the outbound message was written to the wire. (aka: 'w2w').

This measurement is useful for determine how long the process spent from receiving a message to making its effects to the world 'known'.

Parameters:

val - The value to set.

lendWireToWireLatencies

void lendWireToWireLatencies(SrvMonIntSeries val)

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

Field Description

The wire to wire latencies in microseconds, for outbound messages the time from when the corresponding inbound message was received off the wire to when the outbound message was written to the wire. (aka: 'w2w').

This measurement is useful for determine how long the process spent from receiving a message to making its effects to the world 'known'.

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.

getWireToWireLatencies

SrvMonIntSeries getWireToWireLatencies()

Gets the value of 'wireToWireLatencies'

Field Description

The wire to wire latencies in microseconds, for outbound messages the time from when the corresponding inbound message was received off the wire to when the outbound message was written to the wire. (aka: 'w2w').

This measurement is useful for determine how long the process spent from receiving a message to making its effects to the world 'known'.

Returns:

The wire to wire latencies in microseconds, for outbound messages the time from when the corresponding inbound message was received off the wire to when the outbound message was written to the wire. (aka: 'w2w').

getWireToWireLatenciesTo

void getWireToWireLatenciesTo(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)

takeWireToWireLatencies

SrvMonIntSeries takeWireToWireLatencies()

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

Field Description

The wire to wire latencies in microseconds, for outbound messages the time from when the corresponding inbound message was received off the wire to when the outbound message was written to the wire. (aka: 'w2w').

This measurement is useful for determine how long the process spent from receiving a message to making its effects to the world 'known'.

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.

hasWireToWireLatencies

boolean hasWireToWireLatencies()

Checks for the presence of 'wireToWireLatencies'

Field Description

The wire to wire latencies in microseconds, for outbound messages the time from when the corresponding inbound message was received off the wire to when the outbound message was written to the wire. (aka: 'w2w').

This measurement is useful for determine how long the process spent from receiving a message to making its effects to the world 'known'.

See Also:

getWireToWireLatencies()

clearWireToWireLatencies

void clearWireToWireLatencies()

Clears the value of 'wireToWireLatencies'

Field Description

The wire to wire latencies in microseconds, for outbound messages the time from when the corresponding inbound message was received off the wire to when the outbound message was written to the wire. (aka: 'w2w').

This measurement is useful for determine how long the process spent from receiving a message to making its effects to the world 'known'.

See Also:

setWireToWireLatencies(SrvMonIntSeries)

setDisruptorStats

void setDisruptorStats(SrvMonDisruptorStats val)

Sets the value of 'disruptorStats'

Field Description

Disruptor statistics for the bus when operating in detached mode

Parameters:

val - The value to set.

lendDisruptorStats

void lendDisruptorStats(SrvMonDisruptorStats val)

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

Field Description

Disruptor statistics for the bus when operating in detached mode

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.

getDisruptorStats

SrvMonDisruptorStats getDisruptorStats()

Gets the value of 'disruptorStats'

Field Description

Disruptor statistics for the bus when operating in detached mode

Returns:

Disruptor statistics for the bus when operating in detached mode

getDisruptorStatsTo

void getDisruptorStatsTo(SrvMonDisruptorStats val)

Copies the value of SrvMonDisruptorStats into the provided value.

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

Parameters:

val - the value to copy into

See Also:

SrvMonDisruptorStats.copyInto(SrvMonDisruptorStats)

takeDisruptorStats

SrvMonDisruptorStats takeDisruptorStats()

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

Field Description

Disruptor statistics for the bus when operating in detached mode

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.

hasDisruptorStats

boolean hasDisruptorStats()

Checks for the presence of 'disruptorStats'

Field Description

Disruptor statistics for the bus when operating in detached mode

See Also:

getDisruptorStats()

clearDisruptorStats

void clearDisruptorStats()

Clears the value of 'disruptorStats'

Field Description

Disruptor statistics for the bus when operating in detached mode

See Also:

setDisruptorStats(SrvMonDisruptorStats)

setSendToPollLatencies

void setSendToPollLatencies(SrvMonIntSeries val)

Sets the value of 'sendToPollLatencies'

Field Description

When the bus is operating in a detached mode, the time from when the message was offered for send until it is picked up send is started (aka: 'o2p').

Parameters:

val - The value to set.

lendSendToPollLatencies

void lendSendToPollLatencies(SrvMonIntSeries val)

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

Field Description

When the bus is operating in a detached mode, the time from when the message was offered for send until it is picked up send is started (aka: 'o2p').

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.

getSendToPollLatencies

SrvMonIntSeries getSendToPollLatencies()

Gets the value of 'sendToPollLatencies'

Field Description

When the bus is operating in a detached mode, the time from when the message was offered for send until it is picked up send is started (aka: 'o2p').

Returns:

When the bus is operating in a detached mode, the time from when the message was offered for send until it is picked up send is started (aka: 'o2p').

getSendToPollLatenciesTo

void getSendToPollLatenciesTo(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)

takeSendToPollLatencies

SrvMonIntSeries takeSendToPollLatencies()

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

Field Description

When the bus is operating in a detached mode, the time from when the message was offered for send until it is picked up send is started (aka: 'o2p').

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.

hasSendToPollLatencies

boolean hasSendToPollLatencies()

Checks for the presence of 'sendToPollLatencies'

Field Description

When the bus is operating in a detached mode, the time from when the message was offered for send until it is picked up send is started (aka: 'o2p').

See Also:

getSendToPollLatencies()

clearSendToPollLatencies

void clearSendToPollLatencies()

Clears the value of 'sendToPollLatencies'

Field Description

When the bus is operating in a detached mode, the time from when the message was offered for send until it is picked up send is started (aka: 'o2p').

See Also:

setSendToPollLatencies(SrvMonIntSeries)

setWireSendLatencies

void setWireSendLatencies(SrvMonIntSeries val)

Sets the value of 'wireSendLatencies'

Field Description

The wire send latencies in microseconds, he time spent by the message bus provider writing the message to the wire. (aka: 'ws').

This time covers an time spent blocked in the provider due to flow control and time in the provider implementation's send api.

Parameters:

val - The value to set.

lendWireSendLatencies

void lendWireSendLatencies(SrvMonIntSeries val)

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

Field Description

The wire send latencies in microseconds, he time spent by the message bus provider writing the message to the wire. (aka: 'ws').

This time covers an time spent blocked in the provider due to flow control and time in the provider implementation's send api.

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.

getWireSendLatencies

SrvMonIntSeries getWireSendLatencies()

Gets the value of 'wireSendLatencies'

Field Description

The wire send latencies in microseconds, he time spent by the message bus provider writing the message to the wire. (aka: 'ws').

This time covers an time spent blocked in the provider due to flow control and time in the provider implementation's send api.

Returns:

The wire send latencies in microseconds, he time spent by the message bus provider writing the message to the wire. (aka: 'ws').

getWireSendLatenciesTo

void getWireSendLatenciesTo(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)

takeWireSendLatencies

SrvMonIntSeries takeWireSendLatencies()

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

Field Description

The wire send latencies in microseconds, he time spent by the message bus provider writing the message to the wire. (aka: 'ws').

This time covers an time spent blocked in the provider due to flow control and time in the provider implementation's send api.

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.

hasWireSendLatencies

boolean hasWireSendLatencies()

Checks for the presence of 'wireSendLatencies'

Field Description

The wire send latencies in microseconds, he time spent by the message bus provider writing the message to the wire. (aka: 'ws').

This time covers an time spent blocked in the provider due to flow control and time in the provider implementation's send api.

See Also:

getWireSendLatencies()

clearWireSendLatencies

void clearWireSendLatencies()

Clears the value of 'wireSendLatencies'

Field Description

The wire send latencies in microseconds, he time spent by the message bus provider writing the message to the wire. (aka: 'ws').

This time covers an time spent blocked in the provider due to flow control and time in the provider implementation's send api.

See Also:

setWireSendLatencies(SrvMonIntSeries)