asdoc/mx/messaging/messages/MessagePerformanceInfo.swf.json

{ "type": "class",
  "qname": "mx.messaging.messages.MessagePerformanceInfo",
  "baseClassname": ""
  ,
    "description": "The MessagePerformanceInfo class is used to capture 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. A response message should have two instances of this class among its headers, headers[MPII] - info for the client to server message, headers[MPIO] - info for the response message from server to client. A pushed message will have an extra headers and its headers will represent, headers[MPII] - info for the client to server message poll message (non RTMP) headers[MPIO] - info for the pushed message from server to client, headers[MPIP] - info for the message from the client that caused the push message",
  "tags": [
  {  "tagName": "private",
         "values": []}  ],
  "members": [
  { "type": "method",
        "qname": "mx.messaging.messages.MessagePerformanceInfo",
        "namespace": "",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "return": "",
          "params": []}
      ,
      { "type": "accessor",
        "access": "read-write",
        "return": "int",
        "qname": "messageSize",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Size of message in Bytes (message types depends on what header this MPI is in)",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "Number",
        "qname": "sendTime",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Millisecond timestamp of when this message was sent (origin depends on on what header this MPI is in)",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "Number",
        "qname": "overheadTime",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Amount of time in milliseconds that this message was being processed on the server in order to calculate and populate MPI metrics",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "Boolean",
        "qname": "pushedFlag",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "True if this is info for a message that was pushed from server to client",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "Number",
        "qname": "serverPrePushTime",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Millisecond timestamp of when the server became ready to push this message out to clients",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "Number",
        "qname": "serverPreAdapterTime",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Millisecond timestamp of when the server called into the adapter associated with the destination of this message",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "Number",
        "qname": "serverPostAdapterTime",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Millisecond timestamp of when server processing returned from the adapater associated with the destination of this message",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "Number",
        "qname": "serverPreAdapterExternalTime",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Millisecond timestamp of when the adapter associated with the destination of this message made a call to an external component (for example a JMS server)",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "Number",
        "qname": "serverPostAdapterExternalTime",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Millisecond timestamp of when processing came back to the adapter associated with the destination of this message from a call to an external component (for example a JMS server)",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "Boolean",
        "qname": "recordMessageTimes",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Flag is true when record-message-times is enabled for the communication channel",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "Boolean",
        "qname": "recordMessageSizes",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Flag is true when record-message-sizes is enabled for the communication channel",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "String",
        "qname": "infoType",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Sets the info type of this message (IN or OUT).  Used to mark the MPI with the client receive time when this MPI is of type OUT (IN, OUT are from the perspective of the server)",
        "tags": [
        {  "tagName": "param",
               "values": ["type - "IN" or "OUT" info type"]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "Number",
        "qname": "receiveTime",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Sets reveive time of this message. When the infoType is "OUT", we should skip override the receive time See the set infoType for details",
        "tags": [
        {  "tagName": "param",
               "values": ["time - the receive time to set"]}  ]}]
  }