blob: 91a5f9f9221c1e023dd3db29ade185098e7e6b49 [file] [log] [blame]
<!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="MessageAgent,mx.messaging.MessageAgent,CONNECT_TIMEOUT_SECONDS,DEFAULT_PRIORITY,ENABLE_SMALL_MESSAGES,FALSE,RECORD_MESSAGE_SIZES,RECORD_MESSAGE_TIMES,REQUEST_TIMEOUT_SECONDS,SERIALIZATION,TRUE,_shouldBeSubscribed,agent,authenticated,authenticated,authenticated,autoConnect,channel,channelIds,channelSet,channelSets,channels,clientId,clustered,connectTimeout,connected,connected,connected,currentChannel,defaultHeaders,destination,endpoint,failoverURIs,heartbeatInterval,id,id,initialDestinationId,maxFrequency,maxFrequency,message,messageAgents,priority,protocol,reconnectAttempts,reconnectInterval,reconnecting,recordMessageSizes,recordMessageTimes,requestTimeout,requestTimeout,resubscribeAttempts,resubscribeInterval,selector,selector,shouldBeConnected,subscribed,subscriptions,subtopic,subtopic,subtopic,subtopics,timestamp,uri,acknowledge,addChannel,addSubscription,addSubtopic,applyClientLoadBalancingSettings,applySettings,buildSubscribeMessage,buildSubscribeMessage,buildUnsubscribeMessage,buildUnsubscribeMessage,channelConnectHandler,channelConnectHandler,channelDisconnectHandler,channelDisconnectHandler,channelFaultHandler,channelFaultHandler,connect,connect,connect,connectFailed,connectSuccess,connectTimeoutHandler,createRequestTimeoutErrorMessage,disconnect,disconnect,disconnect,disconnect,disconnect,disconnectAll,disconnectFailed,disconnectSuccess,fault,flexClientWaitHandler,getInstance,getMessageResponder,handleAuthenticationFault,hasPendingRequestForMessage,initChannelSet,initialized,internalConnect,internalDisconnect,internalSend,internalSend,login,logout,logout,logout,messageHandler,reAuthorize,receive,removeChannel,removeSubscription,removeSubtopic,requestTimedOut,result,resultHandler,send,send,send,setCredentials,setCredentials,setCredentials,setRemoteCredentials,status,statusHandler,subscribe,toString,unsubscribe"><title>mx.messaging.MessageAgent</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 = 'MessageAgent - 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>&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/MessageAgent.html&amp;mx/messaging/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">MessageAgent</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a>&nbsp;| <a href="#eventSummary">Events</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("MessageAgent"); titleBar_setSubNav(false,true,false,false,false,false,true,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</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class MessageAgent</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">MessageAgent <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> flash.events.EventDispatcher</td></tr><tr><td class="classHeaderTableLabel">Implements</td><td> <a href="../../mx/core/IMXMLObject.html">IMXMLObject</a></td></tr><tr><td class="classHeaderTableLabel">Subclasses</td><td> <a href="../../mx/messaging/AbstractConsumer.html">AbstractConsumer</a>, <a href="../../mx/messaging/AbstractProducer.html">AbstractProducer</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><p></p>
The MessageAgent class provides the basic low-level functionality common to
message handling for a destination.
<p>
<b>Note:</b> For advanced use only.
Use this class for creating custom message agents like the existing Producer
and Consumer classes.</p>
<p></p><a name="mxmlSyntaxSummary"></a><span class="classHeaderTableLabel">MXML Syntax</span><span id="showMxmlLink" style="display:none"><a href="#mxmlSyntaxSummary" onclick="toggleMXMLOnly();"><img src="../../images/collapsed.gif" title="collapsed" alt="collapsed" class="collapsedImage">Show MXML Syntax</a><br/></span><span id="hideMxmlLink"><a href="#mxmlSyntaxSummary" onclick="toggleMXMLOnly();"><img src="../../images/expanded.gif" title="expanded" alt="expanded" class="expandedImage">Hide MXML Syntax</a></span><div id="mxmlSyntax" class="mxmlSyntax"> <p>
All message agent classes, including the Producer and Consumer classes, extend
MessageAgent and inherit the following tag attributes:
</p>
<pre>
&lt;mx:<i>tagname</i><br>
<b>Properties</b>
channelSet="<i>No default.</i>"
clientId="<i>No default.</i>"
connected="<i>false</i>"
destination="<i>No default.</i>"
requestTimeout="<i>-1</i>"
subtopic="<i>No default.</i>"
<b>Events</b>
acknowledge="<i>No default.</i>"
channelConnect="<i>No default.</i>"
channelDisconnect="<i>No default.</i>"
channelFault="<i>No default.</i>"
fault="<i>No default.</i>"
propertyChange="<i>No default.</i>"
/&gt;
</pre>
</div><script language="javascript" type="text/javascript"><!--
setMXMLOnly();
--></script><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="#authenticated" class="signatureLink">authenticated</a> : Boolean<div class="summaryTableDescription">[read-only]
Indicates if this MessageAgent is using an authenticated connection to
its destination.</div></td><td class="summaryTableOwnerCol">MessageAgent</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#channelSet" class="signatureLink">channelSet</a> : <a href="../../mx/messaging/ChannelSet.html">ChannelSet</a><div class="summaryTableDescription">
Provides access to the ChannelSet used by the MessageAgent.</div></td><td class="summaryTableOwnerCol">MessageAgent</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">[read-only]
Provides access to the client id for the MessageAgent.</div></td><td class="summaryTableOwnerCol">MessageAgent</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#connected" class="signatureLink">connected</a> : Boolean<div class="summaryTableDescription">[read-only]
Indicates whether this MessageAgent is currently connected to its
destination via its ChannelSet.</div></td><td class="summaryTableOwnerCol">MessageAgent</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">
Provides access to the destination for the MessageAgent.</div></td><td class="summaryTableOwnerCol">MessageAgent</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#requestTimeout" class="signatureLink">requestTimeout</a> : int<div class="summaryTableDescription">
Provides access to the request timeout in seconds for sent messages.</div></td><td class="summaryTableOwnerCol">MessageAgent</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="#MessageAgent()" class="signatureLink">MessageAgent</a>()</div><div class="summaryTableDescription">
Constructor.</div></td><td class="summaryTableOwnerCol">MessageAgent</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#acknowledge()" class="signatureLink">acknowledge</a>(ackMsg:<a href="../../mx/messaging/messages/AcknowledgeMessage.html">AcknowledgeMessage</a>, msg:<a href="../../mx/messaging/messages/IMessage.html">IMessage</a>):void</div><div class="summaryTableDescription">
Invoked by a MessageResponder upon receiving a result for a sent
message.</div></td><td class="summaryTableOwnerCol">MessageAgent</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#channelConnectHandler()" class="signatureLink">channelConnectHandler</a>(event:<a href="../../mx/messaging/events/ChannelEvent.html">ChannelEvent</a>):void</div><div class="summaryTableDescription">
Handles a CONNECT ChannelEvent.</div></td><td class="summaryTableOwnerCol">MessageAgent</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#channelDisconnectHandler()" class="signatureLink">channelDisconnectHandler</a>(event:<a href="../../mx/messaging/events/ChannelEvent.html">ChannelEvent</a>):void</div><div class="summaryTableDescription">
Handles a DISCONNECT ChannelEvent.</div></td><td class="summaryTableOwnerCol">MessageAgent</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#channelFaultHandler()" class="signatureLink">channelFaultHandler</a>(event:<a href="../../mx/messaging/events/ChannelFaultEvent.html">ChannelFaultEvent</a>):void</div><div class="summaryTableDescription">
Handles a ChannelFaultEvent.</div></td><td class="summaryTableOwnerCol">MessageAgent</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#disconnect()" class="signatureLink">disconnect</a>():void</div><div class="summaryTableDescription">
Disconnects the MessageAgent's network connection.</div></td><td class="summaryTableOwnerCol">MessageAgent</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#fault()" class="signatureLink">fault</a>(errMsg:<a href="../../mx/messaging/messages/ErrorMessage.html">ErrorMessage</a>, msg:<a href="../../mx/messaging/messages/IMessage.html">IMessage</a>):void</div><div class="summaryTableDescription">
Invoked by a MessageResponder upon receiving a fault for a sent message.</div></td><td class="summaryTableOwnerCol">MessageAgent</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#hasPendingRequestForMessage()" class="signatureLink">hasPendingRequestForMessage</a>(msg:<a href="../../mx/messaging/messages/IMessage.html">IMessage</a>):Boolean</div><div class="summaryTableDescription">
Returns true if there are any pending requests for the passed in message.</div></td><td class="summaryTableOwnerCol">MessageAgent</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#initialized()" class="signatureLink">initialized</a>(document:Object, id:String):void</div><div class="summaryTableDescription">
Called after the implementing object has been created
and all properties specified on the tag have been assigned.</div></td><td class="summaryTableOwnerCol">MessageAgent</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#logout()" class="signatureLink">logout</a>():void</div><div class="summaryTableDescription">
Logs the MessageAgent out from its remote destination.</div></td><td class="summaryTableOwnerCol">MessageAgent</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#setCredentials()" class="signatureLink">setCredentials</a>(username:String, password:String, charset:String = null):void</div><div class="summaryTableDescription">
Sets the credentials that the MessageAgent uses to authenticate to
destinations.</div></td><td class="summaryTableOwnerCol">MessageAgent</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#setRemoteCredentials()" class="signatureLink">setRemoteCredentials</a>(username:String, password:String, charset:String = null):void</div><div class="summaryTableDescription">
Sets the remote credentials that will be passed through to the remote destination
for authenticating to secondary systems.</div></td><td class="summaryTableOwnerCol">MessageAgent</td></tr></table></div><a name="protectedMethodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Protected Methods </div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProtectedMethod"><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="#handleAuthenticationFault()" class="signatureLink">handleAuthenticationFault</a>(errMsg:<a href="../../mx/messaging/messages/ErrorMessage.html">ErrorMessage</a>, msg:<a href="../../mx/messaging/messages/IMessage.html">IMessage</a>):void</div><div class="summaryTableDescription">
Handles the authentication fault on the server.</div></td><td class="summaryTableOwnerCol">MessageAgent</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#initChannelSet()" class="signatureLink">initChannelSet</a>(message:<a href="../../mx/messaging/messages/IMessage.html">IMessage</a>):void</div><div class="summaryTableDescription">
Used to automatically initialize the channelSet property for the
MessageAgent before it connects for the first time.</div></td><td class="summaryTableOwnerCol">MessageAgent</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#internalSend()" class="signatureLink">internalSend</a>(message:<a href="../../mx/messaging/messages/IMessage.html">IMessage</a>, waitForClientId:Boolean = true):void</div><div class="summaryTableDescription">
Sends a Message from the MessageAgent to its destination using the
agent's ChannelSet.</div></td><td class="summaryTableOwnerCol">MessageAgent</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#reAuthorize()" class="signatureLink">reAuthorize</a>(msg:<a href="../../mx/messaging/messages/IMessage.html">IMessage</a>):void</div><div class="summaryTableDescription">
This function should be overriden by sublasses to implement reauthentication due to
server session time-out behavior specific to them.</div></td><td class="summaryTableOwnerCol">MessageAgent</td></tr></table></div><a name="eventSummary"></a><div class="summarySection"><div class="summaryTableTitle">Events</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableEvent"><tr><th>&nbsp;</th><th colspan="2">Event</th><th> Summary </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="#event:acknowledge" class="signatureLink">acknowledge</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when an acknowledge message is received for a sent message.</td><td class="summaryTableOwnerCol">MessageAgent</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:channelConnect" class="signatureLink">channelConnect</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when the underlying Channel the MessageAgent is using connects.</td><td class="summaryTableOwnerCol">MessageAgent</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:channelDisconnect" class="signatureLink">channelDisconnect</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when the underlying Channel the MessageAgent is using disconnects.</td><td class="summaryTableOwnerCol">MessageAgent</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:channelFault" class="signatureLink">channelFault</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when the underlying Channel the MessageAgent is using faults.</td><td class="summaryTableOwnerCol">MessageAgent</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:fault" class="signatureLink">fault</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when a message fault occurs.</td><td class="summaryTableOwnerCol">MessageAgent</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:propertyChange" class="signatureLink">propertyChange</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when the connected property of the MessageAgent changes.</td><td class="summaryTableOwnerCol">MessageAgent</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="authenticated"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">authenticated</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>authenticated:Boolean</code>&nbsp;&nbsp;[read-only] <p></p><p></p><p>
Indicates if this MessageAgent is using an authenticated connection to
its destination.
</p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get authenticated():Boolean</code><br/></div><a name="propertyDetail"></a><a name="channelSet"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">channelSet</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>channelSet:<a href="../../mx/messaging/ChannelSet.html">ChannelSet</a></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>
Provides access to the ChannelSet used by the MessageAgent. The
ChannelSet can be manually constructed and assigned, or it will be
dynamically initialized to use the configured Channels for the
destination for this MessageAgent.
</p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get channelSet():<a href="../../mx/messaging/ChannelSet.html">ChannelSet</a></code><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function set channelSet(value:<a href="../../mx/messaging/ChannelSet.html">ChannelSet</a>):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>&nbsp;&nbsp;[read-only] <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>
Provides access to the client id for the MessageAgent.
MessageAgents are assigned their client id by the remote destination
and this value is used to route messages from the remote destination to
the proper MessageAgent.
</p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get clientId():String</code><br/></div><a name="propertyDetail"></a><a name="connected"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">connected</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>connected:Boolean</code>&nbsp;&nbsp;[read-only] <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>
Indicates whether this MessageAgent is currently connected to its
destination via its ChannelSet. The <code>propertyChange</code> event is dispatched when
this property changes.
</p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get connected():Boolean</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>
Provides access to the destination for the MessageAgent.
Changing the destination will disconnect the MessageAgent if it is
currently connected.
</p><p>This property can be used as the source for data binding.</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/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code><a href="../../mx/messaging/errors/InvalidDestinationError.html">InvalidDestinationError</a> </code> &mdash; If the destination is null or
zero-length.
</td></tr></table></div><a name="propertyDetail"></a><a name="requestTimeout"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">requestTimeout</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>requestTimeout:int</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>
Provides access to the request timeout in seconds for sent messages.
If an acknowledgement, response or fault is not received from the
remote destination before the timeout is reached the message is faulted on the client.
A value less than or equal to zero prevents request timeout.
</p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get requestTimeout():int</code><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function set requestTimeout(value:int):void</code><br/></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="MessageAgent()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">MessageAgent</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function MessageAgent()</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>
Constructor.
</p></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="acknowledge()"></a><a name="acknowledge(mx.messaging.messages.AcknowledgeMessage,mx.messaging.messages.IMessage)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">acknowledge</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function acknowledge(ackMsg:<a href="../../mx/messaging/messages/AcknowledgeMessage.html">AcknowledgeMessage</a>, msg:<a href="../../mx/messaging/messages/IMessage.html">IMessage</a>):void</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>
Invoked by a MessageResponder upon receiving a result for a sent
message. Subclasses may override this method if they need to perform
custom acknowledgement processing, but must invoke
<code>super.acknowledge()</code> as well. This method dispatches a
MessageAckEvent.
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">ackMsg</span>:<a href="../../mx/messaging/messages/AcknowledgeMessage.html">AcknowledgeMessage</a></code> &mdash; The AcknowledgMessage returned.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">msg</span>:<a href="../../mx/messaging/messages/IMessage.html">IMessage</a></code> &mdash; The original sent message.
</td></tr></table></p></div><a name="channelConnectHandler()"></a><a name="channelConnectHandler(mx.messaging.events.ChannelEvent)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">channelConnectHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> public function channelConnectHandler(event:<a href="../../mx/messaging/events/ChannelEvent.html">ChannelEvent</a>):void</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>
Handles a CONNECT ChannelEvent. Subclasses that need to perform custom
processing should override this method, and invoke
<code>super.channelConnectHandler()</code>.
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:<a href="../../mx/messaging/events/ChannelEvent.html">ChannelEvent</a></code> &mdash; The ChannelEvent.
</td></tr></table></p></div><a name="channelDisconnectHandler()"></a><a name="channelDisconnectHandler(mx.messaging.events.ChannelEvent)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">channelDisconnectHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> public function channelDisconnectHandler(event:<a href="../../mx/messaging/events/ChannelEvent.html">ChannelEvent</a>):void</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>
Handles a DISCONNECT ChannelEvent. Subclasses that need to perform
custom processing should override this method, and invoke
<code>super.channelDisconnectHandler()</code>.
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:<a href="../../mx/messaging/events/ChannelEvent.html">ChannelEvent</a></code> &mdash; The ChannelEvent.
</td></tr></table></p></div><a name="channelFaultHandler()"></a><a name="channelFaultHandler(mx.messaging.events.ChannelFaultEvent)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">channelFaultHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> public function channelFaultHandler(event:<a href="../../mx/messaging/events/ChannelFaultEvent.html">ChannelFaultEvent</a>):void</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>
Handles a ChannelFaultEvent. Subclasses that need to perform custom
processing should override this method, and invoke
<code>super.channelFaultHandler()</code>.
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:<a href="../../mx/messaging/events/ChannelFaultEvent.html">ChannelFaultEvent</a></code> &mdash; ChannelFaultEvent
</td></tr></table></p></div><a name="disconnect()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">disconnect</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> public function disconnect():void</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>
Disconnects the MessageAgent's network connection.
This method does not wait for outstanding network operations to complete.
</p></div><a name="fault()"></a><a name="fault(mx.messaging.messages.ErrorMessage,mx.messaging.messages.IMessage)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">fault</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> public function fault(errMsg:<a href="../../mx/messaging/messages/ErrorMessage.html">ErrorMessage</a>, msg:<a href="../../mx/messaging/messages/IMessage.html">IMessage</a>):void</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>
Invoked by a MessageResponder upon receiving a fault for a sent message.
Subclasses may override this method if they need to perform custom fault
processing, but must invoke <code>super.fault()</code> as well. This
method dispatchs a MessageFaultEvent.
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">errMsg</span>:<a href="../../mx/messaging/messages/ErrorMessage.html">ErrorMessage</a></code> &mdash; The ErrorMessage.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">msg</span>:<a href="../../mx/messaging/messages/IMessage.html">IMessage</a></code> &mdash; The original sent message that caused this fault.
</td></tr></table></p></div><a name="handleAuthenticationFault()"></a><a name="handleAuthenticationFault(mx.messaging.messages.ErrorMessage,mx.messaging.messages.IMessage)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">handleAuthenticationFault</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> protected function handleAuthenticationFault(errMsg:<a href="../../mx/messaging/messages/ErrorMessage.html">ErrorMessage</a>, msg:<a href="../../mx/messaging/messages/IMessage.html">IMessage</a>):void</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>
Handles the authentication fault on the server. If the authenticated flag is true,
the authentication fault must have been caused by a session expiration on the server.
Set the authenticated state to false and if loginAfterDisconnect flag is enabled,
resend credentials to the server by disconnecting and resending the message again.
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">errMsg</span>:<a href="../../mx/messaging/messages/ErrorMessage.html">ErrorMessage</a></code> &mdash; The Error Message.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">msg</span>:<a href="../../mx/messaging/messages/IMessage.html">IMessage</a></code> &mdash; The message that caused the fault and should be resent once we have
disconnected/connected causing re-authentication.
</td></tr></table></p></div><a name="hasPendingRequestForMessage()"></a><a name="hasPendingRequestForMessage(mx.messaging.messages.IMessage)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">hasPendingRequestForMessage</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> public function hasPendingRequestForMessage(msg:<a href="../../mx/messaging/messages/IMessage.html">IMessage</a>):Boolean</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 true if there are any pending requests for the passed in message.
This method should be overriden by subclasses
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">msg</span>:<a href="../../mx/messaging/messages/IMessage.html">IMessage</a></code> &mdash; The message for which the existence of pending requests is checked.
</td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Boolean</code> &mdash; Returns <code>true</code> if there are any pending requests for the
passed in message.
</td></tr></table></div><a name="initChannelSet()"></a><a name="initChannelSet(mx.messaging.messages.IMessage)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">initChannelSet</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> protected function initChannelSet(message:<a href="../../mx/messaging/messages/IMessage.html">IMessage</a>):void</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>
Used to automatically initialize the <code>channelSet</code> property for the
MessageAgent before it connects for the first time.
Subtypes may override to perform custom initialization.
</p><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>:<a href="../../mx/messaging/messages/IMessage.html">IMessage</a></code> &mdash; The message that needs to be sent.
</td></tr></table></p></div><a name="initialized()"></a><a name="initialized(Object,String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">initialized</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> public function initialized(document:Object, id:String):void</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>
Called after the implementing object has been created
and all properties specified on the tag have been assigned.
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">document</span>:Object</code> &mdash; MXML document that created this object.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">id</span>:String</code> &mdash; id used by the document to refer to this object.
If the object is a deep property on the document, id is null.
</td></tr></table></p></div><a name="internalSend()"></a><a name="internalSend(mx.messaging.messages.IMessage,Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">internalSend</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> protected function internalSend(message:<a href="../../mx/messaging/messages/IMessage.html">IMessage</a>, waitForClientId:Boolean = true):void</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>
Sends a Message from the MessageAgent to its destination using the
agent's ChannelSet. MessageAgent subclasses must use this method to
send their messages.
</p><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>:<a href="../../mx/messaging/messages/IMessage.html">IMessage</a></code> &mdash; The message to send.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">waitForClientId</span>:Boolean</code> (default = <code>true</code>)<code></code> &mdash; If true the message may be queued until a clientId has been
assigned to the agent. In general this is the desired behavior.
For special behavior (automatic reconnect and resubscribe) the
agent may pass false to override the default queuing behavior.
</td></tr></table></p><br/><span class="label">Throws</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code><a href="../../mx/messaging/errors/InvalidDestinationError.html">InvalidDestinationError</a> </code> &mdash; If no destination is set.
</td></tr></table></div><a name="logout()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">logout</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> public function logout():void</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>
Logs the MessageAgent out from its remote destination.
Logging out of a destination applies to everything connected using the same ChannelSet
as specified in the server configuration. For example, if several DataService components
are connected over an RTMP channel and <code>logout()</code> is invoked on one of them,
all other client components that are connected using the same ChannelSet are also logged out.
<p><b>Note:</b> Adobe recommends that you use the mx.messaging.ChannelSet.logout() method
rather than this method. </p>
</p><p><span class="label">See also</span></p><div class="seeAlso"><a href="ChannelSet.html#logout()" target="">mx.messaging.ChannelSet.logout()</a></div></div><a name="reAuthorize()"></a><a name="reAuthorize(mx.messaging.messages.IMessage)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">reAuthorize</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> protected function reAuthorize(msg:<a href="../../mx/messaging/messages/IMessage.html">IMessage</a>):void</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 function should be overriden by sublasses to implement reauthentication due to
server session time-out behavior specific to them. In general, it should follow disconnect,
connect, resend message pattern.
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">msg</span>:<a href="../../mx/messaging/messages/IMessage.html">IMessage</a></code> &mdash; The message that caused the fault and should be resent once we have
disconnected/connected causing reauthentication.
</td></tr></table></p></div><a name="setCredentials()"></a><a name="setCredentials(String,String,String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">setCredentials</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> public function setCredentials(username:String, password:String, charset:String = null):void</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>
Sets the credentials that the MessageAgent uses to authenticate to
destinations.
The credentials are applied to all services connected over the same ChannelSet.
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">username</span>:String</code> &mdash; The username.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">password</span>:String</code> &mdash; The password.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">charset</span>:String</code> (default = <code>null</code>)<code></code> &mdash; The character set encoding to use while encoding the
credentials. The default is null, which implies the legacy charset of
ISO-Latin-1. The only other supported charset is "UTF-8".
</td></tr></table></p><br/><span class="label">Throws</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>flash.errors:IllegalOperationError </code> &mdash; in two situations; if credentials
have already been set and an authentication is in progress with the remote
detination, or if authenticated and the credentials specified don't match
the currently authenticated credentials.
</td></tr></table></div><a name="setRemoteCredentials()"></a><a name="setRemoteCredentials(String,String,String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">setRemoteCredentials</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> public function setRemoteCredentials(username:String, password:String, charset:String = null):void</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>
Sets the remote credentials that will be passed through to the remote destination
for authenticating to secondary systems.
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">username</span>:String</code> &mdash; The username.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">password</span>:String</code> &mdash; The password.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">charset</span>:String</code> (default = <code>null</code>)<code></code> &mdash; The character set encoding to use while encoding the
remote credentials. The default is null, which implies the legacy
charset of ISO-Latin-1. The only other currently supported option is
"UTF-8".
</td></tr></table></p></div><div class="detailSectionHeader"> Event Detail </div><a name="event:acknowledge"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">acknowledge</td><td class="detailHeaderType"> Event </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/messaging/events/MessageAckEvent.html"><code>mx.messaging.events.MessageAckEvent</code></a><br/><span class="label">MessageAckEvent.type property = </span><a href="../../mx/messaging/events/MessageAckEvent.html#ACKNOWLEDGE"><code>mx.messaging.events.MessageAckEvent.ACKNOWLEDGE</code></a><br/><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, 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, Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p>
Dispatched when an acknowledge message is received for a sent message.
</p>
The ACKNOWLEDGE event type; dispatched upon receipt of an acknowledgement.
<p>The value of this constant is <code>"acknowledge"</code>.</p>
<p>The properties of the event object have the following values:</p>
<table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>acknowledgeMessage</code></td><td> Utility property to get
the message property from MessageEvent as an AcknowledgeMessage.</td></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the
event listener that handles the event. For example, if you use
<code>myButton.addEventListener()</code> to register an event listener,
myButton is the value of the <code>currentTarget</code>.</td></tr><tr><td><code>correlate</code></td><td> The original Message correlated with
this acknowledgement.</td></tr><tr><td><code>message</code></td><td>The Message associated with this event.</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event;
it is not always the Object listening for the event.
Use the <code>currentTarget</code> property to always access the
Object listening for the event.</td></tr></table>
</div><a name="event:channelConnect"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">channelConnect</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/messaging/events/ChannelEvent.html"><code>mx.messaging.events.ChannelEvent</code></a><br/><span class="label">ChannelEvent.type property = </span><a href="../../mx/messaging/events/ChannelEvent.html#CONNECT"><code>mx.messaging.events.ChannelEvent.CONNECT</code></a><br/><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>
Dispatched when the underlying Channel the MessageAgent is using connects.
</p>
The CONNECT event type; indicates that the Channel connected to its
endpoint.
<p>The value of this constant is <code>"channelConnect"</code>.</p>
<p>The properties of the event object have the following values:</p>
<table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>channel</code></td><td>The channel that generated this event.</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the
event listener that handles the event. For example, if you use
<code>myButton.addEventListener()</code> to register an event listener,
myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event;
it is not always the Object listening for the event.
Use the <code>currentTarget</code> property to always access the
Object listening for the event.</td></tr><tr><td><code>reconnecting</code></td><td> Indicates whether the channel
that generated this event is reconnecting.</td></tr><tr><td><code>rejected</code></td><td> Indicates whether the channel that
generated this event was rejected. This would be true in the event that
the channel has been disconnected due to inactivity and should not attempt to
failover or connect on an alternate channel.</td></tr></table>
</div><a name="event:channelDisconnect"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">channelDisconnect</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/messaging/events/ChannelEvent.html"><code>mx.messaging.events.ChannelEvent</code></a><br/><span class="label">ChannelEvent.type property = </span><a href="../../mx/messaging/events/ChannelEvent.html#DISCONNECT"><code>mx.messaging.events.ChannelEvent.DISCONNECT</code></a><br/><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>
Dispatched when the underlying Channel the MessageAgent is using disconnects.
</p>
The DISCONNECT event type; indicates that the Channel disconnected from its
endpoint.
<p>The value of this constant is <code>"channelDisconnect"</code>.</p>
<p>The properties of the event object have the following values:</p>
<table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>channel</code></td><td>The channel that generated this event.</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the
event listener that handles the event. For example, if you use
<code>myButton.addEventListener()</code> to register an event listener,
myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event;
it is not always the Object listening for the event.
Use the <code>currentTarget</code> property to always access the
Object listening for the event.</td></tr><tr><td><code>reconnecting</code></td><td> Indicates whether the channel
that generated this event is reconnecting.</td></tr><tr><td><code>rejected</code></td><td> Indicates whether the channel that
generated this event was rejected. This would be true in the event that
the channel has been disconnected due to inactivity and should not attempt to
failover or connect on an alternate channel.</td></tr></table>
</div><a name="event:channelFault"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">channelFault</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/messaging/events/ChannelFaultEvent.html"><code>mx.messaging.events.ChannelFaultEvent</code></a><br/><span class="label">ChannelFaultEvent.type property = </span><a href="../../mx/messaging/events/ChannelFaultEvent.html#FAULT"><code>mx.messaging.events.ChannelFaultEvent.FAULT</code></a><br/><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>
Dispatched when the underlying Channel the MessageAgent is using faults.
</p>
The FAULT event type; indicates that the Channel faulted.
<p>The value of this constant is <code>"channelFault"</code>.</p>
<p>The properties of the event object have the following values:</p>
<table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>channel</code></td><td>The Channel that generated this event.</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the
event listener that handles the event. For example, if you use
<code>myButton.addEventListener()</code> to register an event listener,
myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>faultCode</code></td><td>Provides destination-specific
details of the failure.</td></tr><tr><td><code>faultDetail</code></td><td>Provides access to the
destination-specific reason for the failure.</td></tr><tr><td><code>faultString</code></td><td>Provides access to the underlying
reason for the failure if the channel did not raise the failure itself.</td></tr><tr><td><code>reconnecting</code></td><td> Indicates whether the channel
that generated this event is reconnecting.</td></tr><tr><td><code>rootCause</code></td><td> Provides access to the underlying reason
for the failure if the channel did not raise the failure itself.</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event;
it is not always the Object listening for the event.
Use the <code>currentTarget</code> property to always access the
Object listening for the event.</td></tr></table>
</div><a name="event:fault"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">fault</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/messaging/events/MessageFaultEvent.html"><code>mx.messaging.events.MessageFaultEvent</code></a><br/><span class="label">MessageFaultEvent.type property = </span><a href="../../mx/messaging/events/MessageFaultEvent.html#FAULT"><code>mx.messaging.events.MessageFaultEvent.FAULT</code></a><br/><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>
Dispatched when a message fault occurs.
</p>
The FAULT event type; dispatched for a message fault.
<p>The value of this constant is <code>"fault"</code>.</p>
<p>The properties of the event object have the following values:</p>
<table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the
event listener that handles the event. For example, if you use
<code>myButton.addEventListener()</code> to register an event listener,
myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>faultCode</code></td><td>Provides destination-specific
details of the failure.</td></tr><tr><td><code>faultDetail</code></td><td>Provides access to the
destination-specific reason for the failure.</td></tr><tr><td><code>faultString</code></td><td>Provides access to the underlying
reason for the failure if the channel did not raise the failure itself.</td></tr><tr><td><code>message</code></td><td>The ErrorMessage for this event.</td></tr><tr><td><code>rootCause</code></td><td> Provides access to the underlying reason
for the failure, if one exists.</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event;
it is not always the Object listening for the event.
Use the <code>currentTarget</code> property to always access the
Object listening for the event.</td></tr></table>
</div><a name="event:propertyChange"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">propertyChange</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/PropertyChangeEvent.html"><code>mx.events.PropertyChangeEvent</code></a><br/><span class="label">PropertyChangeEvent.type property = </span><a href="../../mx/events/PropertyChangeEvent.html#PROPERTY_CHANGE"><code>mx.events.PropertyChangeEvent.PROPERTY_CHANGE</code></a><br/><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>
Dispatched when the <code>connected</code> property of the MessageAgent changes.
Also dispatched when the <code>subscribed</code> of a Consumer changes.
</p>
The <code>PropertyChangeEvent.PROPERTY_CHANGE</code> constant defines the value of the
<code>type</code> property of the event object for a <code>PropertyChange</code> event.
<p>The properties of the event object have the following values:</p>
<table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>Determined by the constructor; defaults to false.</td></tr><tr><td><code>cancelable</code></td><td>Determined by the constructor; defaults to false.</td></tr><tr><td><code>kind</code></td><td>The kind of change; PropertyChangeEventKind.UPDATE
or PropertyChangeEventKind.DELETE.</td></tr><tr><td><code>oldValue</code></td><td>The original property value.</td></tr><tr><td><code>newValue</code></td><td>The new property value, if any.</td></tr><tr><td><code>property</code></td><td>The property that changed.</td></tr><tr><td><code>source</code></td><td>The object that contains the property that changed.</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the
event listener that handles the event. For example, if you use
<code>myButton.addEventListener()</code> to register an event listener,
myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event;
it is not always the Object listening for the event.
Use the <code>currentTarget</code> property to always access the
Object listening for the event.</td></tr></table>
<p><span class="label">See also</span></p><div class="seeAlso"><a href="Consumer.html" target="">mx.messaging.Consumer</a></div></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 -->