| Package | mx.messaging.messages |
| Class | public class MessagePerformanceUtils |
| Inheritance | MessagePerformanceUtils  Object |
| Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
You can then use methods of this utility class to retrieve various performance information about the message that you have just received.
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:
var mpiutil:MessagePerformanceUtils = new MessagePerformanceUtils(event.message);
More examples
Measuring performance for different channel types
Enabling message processing metrics
Writing messaging metrics to the log files
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| clientReceiveTime : Number [read-only]
Timestamp in milliseconds since epoch of when the client received response message from
the server. | MessagePerformanceUtils | ||
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| messageSize : int [read-only]
The size of the original client message as measured during deserialization by the server
endpoint. | MessagePerformanceUtils | ||
| networkRTT : Number [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. | MessagePerformanceUtils | ||
| originatingMessageSentTime : Number [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. | MessagePerformanceUtils | ||
| originatingMessageSize : Number [read-only]
Only populated in the case of a pushed message, size in Bytes of the message that originally
caused this pushed message. | MessagePerformanceUtils | ||
| pushedMessageFlag : Boolean [read-only]
Returns true if message was pushed to the client and is not a response to a message that
originated on the client. | MessagePerformanceUtils | ||
| pushOneWayTime : Number [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. | MessagePerformanceUtils | ||
| responseMessageSize : int [read-only]
The size of the response message sent to the client by the server as measured during serialization
at the server endpoint. | MessagePerformanceUtils | ||
| serverAdapterExternalTime : Number [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. | MessagePerformanceUtils | ||
| serverAdapterTime : Number [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. | MessagePerformanceUtils | ||
| serverNonAdapterTime : Number [read-only]
Server processing time spent outside of the adapter associated with the destination of this message. | MessagePerformanceUtils | ||
| serverPollDelay : Number [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. | MessagePerformanceUtils | ||
| serverPrePushTime : Number [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. | MessagePerformanceUtils | ||
| serverProcessingTime : Number [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. | MessagePerformanceUtils | ||
| serverSendTime : Number [read-only]
Timestamp in milliseconds since epoch of when the server sent a response message back
to the client. | MessagePerformanceUtils | ||
| totalPushTime : Number [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. | MessagePerformanceUtils | ||
| totalTime : Number [read-only]
Time between this client sending a message and receiving a response
for it from the server
| MessagePerformanceUtils | ||
| Method | Defined By | ||
|---|---|---|---|
MessagePerformanceUtils(message:Object)
Constructor
Creates an MPUtils instance with information from the MPI headers
of the passed in message
| MessagePerformanceUtils | ||
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
Returns a summary of all information available in MPI. | MessagePerformanceUtils | ||
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
clientReceiveTime | property |
clientReceiveTime:Number [read-only] | Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Timestamp in milliseconds since epoch of when the client received response message from the server.
Implementation
public function get clientReceiveTime():NumbermessageSize | property |
networkRTT | property |
networkRTT:Number [read-only] | Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
Implementation
public function get networkRTT():NumberoriginatingMessageSentTime | property |
originatingMessageSentTime:Number [read-only] | Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
Implementation
public function get originatingMessageSentTime():NumberoriginatingMessageSize | property |
originatingMessageSize:Number [read-only] | Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Only populated in the case of a pushed message, size in Bytes of the message that originally caused this pushed message.
Implementation
public function get originatingMessageSize():NumberpushedMessageFlag | property |
pushedMessageFlag:Boolean [read-only] | Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns true if message was pushed to the client and is not a response to a message that originated on the client.
Implementation
public function get pushedMessageFlag():BooleanpushOneWayTime | property |
pushOneWayTime:Number [read-only] | Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
Implementation
public function get pushOneWayTime():NumberresponseMessageSize | property |
responseMessageSize:int [read-only] | Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The size of the response message sent to the client by the server as measured during serialization at the server endpoint.
Implementation
public function get responseMessageSize():intserverAdapterExternalTime | property |
serverAdapterExternalTime:Number [read-only] | Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
Implementation
public function get serverAdapterExternalTime():NumberserverAdapterTime | property |
serverAdapterTime:Number [read-only] | Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
Implementation
public function get serverAdapterTime():NumberserverNonAdapterTime | property |
serverNonAdapterTime:Number [read-only] | Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Server processing time spent outside of the adapter associated with the destination of this message.
Implementation
public function get serverNonAdapterTime():NumberserverPollDelay | property |
serverPollDelay:Number [read-only] | Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
Implementation
public function get serverPollDelay():NumberserverPrePushTime | property |
serverPrePushTime:Number [read-only] | Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
Implementation
public function get serverPrePushTime():NumberserverProcessingTime | property |
serverProcessingTime:Number [read-only] | Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
Implementation
public function get serverProcessingTime():NumberserverSendTime | property |
serverSendTime:Number [read-only] | Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Timestamp in milliseconds since epoch of when the server sent a response message back to the client.
Implementation
public function get serverSendTime():NumbertotalPushTime | property |
totalPushTime:Number [read-only] | Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
Implementation
public function get totalPushTime():NumbertotalTime | property |
totalTime:Number [read-only] | Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Time between this client sending a message and receiving a response for it from the server
Implementation
public function get totalTime():NumberMessagePerformanceUtils | () | Constructor |
public function MessagePerformanceUtils(message:Object)| Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructor Creates an MPUtils instance with information from the MPI headers of the passed in message
Parametersmessage:Object — The message whose MPI headers will be used in retrieving
MPI information
|
prettyPrint | () | method |
public function prettyPrint():String| Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns a summary of all information available in MPI. For example:
var mpiutil:MessagePerformanceUtils = new MessagePerformanceUtils(message);
Alert.show(mpiutil.prettyPrint(), "MPI Output", Alert.NONMODAL);
ReturnsString — String containing a summary of all information available in MPI
|
Wed Nov 21 2018, 06:34 AM -08:00