| <!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="MultiTopicProducer,mx.messaging.MultiTopicProducer,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.MultiTopicProducer</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 = 'MultiTopicProducer - 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/MultiTopicProducer.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">MultiTopicProducer</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("MultiTopicProducer"); 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 MultiTopicProducer</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">MultiTopicProducer <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> <a href="../../mx/messaging/AbstractProducer.html">AbstractProducer</a> <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> <a href="../../mx/messaging/MessageAgent.html">MessageAgent</a> <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> |
| A MultiTopicProducer sends messages to a destination with zero or more subtopics. |
| It is like the regular Producer but it can direct the message to any consumer who |
| is subscribing to any one of a number of subtopics. If the consumer is a |
| MultiTopicConsumer and that consumer has subscribed to more than on subtopic in the |
| list of subtopics used by the producer, the consumer only receives the message once. |
| <p> |
| The MultiTopicProducer will dispatch a MessageAckEvent or MessageFaultEvent |
| for each message they send depending upon whether the outbound message |
| was sent and processed successfully or not. |
| </p> |
| |
| <p></p><br/><hr></div><a name="propertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Properties</div><div class="showHideLinks"><div id="hideInheritedProperty" class="hideInheritedProperty"><a class="showHideLink" href="#propertySummary" onclick="javascript:setInheritedVisible(false,'Property');"><img class="showHideLinkImage" src="../../images/expanded.gif"> Hide Inherited Public Properties</a></div><div id="showInheritedProperty" class="showInheritedProperty"><a class="showHideLink" href="#propertySummary" onclick="javascript:setInheritedVisible(true,'Property');"><img class="showHideLinkImage" src="../../images/collapsed.gif"> Show Inherited Public Properties</a></div></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="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/messaging/MessageAgent.html#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"><a href="../../mx/messaging/MessageAgent.html">MessageAgent</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/messaging/AbstractProducer.html#autoConnect" class="signatureLink">autoConnect</a> : Boolean<div class="summaryTableDescription"> |
| If true the Producer automatically connects to its destination the |
| first time the send() method is called.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/messaging/AbstractProducer.html">AbstractProducer</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/messaging/MessageAgent.html#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"><a href="../../mx/messaging/MessageAgent.html">MessageAgent</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/messaging/MessageAgent.html#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"><a href="../../mx/messaging/MessageAgent.html">MessageAgent</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/messaging/MessageAgent.html#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"><a href="../../mx/messaging/MessageAgent.html">MessageAgent</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/messaging/AbstractProducer.html#defaultHeaders" class="signatureLink">defaultHeaders</a> : Object<div class="summaryTableDescription"> |
| The default headers to apply to messages sent by the Producer.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/messaging/AbstractProducer.html">AbstractProducer</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/messaging/MessageAgent.html#destination" class="signatureLink">destination</a> : String<div class="summaryTableDescription"> |
| Provides access to the destination for the MessageAgent.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/messaging/MessageAgent.html">MessageAgent</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/messaging/AbstractProducer.html#priority" class="signatureLink">priority</a> : int<div class="summaryTableDescription"> |
| The default message priority for the messages sent by the Producer.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/messaging/AbstractProducer.html">AbstractProducer</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/messaging/AbstractProducer.html#reconnectAttempts" class="signatureLink">reconnectAttempts</a> : int<div class="summaryTableDescription"> |
| The number of reconnect attempts that the Producer makes in the event |
| that the destination is unavailable or the connection to the destination closes.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/messaging/AbstractProducer.html">AbstractProducer</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/messaging/AbstractProducer.html#reconnectInterval" class="signatureLink">reconnectInterval</a> : int<div class="summaryTableDescription"> |
| The number of milliseconds between reconnect attempts.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/messaging/AbstractProducer.html">AbstractProducer</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/messaging/MessageAgent.html#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"><a href="../../mx/messaging/MessageAgent.html">MessageAgent</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#subtopics" class="signatureLink">subtopics</a> : <a href="../../mx/collections/ArrayCollection.html">ArrayCollection</a><div class="summaryTableDescription"> |
| Provides access to the list of subtopics used in publishing any messages |
| |
| </div></td><td class="summaryTableOwnerCol">MultiTopicProducer</td></tr></table></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </div><div class="showHideLinks"><div id="hideInheritedMethod" class="hideInheritedMethod"><a class="showHideLink" href="#methodSummary" onclick="javascript:setInheritedVisible(false,'Method');"><img class="showHideLinkImage" src="../../images/expanded.gif"> Hide Inherited Public Methods</a></div><div id="showInheritedMethod" class="showInheritedMethod"><a class="showHideLink" href="#methodSummary" onclick="javascript:setInheritedVisible(true,'Method');"><img class="showHideLinkImage" src="../../images/collapsed.gif"> Show Inherited Public Methods</a></div></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="#MultiTopicProducer()" class="signatureLink">MultiTopicProducer</a>()</div><div class="summaryTableDescription"> |
| Constructor.</div></td><td class="summaryTableOwnerCol">MultiTopicProducer</td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/messaging/MessageAgent.html#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"><a href="../../mx/messaging/MessageAgent.html">MessageAgent</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#addSubtopic()" class="signatureLink">addSubtopic</a>(subtopic:String):void</div><div class="summaryTableDescription"> |
| Adds a subtopic to the current list of subtopics for messages sent by this |
| producer.</div></td><td class="summaryTableOwnerCol">MultiTopicProducer</td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/messaging/MessageAgent.html#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"><a href="../../mx/messaging/MessageAgent.html">MessageAgent</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/messaging/MessageAgent.html#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"><a href="../../mx/messaging/MessageAgent.html">MessageAgent</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/messaging/MessageAgent.html#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"><a href="../../mx/messaging/MessageAgent.html">MessageAgent</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/messaging/AbstractProducer.html#connect()" class="signatureLink">connect</a>():void</div><div class="summaryTableDescription"> |
| Connects the Producer to its target destination.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/messaging/AbstractProducer.html">AbstractProducer</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/messaging/AbstractProducer.html#disconnect()" class="signatureLink">disconnect</a>():void</div><div class="summaryTableDescription">[override] |
| Disconnects the Producer from its remote destination.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/messaging/AbstractProducer.html">AbstractProducer</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/messaging/MessageAgent.html#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"><a href="../../mx/messaging/MessageAgent.html">MessageAgent</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/messaging/MessageAgent.html#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"><a href="../../mx/messaging/MessageAgent.html">MessageAgent</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/messaging/MessageAgent.html#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"><a href="../../mx/messaging/MessageAgent.html">MessageAgent</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/messaging/MessageAgent.html#logout()" class="signatureLink">logout</a>():void</div><div class="summaryTableDescription"> |
| Logs the MessageAgent out from its remote destination.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/messaging/MessageAgent.html">MessageAgent</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#removeSubtopic()" class="signatureLink">removeSubtopic</a>(subtopic:String):void</div><div class="summaryTableDescription"> |
| Removes the subtopic from the subtopics property.</div></td><td class="summaryTableOwnerCol">MultiTopicProducer</td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/messaging/AbstractProducer.html#send()" class="signatureLink">send</a>(message:<a href="../../mx/messaging/messages/IMessage.html">IMessage</a>):void</div><div class="summaryTableDescription"> |
| Sends the specified message to its destination.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/messaging/AbstractProducer.html">AbstractProducer</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/messaging/MessageAgent.html#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"><a href="../../mx/messaging/MessageAgent.html">MessageAgent</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/messaging/MessageAgent.html#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"><a href="../../mx/messaging/MessageAgent.html">MessageAgent</a></td></tr></table></div><a name="protectedMethodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Protected Methods </div><div class="showHideLinks"><div id="hideInheritedProtectedMethod" class="hideInheritedProtectedMethod"><a class="showHideLink" href="#protectedMethodSummary" onclick="javascript:setInheritedVisible(false,'ProtectedMethod');"><img class="showHideLinkImage" src="../../images/expanded.gif"> Show Inherited Protected Methods</a></div><div id="showInheritedProtectedMethod" class="showInheritedProtectedMethod"><a class="showHideLink" href="#protectedMethodSummary" onclick="javascript:setInheritedVisible(true,'ProtectedMethod');"><img class="showHideLinkImage" src="../../images/collapsed.gif"> Show Inherited Protected Methods</a></div></div><table cellspacing="0" cellpadding="3" class="summaryTable hideInheritedProtectedMethod" id="summaryTableProtectedMethod"><tr><th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class="hideInheritedProtectedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/messaging/MessageAgent.html#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"><a href="../../mx/messaging/MessageAgent.html">MessageAgent</a></td></tr><tr class="hideInheritedProtectedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/messaging/MessageAgent.html#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"><a href="../../mx/messaging/MessageAgent.html">MessageAgent</a></td></tr><tr class="hideInheritedProtectedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/messaging/MessageAgent.html#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"><a href="../../mx/messaging/MessageAgent.html">MessageAgent</a></td></tr><tr class="hideInheritedProtectedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/messaging/MessageAgent.html#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"><a href="../../mx/messaging/MessageAgent.html">MessageAgent</a></td></tr></table></div><a name="eventSummary"></a><div class="summarySection"><div class="summaryTableTitle">Events</div><div class="showHideLinks"><div id="hideInheritedEvent" class="hideInheritedEvent"><a class="showHideLink" href="#eventSummary" onclick="javascript:setInheritedVisible(false,'Event');"><img class="showHideLinkImage" src="../../images/expanded.gif"> Hide Inherited Events</a></div><div id="showInheritedEvent" class="showInheritedEvent"><a class="showHideLink" href="#eventSummary" onclick="javascript:setInheritedVisible(true,'Event');"><img class="showHideLinkImage" src="../../images/collapsed.gif"> Show Inherited Events</a></div></div><table cellspacing="0" cellpadding="3" class="summaryTable hideInheritedEvent" id="summaryTableEvent"><tr><th> </th><th colspan="2">Event</th><th> Summary </th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class="hideInheritedEvent"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/messaging/MessageAgent.html#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"><a href="../../mx/messaging/MessageAgent.html">MessageAgent</a></td></tr><tr class="hideInheritedEvent"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/messaging/MessageAgent.html#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"><a href="../../mx/messaging/MessageAgent.html">MessageAgent</a></td></tr><tr class="hideInheritedEvent"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/messaging/MessageAgent.html#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"><a href="../../mx/messaging/MessageAgent.html">MessageAgent</a></td></tr><tr class="hideInheritedEvent"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/messaging/MessageAgent.html#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"><a href="../../mx/messaging/MessageAgent.html">MessageAgent</a></td></tr><tr class="hideInheritedEvent"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/messaging/MessageAgent.html#event:fault" class="signatureLink">fault</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when a message fault occurs.</td><td class="summaryTableOwnerCol"><a href="../../mx/messaging/MessageAgent.html">MessageAgent</a></td></tr><tr class="hideInheritedEvent"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/messaging/MessageAgent.html#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"><a href="../../mx/messaging/MessageAgent.html">MessageAgent</a></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="subtopics"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">subtopics</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>subtopics:<a href="../../mx/collections/ArrayCollection.html">ArrayCollection</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> |
| Provides access to the list of subtopics used in publishing any messages |
| |
| </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 subtopics():<a href="../../mx/collections/ArrayCollection.html">ArrayCollection</a></code><br/><code> public function set subtopics(value:<a href="../../mx/collections/ArrayCollection.html">ArrayCollection</a>):void</code><br/></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="MultiTopicProducer()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">MultiTopicProducer</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function MultiTopicProducer()</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> |
| Constructor. |
| |
| </p><br/><span class="label"> Example </span><br/><div class="detailBody"> <div class="listing" version="3.0"><pre> |
| function sendMessage():void |
| { |
| var producer:MultiTopicProducer = new MultiTopicProducer(); |
| producer.destination = "NASDAQ"; |
| var msg:AsyncMessage = new AsyncMessage(); |
| msg.headers.operation = "UPDATE"; |
| msg.body = {"SYMBOL":50.00}; |
| // only send to subscribers to subtopic "SYMBOL" and "ALLSTOCKS" |
| msg.addSubtopic("SYMBOL"); |
| msg.addSubtopic("ALLSTOCKS"); |
| producer.send(msg); |
| } |
| </pre></div> |
| |
| </div></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="addSubtopic()"></a><a name="addSubtopic(String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">addSubtopic</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function addSubtopic(subtopic:String):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 subtopic to the current list of subtopics for messages sent by this |
| producer. This is a shortcut to adding this subtopic to the subtopics |
| property. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">subtopic</span>:String</code> — The subtopic to add to the current list of |
| subtopics sent by this producer. |
| |
| </td></tr></table></p></div><a name="removeSubtopic()"></a><a name="removeSubtopic(String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">removeSubtopic</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function removeSubtopic(subtopic:String):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 the subtopic from the subtopics property. Throws an error if the |
| subtopic is not in the list. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">subtopic</span>:String</code> — The subtopic to remove from the subtopics property. |
| |
| </td></tr></table></p></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 --> |
