Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
MultiTopicProducer

Package | mx.messaging
Class | public class MultiTopicProducer
Inheritance | MultiTopicProducer AbstractProducer MessageAgent flash.events.EventDispatcher

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

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.

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.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | authenticated : Boolean [read-only] Indicates if this MessageAgent is using an authenticated connection to its destination. | MessageAgent
|  | autoConnect : Boolean If true the Producer automatically connects to its destination the first time the send() method is called. | AbstractProducer
|  | channelSet : ChannelSet Provides access to the ChannelSet used by the MessageAgent. | MessageAgent
|  | clientId : String [read-only] Provides access to the client id for the MessageAgent. | MessageAgent
|  | connected : Boolean [read-only] Indicates whether this MessageAgent is currently connected to its destination via its ChannelSet. | MessageAgent
|  | defaultHeaders : Object The default headers to apply to messages sent by the Producer. | AbstractProducer
|  | destination : String Provides access to the destination for the MessageAgent. | MessageAgent
|  | priority : int The default message priority for the messages sent by the Producer. | AbstractProducer
|  | reconnectAttempts : int The number of reconnect attempts that the Producer makes in the event that the destination is unavailable or the connection to the destination closes. | AbstractProducer
|  | reconnectInterval : int The number of milliseconds between reconnect attempts. | AbstractProducer
|  | requestTimeout : int Provides access to the request timeout in seconds for sent messages. | MessageAgent
|  | subtopics : ArrayCollection Provides access to the list of subtopics used in publishing any messages | MultiTopicProducer

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | MultiTopicProducer() Constructor. | MultiTopicProducer
|  | acknowledge(ackMsg:AcknowledgeMessage, msg:IMessage):void Invoked by a MessageResponder upon receiving a result for a sent message. | MessageAgent
|  | addSubtopic(subtopic:String):void Adds a subtopic to the current list of subtopics for messages sent by this producer. | MultiTopicProducer
|  | channelConnectHandler(event:ChannelEvent):void Handles a CONNECT ChannelEvent. | MessageAgent
|  | channelDisconnectHandler(event:ChannelEvent):void Handles a DISCONNECT ChannelEvent. | MessageAgent
|  | channelFaultHandler(event:ChannelFaultEvent):void Handles a ChannelFaultEvent. | MessageAgent
|  | connect():void Connects the Producer to its target destination. | AbstractProducer
|  | disconnect():void [override] Disconnects the Producer from its remote destination. | AbstractProducer
|  | fault(errMsg:ErrorMessage, msg:IMessage):void Invoked by a MessageResponder upon receiving a fault for a sent message. | MessageAgent
|  | hasPendingRequestForMessage(msg:IMessage):Boolean Returns true if there are any pending requests for the passed in message. | MessageAgent
|  | initialized(document:Object, id:String):void Called after the implementing object has been created and all properties specified on the tag have been assigned. | MessageAgent
|  | logout():void Logs the MessageAgent out from its remote destination. | MessageAgent
|  | removeSubtopic(subtopic:String):void Removes the subtopic from the subtopics property. | MultiTopicProducer
|  | send(message:IMessage):void Sends the specified message to its destination. | AbstractProducer
|  | setCredentials(username:String, password:String, charset:String = null):void Sets the credentials that the MessageAgent uses to authenticate to destinations. | MessageAgent
|  | setRemoteCredentials(username:String, password:String, charset:String = null):void Sets the remote credentials that will be passed through to the remote destination for authenticating to secondary systems. | MessageAgent

Protected Methods
Show Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | handleAuthenticationFault(errMsg:ErrorMessage, msg:IMessage):void Handles the authentication fault on the server. | MessageAgent
|  | initChannelSet(message:IMessage):void Used to automatically initialize the channelSet property for the MessageAgent before it connects for the first time. | MessageAgent
|  | internalSend(message:IMessage, waitForClientId:Boolean = true):void Sends a Message from the MessageAgent to its destination using the agent's ChannelSet. | MessageAgent
|  | reAuthorize(msg:IMessage):void This function should be overriden by sublasses to implement reauthentication due to server session time-out behavior specific to them. | MessageAgent

Events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | acknowledge | Dispatched when an acknowledge message is received for a sent message. | MessageAgent
|  | channelConnect | Dispatched when the underlying Channel the MessageAgent is using connects. | MessageAgent
|  | channelDisconnect | Dispatched when the underlying Channel the MessageAgent is using disconnects. | MessageAgent
|  | channelFault | Dispatched when the underlying Channel the MessageAgent is using faults. | MessageAgent
|  | fault | Dispatched when a message fault occurs. | MessageAgent
|  | propertyChange | Dispatched when the connected property of the MessageAgent changes. | MessageAgent

Property Detail

subtopics | property

`subtopics:ArrayCollection`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

Provides access to the list of subtopics used in publishing any messages

This property can be used as the source for data binding.

Implementation
`public function get subtopics():ArrayCollection`
`public function set subtopics(value:ArrayCollection):void`
Constructor Detail

MultiTopicProducer | () | Constructor

`public function MultiTopicProducer()`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

Constructor.

Example

           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);
           }

Method Detail

addSubtopic | () | method

`public function addSubtopic(subtopic:String):void`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

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.

Parameters

| `subtopic:String` — The subtopic to add to the current list of subtopics sent by this producer.

removeSubtopic | () | method |

`public function removeSubtopic(subtopic:String):void`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

Removes the subtopic from the subtopics property. Throws an error if the subtopic is not in the list.

Parameters

| `subtopic:String` — The subtopic to remove from the subtopics property.

Wed Nov 15 2017, 09:50 AM +01:00