| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><!-- saved from url=(0014)about:internet --><html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><link rel="stylesheet" href="../../../style.css" type="text/css" media="screen"><link rel="stylesheet" href="../../../print.css" type="text/css" media="print"><link rel="stylesheet" href="../../../override.css" type="text/css"><meta name="keywords" content="MessagePerformanceUtils,mx.messaging.messages.MessagePerformanceUtils,ADD_SUBSCRIPTIONS,AUTHENTICATION_MESSAGE_REF_TYPE,CLIENT_PING_OPERATION,CLIENT_SYNC_OPERATION,CLUSTER_REQUEST_OPERATION,CONTENT_TYPE_FORM,CONTENT_TYPE_SOAP_XML,CONTENT_TYPE_XML,CREDENTIALS_CHARSET_HEADER,DELETE_METHOD,DESTINATION_CLIENT_ID_HEADER,DISCONNECT_OPERATION,ENDPOINT_HEADER,ERROR_HINT_HEADER,FLEX_CLIENT_ID_HEADER,GET_METHOD,HEAD_METHOD,HEARTBEAT_HEADER,LOGIN_OPERATION,LOGOUT_OPERATION,MAX_FREQUENCY_HEADER,MESSAGE_DELIVERY_IN_DOUBT,MESSAGING_VERSION,MULTI_SUBSCRIBE_OPERATION,NEEDS_CONFIG_HEADER,NO_OP_POLL_HEADER,OPTIONS_METHOD,POLL_OPERATION,POLL_WAIT_HEADER,POST_METHOD,PRESERVE_DURABLE_HEADER,PRIORITY_HEADER,PUT_METHOD,REMOTE_CREDENTIALS_CHARSET_HEADER,REMOTE_CREDENTIALS_HEADER,REMOVE_SUBSCRIPTIONS,REQUEST_TIMEOUT_HEADER,RETRYABLE_HINT_HEADER,SELECTOR_HEADER,SOAP_ACTION_HEADER,STATUS_CODE_HEADER,SUBSCRIBE_OPERATION,SUBSCRIPTION_INVALIDATE_OPERATION,SUBTOPIC_HEADER,SUBTOPIC_SEPARATOR,TRACE_METHOD,TRIGGER_CONNECT_OPERATION,UNKNOWN_OPERATION,UNSUBSCRIBE_OPERATION,body,body,clientId,clientId,clientReceiveTime,contentType,correlationId,destination,destination,extendedData,faultCode,faultDetail,faultString,headers,headers,httpHeaders,messageId,messageId,messageSize,method,networkRTT,operation,operation,originatingMessageSentTime,originatingMessageSize,pushOneWayTime,pushedMessageFlag,recordHeaders,responseMessageSize,rootCause,serverAdapterExternalTime,serverAdapterTime,serverNonAdapterTime,serverPollDelay,serverPrePushTime,serverProcessingTime,serverSendTime,source,timeToLive,timeToLive,timestamp,timestamp,totalPushTime,totalTime,url,getOperationAsString,getSOAPAction,getSmallMessage,prettyPrint,toString,toString,toString"><title>mx.messaging.messages.MessagePerformanceUtils</title></head><body><script language="javascript" type="text/javascript" src="../../../asdoc.js"></script><script language="javascript" type="text/javascript" src="../../../help.js"></script><script language="javascript" type="text/javascript" src="../../../cookies.js"></script><script language="javascript" type="text/javascript"><!-- |
| asdocTitle = 'MessagePerformanceUtils - ApacheFlex API Reference'; |
| var baseRef = '../../../'; |
| window.onload = configPage; |
| --></script> |
| <script type="text/javascript"> |
| scrollToNameAnchor(); |
| </script><table class="titleTable" cellpadding="0" cellspacing="0" id="titleTable" style="display:none"><tr><td class="titleTableTitle" align="left">Apache Flex 4.16.1 API Reference </td><td class="titleTableTopNav" align="right"><a href="../../../package-summary.html" onclick="loadClassListFrame('../../../all-classes.html')">All Packages</a> | <a href="../../../class-summary.html" onclick="loadClassListFrame('../../../all-classes.html')">All Classes</a> | <a href="../../../all-index-A.html" onclick="loadClassListFrame('../../../index-list.html')">Index</a> | <a id="framesLink1" href="../../../index.html?mx/messaging/messages/MessagePerformanceUtils.html&mx/messaging/messages/class-list.html">Frames</a><a id="noFramesLink1" style="display:none" href="" onclick="parent.location=document.location"> No Frames </a></td><td class="titleTableLogo" align="right" rowspan="3"><img src="../../../images/logo.jpg" class="logoImage" alt="AdobeLogo" title="AdobeLogo"></td></tr><tr class="titleTableRow2"><td class="titleTableSubTitle" id="subTitle" align="left">MessagePerformanceUtils</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a> | <a href="#methodSummary">Methods</a></td></tr><tr class="titleTableRow3"><td colspan="3"> </td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve"> |
| <!-- |
| |
| if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("MessagePerformanceUtils"); titleBar_setSubNav(false,true,false,false,false,false,false,false,true,false,false ,false,false,false,false,false);} |
| --> |
| </script><div xmlns:fn="http://www.w3.org/2005/xpath-functions" class="MainContent"><table class="classHeaderTable" cellpadding="0" cellspacing="0"><tr><td class="classHeaderTableLabel">Package</td><td><a href="package-detail.html" onclick="javascript:loadClassListFrame('class-list.html')">mx.messaging.messages</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class MessagePerformanceUtils</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">MessagePerformanceUtils <img src="../../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> Object</td></tr></table><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p></p><p></p> |
| The MessagePerformanceUtils utility class is used to retrieve various metrics about |
| the sizing and timing of a message sent from a client to the server and its |
| response message, as well as pushed messages from the server to the client. |
| Metrics are gathered when corresponding properties on the channel used are enabled: |
| <record-message-times> denotes capturing of timing information, |
| <record-message-sizes> denotes capturing of sizing information. |
| |
| <p>You can then use methods of this utility class to retrieve various performance information |
| about the message that you have just received.</p> |
| |
| <p>When these metrics are enabled an instance of this class should be created from |
| a response, acknowledgement, or message handler using code such as below: </p> |
| |
| <pre> |
| var mpiutil:MessagePerformanceUtils = new MessagePerformanceUtils(event.message); |
| </pre> |
| <p></p><br/><hr></div><a name="propertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Properties</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProperty"><tr><th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#clientReceiveTime" class="signatureLink">clientReceiveTime</a> : Number<div class="summaryTableDescription">[read-only] |
| Timestamp in milliseconds since epoch of when the client received response message from |
| the server.</div></td><td class="summaryTableOwnerCol">MessagePerformanceUtils</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#messageSize" class="signatureLink">messageSize</a> : int<div class="summaryTableDescription">[read-only] |
| The size of the original client message as measured during deserialization by the server |
| endpoint.</div></td><td class="summaryTableOwnerCol">MessagePerformanceUtils</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#networkRTT" class="signatureLink">networkRTT</a> : Number<div class="summaryTableDescription">[read-only] |
| The network round trip time for a client message and the server response to it, |
| calculated by the difference between total time and server processing time.</div></td><td class="summaryTableOwnerCol">MessagePerformanceUtils</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#originatingMessageSentTime" class="signatureLink">originatingMessageSentTime</a> : Number<div class="summaryTableDescription">[read-only] |
| Only populated in the case of a pushed message, timestamp in milliseconds since epoch of |
| when the client that caused a push message sent its message.</div></td><td class="summaryTableOwnerCol">MessagePerformanceUtils</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#originatingMessageSize" class="signatureLink">originatingMessageSize</a> : Number<div class="summaryTableDescription">[read-only] |
| Only populated in the case of a pushed message, size in Bytes of the message that originally |
| caused this pushed message.</div></td><td class="summaryTableOwnerCol">MessagePerformanceUtils</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#pushedMessageFlag" class="signatureLink">pushedMessageFlag</a> : Boolean<div class="summaryTableDescription">[read-only] |
| Returns true if message was pushed to the client and is not a response to a message that |
| originated on the client.</div></td><td class="summaryTableOwnerCol">MessagePerformanceUtils</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#pushOneWayTime" class="signatureLink">pushOneWayTime</a> : Number<div class="summaryTableDescription">[read-only] |
| Only populated in the case of a pushed message, this is the network time between |
| the server pushing the message and the client receiving it.</div></td><td class="summaryTableOwnerCol">MessagePerformanceUtils</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#responseMessageSize" class="signatureLink">responseMessageSize</a> : int<div class="summaryTableDescription">[read-only] |
| The size of the response message sent to the client by the server as measured during serialization |
| at the server endpoint.</div></td><td class="summaryTableOwnerCol">MessagePerformanceUtils</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#serverAdapterExternalTime" class="signatureLink">serverAdapterExternalTime</a> : Number<div class="summaryTableDescription">[read-only] |
| Time spent in a module invoked from the adapter associated with the destination for this message |
| but external to it, before either the response to the message was ready or the message had been |
| prepared to be pushed to the receiving client.</div></td><td class="summaryTableOwnerCol">MessagePerformanceUtils</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#serverAdapterTime" class="signatureLink">serverAdapterTime</a> : Number<div class="summaryTableDescription">[read-only] |
| Time spent in the adapter associated with the destination for this message before |
| either the response to the message was ready or the message had been prepared |
| to be pushed to the receiving client.</div></td><td class="summaryTableOwnerCol">MessagePerformanceUtils</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#serverNonAdapterTime" class="signatureLink">serverNonAdapterTime</a> : Number<div class="summaryTableDescription">[read-only] |
| Server processing time spent outside of the adapter associated with the destination of this message.</div></td><td class="summaryTableOwnerCol">MessagePerformanceUtils</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#serverPollDelay" class="signatureLink">serverPollDelay</a> : Number<div class="summaryTableDescription">[read-only] |
| Time that the message waited on the server after it was ready to be pushed to the client |
| but had not yet been polled for.</div></td><td class="summaryTableOwnerCol">MessagePerformanceUtils</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#serverPrePushTime" class="signatureLink">serverPrePushTime</a> : Number<div class="summaryTableDescription">[read-only] |
| Time between server receiving the client message and the server beginning to push |
| messages out to other clients as a result of the original message.</div></td><td class="summaryTableOwnerCol">MessagePerformanceUtils</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#serverProcessingTime" class="signatureLink">serverProcessingTime</a> : Number<div class="summaryTableDescription">[read-only] |
| Time between server receiving the client message and either the time |
| the server responded to the received message or had the pushed message ready |
| to be sent to the receiving client.</div></td><td class="summaryTableOwnerCol">MessagePerformanceUtils</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#serverSendTime" class="signatureLink">serverSendTime</a> : Number<div class="summaryTableDescription">[read-only] |
| Timestamp in milliseconds since epoch of when the server sent a response message back |
| to the client.</div></td><td class="summaryTableOwnerCol">MessagePerformanceUtils</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#totalPushTime" class="signatureLink">totalPushTime</a> : Number<div class="summaryTableDescription">[read-only] |
| Only populated in the case of a pushed message, this is the time between the push causing client |
| sending its message and the push receving client receiving it.</div></td><td class="summaryTableOwnerCol">MessagePerformanceUtils</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#totalTime" class="signatureLink">totalTime</a> : Number<div class="summaryTableDescription">[read-only] |
| Time between this client sending a message and receiving a response |
| for it from the server |
| |
| </div></td><td class="summaryTableOwnerCol">MessagePerformanceUtils</td></tr></table></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableMethod"><tr><th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#MessagePerformanceUtils()" class="signatureLink">MessagePerformanceUtils</a>(message:Object)</div><div class="summaryTableDescription"> |
| Constructor |
| |
| Creates an MPUtils instance with information from the MPI headers |
| of the passed in message |
| |
| </div></td><td class="summaryTableOwnerCol">MessagePerformanceUtils</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#prettyPrint()" class="signatureLink">prettyPrint</a>():String</div><div class="summaryTableDescription"> |
| Returns a summary of all information available in MPI.</div></td><td class="summaryTableOwnerCol">MessagePerformanceUtils</td></tr></table></div><script language="javascript" type="text/javascript"><!-- |
| showHideInherited(); |
| --></script><div class="MainContent"><div class="detailSectionHeader">Property Detail</div><a name="propertyDetail"></a><a name="clientReceiveTime"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">clientReceiveTime</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>clientReceiveTime:Number</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Timestamp in milliseconds since epoch of when the client received response message from |
| the server. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get clientReceiveTime():Number</code><br/></div><a name="propertyDetail"></a><a name="messageSize"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">messageSize</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>messageSize:int</code> [read-only] <p></p><p></p><p> |
| The size of the original client message as measured during deserialization by the server |
| endpoint. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get messageSize():int</code><br/></div><a name="propertyDetail"></a><a name="networkRTT"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">networkRTT</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>networkRTT:Number</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The network round trip time for a client message and the server response to it, |
| calculated by the difference between total time and server processing time. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get networkRTT():Number</code><br/></div><a name="propertyDetail"></a><a name="originatingMessageSentTime"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">originatingMessageSentTime</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>originatingMessageSentTime:Number</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Only populated in the case of a pushed message, timestamp in milliseconds since epoch of |
| when the client that caused a push message sent its message. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get originatingMessageSentTime():Number</code><br/></div><a name="propertyDetail"></a><a name="originatingMessageSize"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">originatingMessageSize</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>originatingMessageSize:Number</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Only populated in the case of a pushed message, size in Bytes of the message that originally |
| caused this pushed message. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get originatingMessageSize():Number</code><br/></div><a name="propertyDetail"></a><a name="pushedMessageFlag"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">pushedMessageFlag</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>pushedMessageFlag:Boolean</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Returns true if message was pushed to the client and is not a response to a message that |
| originated on the client. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get pushedMessageFlag():Boolean</code><br/></div><a name="propertyDetail"></a><a name="pushOneWayTime"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">pushOneWayTime</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>pushOneWayTime:Number</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Only populated in the case of a pushed message, this is the network time between |
| the server pushing the message and the client receiving it. Note that the server |
| and client clocks must be in sync for this to be meaningful. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get pushOneWayTime():Number</code><br/></div><a name="propertyDetail"></a><a name="responseMessageSize"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">responseMessageSize</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>responseMessageSize:int</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The size of the response message sent to the client by the server as measured during serialization |
| at the server endpoint. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get responseMessageSize():int</code><br/></div><a name="propertyDetail"></a><a name="serverAdapterExternalTime"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">serverAdapterExternalTime</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>serverAdapterExternalTime:Number</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Time spent in a module invoked from the adapter associated with the destination for this message |
| but external to it, before either the response to the message was ready or the message had been |
| prepared to be pushed to the receiving client. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get serverAdapterExternalTime():Number</code><br/></div><a name="propertyDetail"></a><a name="serverAdapterTime"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">serverAdapterTime</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>serverAdapterTime:Number</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Time spent in the adapter associated with the destination for this message before |
| either the response to the message was ready or the message had been prepared |
| to be pushed to the receiving client. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get serverAdapterTime():Number</code><br/></div><a name="propertyDetail"></a><a name="serverNonAdapterTime"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">serverNonAdapterTime</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>serverNonAdapterTime:Number</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Server processing time spent outside of the adapter associated with the destination of this message. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get serverNonAdapterTime():Number</code><br/></div><a name="propertyDetail"></a><a name="serverPollDelay"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">serverPollDelay</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>serverPollDelay:Number</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Time that the message waited on the server after it was ready to be pushed to the client |
| but had not yet been polled for. |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get serverPollDelay():Number</code><br/></div><a name="propertyDetail"></a><a name="serverPrePushTime"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">serverPrePushTime</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>serverPrePushTime:Number</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Time between server receiving the client message and the server beginning to push |
| messages out to other clients as a result of the original message. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get serverPrePushTime():Number</code><br/></div><a name="propertyDetail"></a><a name="serverProcessingTime"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">serverProcessingTime</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>serverProcessingTime:Number</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Time between server receiving the client message and either the time |
| the server responded to the received message or had the pushed message ready |
| to be sent to the receiving client. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get serverProcessingTime():Number</code><br/></div><a name="propertyDetail"></a><a name="serverSendTime"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">serverSendTime</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>serverSendTime:Number</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Timestamp in milliseconds since epoch of when the server sent a response message back |
| to the client. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get serverSendTime():Number</code><br/></div><a name="propertyDetail"></a><a name="totalPushTime"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">totalPushTime</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>totalPushTime:Number</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Only populated in the case of a pushed message, this is the time between the push causing client |
| sending its message and the push receving client receiving it. Note that the two clients' |
| clocks must be in sync for this to be meaningful. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get totalPushTime():Number</code><br/></div><a name="propertyDetail"></a><a name="totalTime"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">totalTime</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>totalTime:Number</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Time between this client sending a message and receiving a response |
| for it from the server |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get totalTime():Number</code><br/></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="MessagePerformanceUtils()"></a><a name="MessagePerformanceUtils(Object)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">MessagePerformanceUtils</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function MessagePerformanceUtils(message:Object)</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p> |
| Constructor |
| |
| Creates an MPUtils instance with information from the MPI headers |
| of the passed in message |
| |
| </p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">message</span>:Object</code> — The message whose MPI headers will be used in retrieving |
| MPI information |
| </td></tr></table></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="prettyPrint()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">prettyPrint</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function prettyPrint():String</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Returns a summary of all information available in MPI. |
| For example: |
| |
| <pre> |
| var mpiutil:MessagePerformanceUtils = new MessagePerformanceUtils(message); |
| Alert.show(mpiutil.prettyPrint(), "MPI Output", Alert.NONMODAL); |
| </pre> |
| |
| </p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>String</code> — String containing a summary of all information available in MPI |
| </td></tr></table></div><br/><br/><hr><br/><p></p><center class="copyright"><footer>The Apache Software Foundation</footer><br/>Wed Nov 15 2017, 09:50 AM +01:00 </center></div></body></html><!--The Apache Software Foundation<br/>Wed Nov 15 2017, 09:50 AM +01:00 --> |
