You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flex.apache.org by qu...@apache.org on 2013/01/11 17:27:53 UTC

svn commit: r1432141 - in /flex/site/trunk/content/v2/asdoc/mx/messaging/messages: ./ AbstractMessage.html

Author: quetwo
Date: Fri Jan 11 16:27:53 2013
New Revision: 1432141

URL: http://svn.apache.org/viewvc?rev=1432141&view=rev
Log:
2 step commit to fix asdoc files screwed up by the CMS.

Added:
    flex/site/trunk/content/v2/asdoc/mx/messaging/messages/
    flex/site/trunk/content/v2/asdoc/mx/messaging/messages/AbstractMessage.html

Added: flex/site/trunk/content/v2/asdoc/mx/messaging/messages/AbstractMessage.html
URL: http://svn.apache.org/viewvc/flex/site/trunk/content/v2/asdoc/mx/messaging/messages/AbstractMessage.html?rev=1432141&view=auto
==============================================================================
--- flex/site/trunk/content/v2/asdoc/mx/messaging/messages/AbstractMessage.html (added)
+++ flex/site/trunk/content/v2/asdoc/mx/messaging/messages/AbstractMessage.html Fri Jan 11 16:27:53 2013
@@ -0,0 +1,142 @@
+<!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="AbstractMessage,mx.messaging.messages.AbstractMessage,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,MESSAGIN
 G_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,serverPr
 ePushTime,serverProcessingTime,serverSendTime,source,timeToLive,timeToLive,timestamp,timestamp,totalPushTime,totalTime,url,getOperationAsString,getSOAPAction,getSmallMessage,prettyPrint,toString,toString,toString"><title>mx.messaging.messages.AbstractMessage</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 = 'AbstractMessage - API Documentation';
