| <!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="ChannelSet,mx.messaging.ChannelSet,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.ChannelSet</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 = 'ChannelSet - ApacheFlex API Reference'; |
| var baseRef = '../../'; |
| window.onload = configPage; |
| --></script> |
| <script type="text/javascript"> |
| scrollToNameAnchor(); |
| </script><table class="titleTable" cellpadding="0" cellspacing="0" id="titleTable" style="display:none"><tr><td class="titleTableTitle" align="left">Apache Flex 4.16.1 API Reference </td><td class="titleTableTopNav" align="right"><a href="../../package-summary.html" onclick="loadClassListFrame('../../all-classes.html')">All Packages</a> | <a href="../../class-summary.html" onclick="loadClassListFrame('../../all-classes.html')">All Classes</a> | <a href="../../all-index-A.html" onclick="loadClassListFrame('../../index-list.html')">Index</a> | <a id="framesLink1" href="../../index.html?mx/messaging/ChannelSet.html&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">ChannelSet</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a> | <a href="#methodSummary">Methods</a> | <a href="#eventSummary">Events</a></td></tr><tr class="titleTableRow3"><td colspan="3"> </td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve"> |
| <!-- |
| |
| if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("ChannelSet"); 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 ChannelSet</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">ChannelSet <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> flash.events.EventDispatcher</td></tr></table><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p></p><p></p> |
| The ChannelSet is a set of Channels that are used to send messages to a |
| target destination. The ChannelSet improves the quality of service on the |
| client by hunting through its Channels to send messages in the face of |
| network failures or individual Channel problems. |
| <p></p><p><span class="classHeaderTableLabel">Default MXML Property</span><code>channels</code></p><br/><hr></div><a name="propertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Properties</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProperty"><tr><th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#authenticated" class="signatureLink">authenticated</a> : Boolean<div class="summaryTableDescription">[read-only] |
| Indicates whether the ChannelSet has an underlying Channel that successfully |
| authenticated with its endpoint.</div></td><td class="summaryTableOwnerCol">ChannelSet</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#channelIds" class="signatureLink">channelIds</a> : Array<div class="summaryTableDescription">[read-only] |
| The ids of the Channels used by the ChannelSet.</div></td><td class="summaryTableOwnerCol">ChannelSet</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#channels" class="signatureLink">channels</a> : Array<div class="summaryTableDescription"> |
| Provides access to the Channels in the ChannelSet.</div></td><td class="summaryTableOwnerCol">ChannelSet</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#clustered" class="signatureLink">clustered</a> : Boolean<div class="summaryTableDescription"> |
| Indicates whether the ChannelSet targets a clustered destination.</div></td><td class="summaryTableOwnerCol">ChannelSet</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#connected" class="signatureLink">connected</a> : Boolean<div class="summaryTableDescription">[read-only] |
| Indicates whether the ChannelSet is connected.</div></td><td class="summaryTableOwnerCol">ChannelSet</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#currentChannel" class="signatureLink">currentChannel</a> : <a href="../../mx/messaging/Channel.html">Channel</a><div class="summaryTableDescription">[read-only] |
| Returns the current Channel for the ChannelSet.</div></td><td class="summaryTableOwnerCol">ChannelSet</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#heartbeatInterval" class="signatureLink">heartbeatInterval</a> : int<div class="summaryTableDescription"> |
| The number of milliseconds between heartbeats sent to the remote |
| host while this ChannelSet is actively connected but idle.</div></td><td class="summaryTableOwnerCol">ChannelSet</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#initialDestinationId" class="signatureLink">initialDestinationId</a> : String<div class="summaryTableDescription"> |
| Provides access to the initial destination this ChannelSet is used to access.</div></td><td class="summaryTableOwnerCol">ChannelSet</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#messageAgents" class="signatureLink">messageAgents</a> : Array<div class="summaryTableDescription">[read-only] |
| Provides access to the set of MessageAgents that use this ChannelSet.</div></td><td class="summaryTableOwnerCol">ChannelSet</td></tr></table></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableMethod"><tr><th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#ChannelSet()" class="signatureLink">ChannelSet</a>(channelIds:Array = null, clusteredWithURLLoadBalancing:Boolean = false)</div><div class="summaryTableDescription"> |
| Constructs a ChannelSet.</div></td><td class="summaryTableOwnerCol">ChannelSet</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#addChannel()" class="signatureLink">addChannel</a>(channel:<a href="../../mx/messaging/Channel.html">Channel</a>):void</div><div class="summaryTableDescription"> |
| Adds a Channel to the ChannelSet.</div></td><td class="summaryTableOwnerCol">ChannelSet</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </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 and redispatches the event.</div></td><td class="summaryTableOwnerCol">ChannelSet</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </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 and redispatches the event.</div></td><td class="summaryTableOwnerCol">ChannelSet</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </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 and redispatches the event.</div></td><td class="summaryTableOwnerCol">ChannelSet</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#connect()" class="signatureLink">connect</a>(agent:<a href="../../mx/messaging/MessageAgent.html">MessageAgent</a>):void</div><div class="summaryTableDescription"> |
| Connects a MessageAgent to the ChannelSet.</div></td><td class="summaryTableOwnerCol">ChannelSet</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#disconnect()" class="signatureLink">disconnect</a>(agent:<a href="../../mx/messaging/MessageAgent.html">MessageAgent</a>):void</div><div class="summaryTableDescription"> |
| Disconnects a specific MessageAgent from the ChannelSet.</div></td><td class="summaryTableOwnerCol">ChannelSet</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#disconnectAll()" class="signatureLink">disconnectAll</a>():void</div><div class="summaryTableDescription"> |
| Disconnects all associated MessageAgents and disconnects any underlying Channel that |
| is connected.</div></td><td class="summaryTableOwnerCol">ChannelSet</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#login()" class="signatureLink">login</a>(username:String, password:String, charset:String = null):<a href="../../mx/rpc/AsyncToken.html">AsyncToken</a></div><div class="summaryTableDescription"> |
| Authenticates the ChannelSet with the server using the provided credentials.</div></td><td class="summaryTableOwnerCol">ChannelSet</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#logout()" class="signatureLink">logout</a>(agent:<a href="../../mx/messaging/MessageAgent.html">MessageAgent</a> = null):<a href="../../mx/rpc/AsyncToken.html">AsyncToken</a></div><div class="summaryTableDescription"> |
| Logs the ChannelSet out from the server.</div></td><td class="summaryTableOwnerCol">ChannelSet</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#removeChannel()" class="signatureLink">removeChannel</a>(channel:<a href="../../mx/messaging/Channel.html">Channel</a>):void</div><div class="summaryTableDescription"> |
| Removes a Channel from the ChannelSet.</div></td><td class="summaryTableOwnerCol">ChannelSet</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#send()" class="signatureLink">send</a>(agent:<a href="../../mx/messaging/MessageAgent.html">MessageAgent</a>, message:<a href="../../mx/messaging/messages/IMessage.html">IMessage</a>):void</div><div class="summaryTableDescription"> |
| Sends a message from a MessageAgent over the currently connected Channel.</div></td><td class="summaryTableOwnerCol">ChannelSet</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#setCredentials()" class="signatureLink">setCredentials</a>(credentials:String, agent:<a href="../../mx/messaging/MessageAgent.html">MessageAgent</a>, charset:String = null):void</div><div class="summaryTableDescription"> |
| Stores the credentials and passes them through to every connected channel.</div></td><td class="summaryTableOwnerCol">ChannelSet</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#toString()" class="signatureLink">toString</a>():String</div><div class="summaryTableDescription">[override] |
| Returns a String containing the ids of the Channels in the ChannelSet.</div></td><td class="summaryTableOwnerCol">ChannelSet</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> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#messageHandler()" class="signatureLink">messageHandler</a>(event:<a href="../../mx/messaging/events/MessageEvent.html">MessageEvent</a>):void</div><div class="summaryTableDescription"> |
| Redispatches message events from the currently connected Channel.</div></td><td class="summaryTableOwnerCol">ChannelSet</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> </th><th colspan="2">Event</th><th> Summary </th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:channelConnect" class="signatureLink">channelConnect</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched after a Channel in the ChannelSet has connected to its endpoint.</td><td class="summaryTableOwnerCol">ChannelSet</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:channelDisconnect" class="signatureLink">channelDisconnect</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched after a Channel in the ChannelSet has disconnected from its endpoint.</td><td class="summaryTableOwnerCol">ChannelSet</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:channelFault" class="signatureLink">channelFault</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched after a Channel in the ChannelSet has faulted.</td><td class="summaryTableOwnerCol">ChannelSet</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:fault" class="signatureLink">fault</a></div></td><td class="summaryTableDescription summaryTableCol">The fault event is dispatched when a login or logout call fails.</td><td class="summaryTableOwnerCol">ChannelSet</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:propertyChange" class="signatureLink">propertyChange</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when a property of the ChannelSet changes.</td><td class="summaryTableOwnerCol">ChannelSet</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:result" class="signatureLink">result</a></div></td><td class="summaryTableDescription summaryTableCol">The result event is dispatched when a login or logout call successfully returns.</td><td class="summaryTableOwnerCol">ChannelSet</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> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Indicates whether the ChannelSet has an underlying Channel that successfully |
| authenticated with its endpoint. |
| </p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> public function get authenticated():Boolean</code><br/></div><a name="propertyDetail"></a><a name="channelIds"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">channelIds</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>channelIds:Array</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The ids of the Channels used by the ChannelSet. |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get channelIds():Array</code><br/></div><a name="propertyDetail"></a><a name="channels"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">channels</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>channels:Array</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Provides access to the Channels in the ChannelSet. |
| This property may be used to assign a set of channels at once or channels |
| may be added directly to the ChannelSet via addChannel() individually. |
| If this ChannelSet is <code>configured</code> automatically the individual |
| channels are created lazily and added to this property as needed. |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get channels():Array</code><br/><code> public function set channels(value:Array):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>flash.errors:IllegalOperationError </code> — If the ChannelSet is |
| <code>configured</code>, assigning to this property is not allowed. |
| </td></tr></table></div><a name="propertyDetail"></a><a name="clustered"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">clustered</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>clustered:Boolean</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Indicates whether the ChannelSet targets a clustered destination. |
| If true, upon a successful connection the ChannelSet will query the |
| destination for all clustered endpoints for its Channels and will assign |
| failoverURIs to them. |
| Channel ids are used to assign failoverURIs to the proper Channel instances |
| so this requires that all Channels in the ChannelSet have non-null ids and an |
| Error will be thrown when this property is set to true if this is not the case. |
| If the ChannelSet is not using url load balancing on the client this |
| property should not be set to true. |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get clustered():Boolean</code><br/><code> public function set clustered(value:Boolean):void</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"> </td></tr></table><div class="detailBody"><code>connected:Boolean</code> [read-only] <p></p><p></p><p> |
| Indicates whether the ChannelSet is connected. |
| </p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> public function get connected():Boolean</code><br/></div><a name="propertyDetail"></a><a name="currentChannel"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">currentChannel</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>currentChannel:<a href="../../mx/messaging/Channel.html">Channel</a></code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Returns the current Channel for the ChannelSet. |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get currentChannel():<a href="../../mx/messaging/Channel.html">Channel</a></code><br/></div><a name="propertyDetail"></a><a name="heartbeatInterval"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">heartbeatInterval</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>heartbeatInterval:int</code><p></p><p></p><p> |
| The number of milliseconds between heartbeats sent to the remote |
| host while this ChannelSet is actively connected but idle. |
| Any outbound message traffic will delay heartbeats temporarily, with |
| this number of milliseconds elapsing after the last sent message before |
| the next heartbeat is issued. |
| <p> |
| This property is useful for applications that connect to a remote host |
| to received pushed updates and are not actively sending any messages, but |
| still wish to be notified of a dropped connection even when the networking |
| layer fails to provide such notification directly. By issuing periodic |
| heartbeats the client can force the networking layer to report a timeout |
| if the underlying connection has dropped without notification and the |
| application can respond to the disconnect appropriately. |
| </p> |
| <p> |
| Any non-positive value disables heartbeats to the remote host. |
| The default value is 0 indicating that heartbeats are disabled. |
| If the application sets this value it should prefer a longer rather than |
| shorter interval, to avoid placing unnecessary load on the remote host. |
| As an illustrative example, low-level TCP socket keep-alives generally |
| default to an interval of 2 hours. That is a longer interval than most |
| applications that enable heartbeats will likely want to use, but it |
| serves as a clear precedent to prefer a longer interval over a shorter |
| interval. |
| </p> |
| <p> |
| If the currently connected underlying Channel issues poll requests to |
| the remote host, heartbeats are suppressed because the periodic poll |
| requests effectively take their place.</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get heartbeatInterval():int</code><br/><code> public function set heartbeatInterval(value:int):void</code><br/></div><a name="propertyDetail"></a><a name="initialDestinationId"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">initialDestinationId</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>initialDestinationId:String</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Provides access to the initial destination this ChannelSet is used to access. |
| When the clustered property is true, this value is used to request available failover URIs |
| for the configured channels for the destination. |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get initialDestinationId():String</code><br/><code> public function set initialDestinationId(value:String):void</code><br/></div><a name="propertyDetail"></a><a name="messageAgents"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">messageAgents</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>messageAgents:Array</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Provides access to the set of MessageAgents that use this ChannelSet. |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get messageAgents():Array</code><br/></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="ChannelSet()"></a><a name="ChannelSet(Array,Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">ChannelSet</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function ChannelSet(channelIds:Array = null, clusteredWithURLLoadBalancing:Boolean = false)</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p> |
| Constructs a ChannelSet. |
| If the <code>channelIds</code> argument is provided, the ChannelSet will |
| use automatically configured Channels obtained via <code>ServerConfig.getChannel()</code> |
| to reach a destination. |
| Attempting to manually assign Channels to a ChannelSet that uses configured |
| Channels is not allowed. |
| <p>If the <code>channelIds</code> argument is not provided or is null, |
| Channels must be manually created and added to the ChannelSet in order |
| to connect and send messages.</p> |
| <p>If the ChannelSet is clustered using url-load-balancing (where each server |
| declares a unique RTMP or HTTP URL and the client fails over from one URL to |
| the next), the first time that a Channel in the ChannelSet successfully connects |
| the ChannelSet will automatically make a request for all of the endpoints across |
| the cluster for all member Channels and will assign these failover URLs to each |
| respective Channel. |
| This allows Channels in the ChannelSet to failover individually, and when failover |
| options for a specific Channel are exhausted the ChannelSet will advance to the next |
| Channel in the set to attempt to reconnect.</p> |
| <p>Regardless of clustering, if a Channel cannot connect or looses |
| connectivity, the ChannelSet will advance to its next available Channel |
| and attempt to reconnect. |
| This allows the ChannelSet to hunt through Channels that use different |
| protocols, ports, etc., in search of one that can connect to its endpoint |
| successfully.</p> |
| </p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">channelIds</span>:Array</code> (default = <code>null</code>)<code></code> — The ids of configured Channels obtained from ServerConfig for this ChannelSet to |
| use. If null, Channels must be manually added to the ChannelSet. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">clusteredWithURLLoadBalancing</span>:Boolean</code> (default = <code>false</code>)<code></code> — True if the Channels in the ChannelSet are clustered |
| using url load balancing. |
| </td></tr></table></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="addChannel()"></a><a name="addChannel(mx.messaging.Channel)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">addChannel</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function addChannel(channel:<a href="../../mx/messaging/Channel.html">Channel</a>):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Adds a Channel to the ChannelSet. A Channel with a null id cannot be added |
| to the ChannelSet if the ChannelSet targets a clustered destination. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">channel</span>:<a href="../../mx/messaging/Channel.html">Channel</a></code> — The Channel to add. |
| </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> — If the ChannelSet is |
| <code>configured</code>, adding a Channel is not supported. |
| This error is also thrown if the ChannelSet's <code>clustered</code> property |
| is <code>true</code> but the Channel has a null id. |
| </td></tr></table></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"> </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 : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Handles a CONNECT ChannelEvent and redispatches the event. |
| </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> — 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"> </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 : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Handles a DISCONNECT ChannelEvent and redispatches the event. |
| </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> — 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"> </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 : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Handles a ChannelFaultEvent and redispatches the event. |
| </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> — The ChannelFaultEvent. |
| </td></tr></table></p></div><a name="connect()"></a><a name="connect(mx.messaging.MessageAgent)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">connect</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function connect(agent:<a href="../../mx/messaging/MessageAgent.html">MessageAgent</a>):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Connects a MessageAgent to the ChannelSet. Once connected, the agent |
| can use the ChannelSet to send 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">agent</span>:<a href="../../mx/messaging/MessageAgent.html">MessageAgent</a></code> — The MessageAgent to connect. |
| </td></tr></table></p></div><a name="disconnect()"></a><a name="disconnect(mx.messaging.MessageAgent)"></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"> </td></tr></table><div class="detailBody"><code> public function disconnect(agent:<a href="../../mx/messaging/MessageAgent.html">MessageAgent</a>):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Disconnects a specific MessageAgent from the ChannelSet. If this is the |
| last MessageAgent using the ChannelSet and the current Channel in the set is |
| connected, the Channel will physically disconnect from the server. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">agent</span>:<a href="../../mx/messaging/MessageAgent.html">MessageAgent</a></code> — The MessageAgent to disconnect. |
| </td></tr></table></p></div><a name="disconnectAll()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">disconnectAll</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function disconnectAll():void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Disconnects all associated MessageAgents and disconnects any underlying Channel that |
| is connected. |
| Unlike <code>disconnect(MessageAgent)</code> which is invoked by the disconnect implementations |
| of specific service components, this method provides a single, convenient point to shut down |
| connectivity between the client and server. |
| </p></div><a name="login()"></a><a name="login(String,String,String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">login</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function login(username:String, password:String, charset:String = null):<a href="../../mx/rpc/AsyncToken.html">AsyncToken</a></code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Authenticates the ChannelSet with the server using the provided credentials. |
| Unlike other operations on Channels and the ChannelSet, this operation returns an |
| AsyncToken that client code may add a responder to in order to handle success or |
| failure directly. |
| If the ChannelSet is not connected to the server when this method is invoked it will |
| trigger a connect attempt, and if successful, send the login command to the server. |
| Only one login or logout operation may be pending at a time and overlapping calls will |
| generate an IllegalOperationError. |
| Invoking login when the ChannelSet is already authenticated will generate also generate |
| an IllegalOperationError. |
| </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> — The username. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">password</span>:String</code> — The password. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">charset</span>:String</code> (default = <code>null</code>)<code></code> — 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><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code><a href="../../mx/rpc/AsyncToken.html">AsyncToken</a></code> — Returns a token that client code may add a responder to in order to handle |
| success or failure directly. |
| </td></tr></table><br/><span class="label">Throws</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>flash.errors:IllegalOperationError </code> — in two situations; if the ChannelSet is |
| already authenticated, or if a login or logout operation is currently in progress. |
| </td></tr></table></div><a name="logout()"></a><a name="logout(mx.messaging.MessageAgent)"></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"> </td></tr></table><div class="detailBody"><code> public function logout(agent:<a href="../../mx/messaging/MessageAgent.html">MessageAgent</a> = null):<a href="../../mx/rpc/AsyncToken.html">AsyncToken</a></code><p></p><p></p><p> |
| Logs the ChannelSet out from the server. Unlike other operations on Channels |
| and the ChannelSet, this operation returns an AsyncToken that client code may |
| add a responder to in order to handle success or failure directly. |
| If logout is successful any credentials that have been cached for use in |
| automatic reconnects are cleared for the ChannelSet and its Channels and their |
| authenticated state is set to false. |
| If the ChannelSet is not connected to the server when this method is invoked it |
| will trigger a connect attempt, and if successful, send a logout command to the server. |
| <p>The MessageAgent argument is present to support legacy logout behavior and client code that |
| invokes this method should not pass a MessageAgent reference. Just invoke <code>logout()</code> |
| passing no arguments.</p> |
| <p>This method is also invoked by service components from their <code>logout()</code> |
| methods, and these components pass a MessageAgent reference to this method when they logout. |
| The presence of this argument is the trigger to execute legacy logout behavior that differs |
| from the new behavior described above. |
| Legacy behavior only sends a logout request to the server if the client is connected |
| and authenticated. |
| If these conditions are not met the legacy behavior for this method is to do nothing other |
| than clear any credentials that have been cached for use in automatic reconnects.</p> |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">agent</span>:<a href="../../mx/messaging/MessageAgent.html">MessageAgent</a></code> (default = <code>null</code>)<code></code> — Legacy argument. The MessageAgent that is initiating the logout. |
| </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><a href="../../mx/rpc/AsyncToken.html">AsyncToken</a></code> — Returns a token that client code may |
| add a responder to in order to handle success or failure directly. |
| </td></tr></table><br/><span class="label">Throws</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>flash.errors:IllegalOperationError </code> — if a login or logout operation is currently in progress. |
| </td></tr></table></div><a name="messageHandler()"></a><a name="messageHandler(mx.messaging.events.MessageEvent)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">messageHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function messageHandler(event:<a href="../../mx/messaging/events/MessageEvent.html">MessageEvent</a>):void</code><p></p><p></p><p> |
| Redispatches message events from the currently connected Channel. |
| </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/MessageEvent.html">MessageEvent</a></code> — The MessageEvent from the Channel. |
| </td></tr></table></p></div><a name="removeChannel()"></a><a name="removeChannel(mx.messaging.Channel)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">removeChannel</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function removeChannel(channel:<a href="../../mx/messaging/Channel.html">Channel</a>):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Removes a Channel from the ChannelSet. If the Channel to remove is |
| currently connected and being used by the ChannelSet, it is |
| disconnected as well as removed. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">channel</span>:<a href="../../mx/messaging/Channel.html">Channel</a></code> — The Channel to remove. |
| </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> — If the ChannelSet is |
| <code>configured</code>, removing a Channel is not supported. |
| </td></tr></table></div><a name="send()"></a><a name="send(mx.messaging.MessageAgent,mx.messaging.messages.IMessage)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">send</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function send(agent:<a href="../../mx/messaging/MessageAgent.html">MessageAgent</a>, 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 : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Sends a message from a MessageAgent over the currently connected Channel. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">agent</span>:<a href="../../mx/messaging/MessageAgent.html">MessageAgent</a></code> — The MessageAgent sending the message. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">message</span>:<a href="../../mx/messaging/messages/IMessage.html">IMessage</a></code> — The Message to send. |
| </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/NoChannelAvailableError.html">NoChannelAvailableError</a> </code> — If the ChannelSet has no internal |
| Channels to use. |
| </td></tr></table></div><a name="setCredentials()"></a><a name="setCredentials(String,mx.messaging.MessageAgent,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"> </td></tr></table><div class="detailBody"><code> public function setCredentials(credentials:String, agent:<a href="../../mx/messaging/MessageAgent.html">MessageAgent</a>, 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 : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Stores the credentials and passes them through to every connected channel. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">credentials</span>:String</code> — The credentials for the MessageAgent. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">agent</span>:<a href="../../mx/messaging/MessageAgent.html">MessageAgent</a></code> — The MessageAgent that is setting the credentials. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">charset</span>:String</code> (default = <code>null</code>)<code></code> — The character set encoding used while encoding the |
| credentials. The default is null, which implies the legacy encoding of |
| ISO-Latin-1. |
| </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> — 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="toString()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">toString</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>override 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 : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Returns a String containing the ids of the Channels in the ChannelSet. |
| </p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>String</code> — String representation of the ChannelSet. |
| </td></tr></table></div><div class="detailSectionHeader"> Event Detail </div><a name="event:channelConnect"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">channelConnect</td><td class="detailHeaderType"> Event </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 : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched after a Channel in the ChannelSet has connected to its endpoint. |
| </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"> </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 : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched after a Channel in the ChannelSet has disconnected from its |
| endpoint. |
| </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"> </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 : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched after a Channel in the ChannelSet has faulted. |
| </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"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/rpc/events/FaultEvent.html"><code>mx.rpc.events.FaultEvent</code></a><br/><span class="label">FaultEvent.type property = </span><a href="../../mx/rpc/events/FaultEvent.html#FAULT"><code>mx.rpc.events.FaultEvent.FAULT</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The fault event is dispatched when a login or logout call fails. |
| </p> |
| The FAULT event type. |
| <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>true, calling preventDefault() |
| from the associated token's responder.fault method will prevent |
| the service or operation from dispatching 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>fault</code></td><td>The Fault object that contains the |
| details of what caused this event.</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><tr><td><code>token</code></td><td>The token that represents the call |
| to the method. Used in the asynchronous completion token pattern.</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"> </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 : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched when a property of the ChannelSet 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> |
| </div><a name="event:result"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">result</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/rpc/events/ResultEvent.html"><code>mx.rpc.events.ResultEvent</code></a><br/><span class="label">ResultEvent.type property = </span><a href="../../mx/rpc/events/ResultEvent.html#RESULT"><code>mx.rpc.events.ResultEvent.RESULT</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The result event is dispatched when a login or logout call successfully returns. |
| </p> |
| The RESULT event type. |
| <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>true, preventDefault() |
| from the associated token's responder.result method will prevent |
| the service or operation from dispatching 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>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><tr><td><code>result</code></td><td>Result that the RPC call returns.</td></tr><tr><td><code>token</code></td><td>The token that represents the indiviudal call |
| to the method. Used in the asynchronous completion token pattern.</td></tr></table> |
| |
| </div><br/><br/><hr><br/><p></p><center class="copyright"><footer>The Apache Software Foundation</footer><br/>Wed Nov 15 2017, 09:50 AM +01:00 </center></div></body></html><!--The Apache Software Foundation<br/>Wed Nov 15 2017, 09:50 AM +01:00 --> |
