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 |
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.
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 |
Method | Defined By | ||
---|---|---|---|
Constructor. | MultiTopicProducer | ||
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 | ||
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 | ||
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 |
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.
public function get subtopics():ArrayCollection
public function set subtopics(value:ArrayCollection):void
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.
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); }
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.
|