+				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">API Documentation</td><td class="titleTableTopNav" align="right"><a href="../../../package-summary.html" onclick="loadClassListFrame('../../../all-classes.html')">All Packages</a>&nbsp;|&nbsp;<a href="../../../class-summary.html" onclick="loadClassListFrame('../../../all-classes.html')">All Classes</a>&nbsp;|&nbsp;<a href="../../../all-index-A.html" onclick="loadClassListFrame('../../../index-list.html')">Index</a>&nbsp;|&nbsp;<a id="framesLink1" href="../../../index.html?mx/messaging/messages/AbstractMessage.html&amp;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">AbstractMessage</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a>&nbsp;| <a href="#constantSummary">Constants</a></td></tr><tr class="titleTableRow3"><td colspan="3">&nbsp;</td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve">
+				<!--
+				
+					if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("AbstractMessage"); titleBar_setSubNav(true,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  AbstractMessage</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">AbstractMessage  <img src="../../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> Object</td></tr><tr><td class="classHeaderTableLabel">Implements</td><td> <a href="../../../mx/messaging/messages/IMessage.html">IMessage</a></td></tr><tr><td class="classHeaderTableLabel">Subclasses</td><td> <a href="../../../mx/messaging/messages/AsyncMessage.html">AsyncMessage</a>,  <a href="../../../mx/messaging/messages/HTTPRequestMes
 sage.html">HTTPRequestMessage</a>,  <a href="../../../mx/messaging/messages/RemotingMessage.html">RemotingMessage</a></td></tr></table><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 :&nbsp;</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 :&nbsp;</b></td><td>Flash Player  9, AIR 1.1</td></tr></table><p></p><p></p><p></p>
+  Abstract base class for all messages.
+  Messages have two customizable sections; headers and body.
+  The <code>headers</code> property provides access to specialized meta
+  information for a specific message instance.
+  The <code>headers</code> property is an associative array with the specific
+  header name as the key.
+  <p>
+  The body of a message contains the instance specific data that needs to be
+  delivered and processed by the remote destination.
+  The <code>body</code> is an object and is the payload for a message.
+  </p>
+  
+            <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>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#body" class="signatureLink">body</a> : Object<div class="summaryTableDescription">
+      The body of a message contains the specific data that needs to be 
+      delivered to the remote destination.</div></td><td class="summaryTableOwnerCol">AbstractMessage</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#clientId" class="signatureLink">clientId</a> : String<div class="summaryTableDescription">
+      The clientId indicates which MessageAgent sent the message.</div></td><td class="summaryTableOwnerCol">AbstractMessage</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#destination" class="signatureLink">destination</a> : String<div class="summaryTableDescription">
+      The message destination.</div></td><td class="summaryTableOwnerCol">AbstractMessage</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#headers" class="signatureLink">headers</a> : Object<div class="summaryTableDescription">
+      The headers of a message are an associative array where the key is the
+      header name and the value is the header value.</div></td><td class="summaryTableOwnerCol">AbstractMessage</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#messageId" class="signatureLink">messageId</a> : String<div class="summaryTableDescription">
+      The unique id for the message.</div></td><td class="summaryTableOwnerCol">AbstractMessage</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#timestamp" class="signatureLink">timestamp</a> : Number<div class="summaryTableDescription">
+      Provides access to the time stamp for the message.</div></td><td class="summaryTableOwnerCol">AbstractMessage</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#timeToLive" class="signatureLink">timeToLive</a> : Number<div class="summaryTableDescription">
+      The time to live value of a message indicates how long the message
+      should be considered valid and deliverable.</div></td><td class="summaryTableOwnerCol">AbstractMessage</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>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#AbstractMessage()" class="signatureLink">AbstractMessage</a>()</div><div class="summaryTableDescription">
+      Constructs an instance of an AbstractMessage with an empty body and header.</div></td><td class="summaryTableOwnerCol">AbstractMessage</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#toString()" class="signatureLink">toString</a>():String</div><div class="summaryTableDescription">
+      Returns a string representation of the message.</div></td><td class="summaryTableOwnerCol">AbstractMessage</td></tr></table></div><a name="constantSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Constants</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableConstant"><tr><th>&nbsp;</th><th colspan="2">Constant</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#DESTINATION_CLIENT_ID_HEADER" class="signatureLink">DESTINATION_CLIENT_ID_HEADER</a> : String = DSDstClientId<div class="summaryTableDescription">[static] 
+      Messages pushed from the server may arrive in a batch, with messages in the
+      batch potentially targeted to different Consumer instances.</div></td><td class="summaryTableOwnerCol">AbstractMessage</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#ENDPOINT_HEADER" class="signatureLink">ENDPOINT_HEADER</a> : String = DSEndpoint<div class="summaryTableDescription">[static] 
+      Messages are tagged with the endpoint id for the Channel they are sent over.</div></td><td class="summaryTableOwnerCol">AbstractMessage</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#FLEX_CLIENT_ID_HEADER" class="signatureLink">FLEX_CLIENT_ID_HEADER</a> : String = DSId<div class="summaryTableDescription">[static] 
+	  This header is used to transport the global FlexClient Id value in outbound 
+	  messages once it has been assigned by the server.</div></td><td class="summaryTableOwnerCol">AbstractMessage</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#PRIORITY_HEADER" class="signatureLink">PRIORITY_HEADER</a> : String = DSPriority<div class="summaryTableDescription">[static] 
+      Messages sent by a MessageAgent can have a priority header with a 0-9
+      numerical value (0 being lowest) and the server can choose to use this
+      numerical value to prioritize messages to clients.</div></td><td class="summaryTableOwnerCol">AbstractMessage</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#REMOTE_CREDENTIALS_CHARSET_HEADER" class="signatureLink">REMOTE_CREDENTIALS_CHARSET_HEADER</a> : String = DSRemoteCredentialsCharset<div class="summaryTableDescription">[static] 
+      Messages that need to set remote credentials for a destination
+      may also need to report the character-set encoding that was used to
+      create the credentials String using this header.</div></td><td class="summaryTableOwnerCol">AbstractMessage</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#REMOTE_CREDENTIALS_HEADER" class="signatureLink">REMOTE_CREDENTIALS_HEADER</a> : String = DSRemoteCredentials<div class="summaryTableDescription">[static] 
+      Messages that need to set remote credentials for a destination
+      carry the Base64 encoded credentials in this header.</div></td><td class="summaryTableOwnerCol">AbstractMessage</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#REQUEST_TIMEOUT_HEADER" class="signatureLink">REQUEST_TIMEOUT_HEADER</a> : String = DSRequestTimeout<div class="summaryTableDescription">[static] 
+	  Messages sent with a defined request timeout use this header.</div></td><td class="summaryTableOwnerCol">AbstractMessage</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#STATUS_CODE_HEADER" class="signatureLink">STATUS_CODE_HEADER</a> : String = DSStatusCode<div class="summaryTableDescription">[static] 
+      A status code can provide context about the nature of a response
+      message.</div></td><td class="summaryTableOwnerCol">AbstractMessage</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="body"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">body</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>body:Object</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 :&nbsp;</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 :&nbsp;</b></td><td>Flash Player  9, AIR 1.1</td></tr></table><p></p><p></p><p>
+      The body of a message contains the specific data that needs to be 
+      delivered to the remote destination.
+      
+      </p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get body():Object</code><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function set body(value:Object):void</code><br/></div><a name="propertyDetail"></a><a name="clientId"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">clientId</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>clientId:String</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 :&nbsp;</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 :&nbsp;</b></td><td>Flash Player  9, AIR 1.1</td></tr></table><p></p><p></p><p>
+      The clientId indicates which MessageAgent sent the message.
+      
+      </p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get clientId():String</code><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function set clientId(value:String):void</code><br/></div><a name="propertyDetail"></a><a name="destination"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">destination</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>destination:String</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 :&nbsp;</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 :&nbsp;</b></td><td>Flash Player  9, AIR 1.1</td></tr></table><p></p><p></p><p>
+      The message destination.
+      
+      </p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get destination():String</code><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function set destination(value:String):void</code><br/></div><a name="propertyDetail"></a><a name="headers"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">headers</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>headers:Object</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 :&nbsp;</b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valig
 n="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player  9, AIR 1.1</td></tr></table><p></p><p></p><p>
+      The headers of a message are an associative array where the key is the
+      header name and the value is the header value.
+      This property provides access to the specialized meta information for the 
+      specific message instance.
+      Core header names begin with a 'DS' prefix. Custom header names should start 
+      with a unique prefix to avoid name collisions.
+      
+      </p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get headers():Object</code><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function set headers(value:Object):void</code><br/></div><a name="propertyDetail"></a><a name="messageId"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">messageId</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>messageId:String</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 :&nbsp;</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 :&nbsp;</b></td><td>Flash Player  9, AIR 1.1</td></tr></table><p></p><p></p><p>
+      The unique id for the message.
+      
+      </p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get messageId():String</code><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function set messageId(value:String):void</code><br/></div><a name="propertyDetail"></a><a name="timestamp"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">timestamp</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>timestamp:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 :&nbsp;</b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" val
 ign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player  9, AIR 1.1</td></tr></table><p></p><p></p><p>
+      Provides access to the time stamp for the message.
+      A time stamp is the date and time that the message was sent.
+      The time stamp is used for tracking the message through the system,
+      ensuring quality of service levels and providing a mechanism for
+      message expiration.
+           </p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get timestamp():Number</code><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function set timestamp(value:Number):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="AbstractMessage.html#timeToLive" target="">timeToLive</a></div></div><a name="propertyDetail"></a><a name="timeToLive"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">timeToLive</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>timeToLive:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 
 :&nbsp;</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 :&nbsp;</b></td><td>Flash Player  9, AIR 1.1</td></tr></table><p></p><p></p><p>
+      The time to live value of a message indicates how long the message
+      should be considered valid and deliverable.
+      This value works in conjunction with the <code>timestamp</code> value.
+      Time to live is the number of milliseconds that this message remains
+      valid starting from the specified <code>timestamp</code> value.
+      For example, if the <code>timestamp</code> value is 04/05/05 1:30:45 PST
+      and the <code>timeToLive</code> value is 5000, then this message will
+      expire at 04/05/05 1:30:50 PST.
+      Once a message expires it will not be delivered to any other clients.
+      
+      </p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get timeToLive():Number</code><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function set timeToLive(value:Number):void</code><br/></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="AbstractMessage()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">AbstractMessage</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function AbstractMessage()</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 :&nbsp;</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 :&nbsp;</b></td><td>Flash Player  9, AIR 1.1</td></tr></table><p></p><p>
+      Constructs an instance of an AbstractMessage with an empty body and header.
+      This message type should not be instantiated or used directly.
+      
+      </p></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="toString()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">toString</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function toString():String</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 :&nbsp;</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 :&nbsp;</b></td><td>Flash Player  9, AIR 1.1</td></tr></table><p></p><p></p><p>
+      Returns a string representation of the message.
+           </p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>String</code> &mdash; String representation of the message.
+      
+      </td></tr></table></div><div class="detailSectionHeader">Constant Detail</div><a name="constantDetail"></a><a name="DESTINATION_CLIENT_ID_HEADER"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">DESTINATION_CLIENT_ID_HEADER</td><td class="detailHeaderType">Constant</td></tr></table><div class="detailBody"><code>public static const DESTINATION_CLIENT_ID_HEADER:String = DSDstClientId</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 :&nbsp;</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 :&nbsp;</b></td><td>Flash Player  9, AIR 1.1</td></tr></table><p></p><p
 ></p><p>
+      Messages pushed from the server may arrive in a batch, with messages in the
+      batch potentially targeted to different Consumer instances. 
+      Each message will contain this header identifying the Consumer instance that 
+      will receive the message.
+      
+      </p></div><a name="constantDetail"></a><a name="ENDPOINT_HEADER"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">ENDPOINT_HEADER</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>public static const ENDPOINT_HEADER:String = DSEndpoint</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 :&nbsp;</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 :&nbsp;</b></td><td>Flash Player  9, AIR 1.1</td></tr></table><p></p><p></p><p>
+      Messages are tagged with the endpoint id for the Channel they are sent over.
+      Channels set this value automatically when they send a message.
+      
+      </p></div><a name="constantDetail"></a><a name="FLEX_CLIENT_ID_HEADER"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">FLEX_CLIENT_ID_HEADER</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>public static const FLEX_CLIENT_ID_HEADER:String = DSId</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 :&nbsp;</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 :&nbsp;</b></td><td>Flash Player  9, AIR 1.1</td></tr></table><p></p><p></p><p>
+	  This header is used to transport the global FlexClient Id value in outbound 
+	  messages once it has been assigned by the server.
+	  
+	  </p></div><a name="constantDetail"></a><a name="PRIORITY_HEADER"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">PRIORITY_HEADER</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>public static const PRIORITY_HEADER:String = DSPriority</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 :&nbsp;</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 :&nbsp;</b></td><td>Flash Player  9, AIR 1.1</td></tr></table><p></p><p></p><p>
+      Messages sent by a MessageAgent can have a priority header with a 0-9
+      numerical value (0 being lowest) and the server can choose to use this
+      numerical value to prioritize messages to clients. 
+      
+      </p></div><a name="constantDetail"></a><a name="REMOTE_CREDENTIALS_CHARSET_HEADER"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">REMOTE_CREDENTIALS_CHARSET_HEADER</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>public static const REMOTE_CREDENTIALS_CHARSET_HEADER:String = DSRemoteCredentialsCharset</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 :&nbsp;</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 :&nbsp;</b></td><td>Flash Player  9, AIR 1.1</td></tr></table><p></p><p
 ></p><p>
+      Messages that need to set remote credentials for a destination
+      may also need to report the character-set encoding that was used to
+      create the credentials String using this header.  
+	  
+	  </p></div><a name="constantDetail"></a><a name="REMOTE_CREDENTIALS_HEADER"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">REMOTE_CREDENTIALS_HEADER</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>public static const REMOTE_CREDENTIALS_HEADER:String = DSRemoteCredentials</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 :&nbsp;</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 :&nbsp;</b></td><td>Flash Player  9, AIR 1.1</td></tr></table><p></p><p></p><p>
+      Messages that need to set remote credentials for a destination
+      carry the Base64 encoded credentials in this header.  
+	  
+	  </p></div><a name="constantDetail"></a><a name="REQUEST_TIMEOUT_HEADER"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">REQUEST_TIMEOUT_HEADER</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>public static const REQUEST_TIMEOUT_HEADER:String = DSRequestTimeout</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 :&nbsp;</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 :&nbsp;</b></td><td>Flash Player  9, AIR 1.1</td></tr></table><p></p><p></p><p>
+	  Messages sent with a defined request timeout use this header. 
+	  The request timeout value is set on outbound messages by services or 
+	  channels and the value controls how long the corresponding MessageResponder 
+	  will wait for an acknowledgement, result or fault response for the message
+	  before timing out the request.
+	  
+	  </p></div><a name="constantDetail"></a><a name="STATUS_CODE_HEADER"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">STATUS_CODE_HEADER</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>public static const STATUS_CODE_HEADER:String = DSStatusCode</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 :&nbsp;</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 :&nbsp;</b></td><td>Flash Player  9, AIR 1.1</td></tr></table><p></p><p></p><p>
+      A status code can provide context about the nature of a response
+      message. For example, messages received from an HTTP based channel may
+      need to report the HTTP response status code (if available).
+      
+      </p></div><br/><br/><hr><br/><p></p><center class="copyright"><footer></footer><br/>Mon Dec 24 2012, 01:18 PM +11:00  </center></div></body></html><!--<br/>Mon Dec 24 2012, 01:18 PM +11:00  -->
\ No newline at end of file