mx.messaging.MultiTopicProducer (Flex 3)

Package	mx.messaging
Class	public class MultiTopicProducer
Inheritance	MultiTopicProducer AbstractProducer MessageAgent EventDispatcher Object

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
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		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
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		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

Protected Properties

Hide Inherited Protected Properties

Show Inherited Protected Properties

	Property		Defined By
		_agentType : String The type of MessageAgent.	MessageAgent
		_credentials : String The Base64 encoded credentials that will be passed through to the ChannelSet.	MessageAgent
		_credentialsCharset : String The character set encoding used to create the credentials String.	MessageAgent
		_disconnectBarrier : Boolean Indicates whether the agent is explicitly disconnected.	MessageAgent
		_ignoreFault : Boolean = false Flag being set to true denotes that we should skip remaining fault processing logic because the fault has already been handled.	MessageAgent
		_log : ILogger The logger MUST be assigned by subclasses, for example Consumer and Producer.	MessageAgent

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		MultiTopicProducer() Constructs a Producer.	MultiTopicProducer
		acknowledge(ackMsg:AcknowledgeMessage, msg:IMessage):void Invoked by a MessageResponder upon receiving a result for a sent message.	MessageAgent
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	EventDispatcher
		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 Disconnects the Producer from its remote destination.	AbstractProducer
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		fault(errMsg:ErrorMessage, msg:IMessage):void Invoked by a MessageResponder upon receiving a fault for a sent message.	MessageAgent
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		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
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		logout():void Logs the MessageAgent out from its remote destination.	MessageAgent
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		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
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		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
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

	Method	Defined By
		assertCredentials(value:String):void	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	MultiTopicProducer
		reAuthorize(msg:IMessage):void This function should be overriden by sublasses to implement re-authorization due to server session time-out behavior specific to them.	MessageAgent

Events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
acknowledge	Dispatched when an acknowledge message is received for a sent message.	MessageAgent
activate	Dispatched when Flash Player or an AIR application gains operating system focus and becomes active.	EventDispatcher
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
deactivate	Dispatched when Flash Player or an AIR application loses operating system focus and is becoming inactive.	EventDispatcher
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 [read-write]

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()

Constructs a Producer.

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

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

internalSend

()

method

protected override function internalSend(message:IMessage, waitForClientId:Boolean = true):void

Parameters

	`message:IMessage`

	`waitForClientId:Boolean` (default = `true`)

removeSubtopic

()

method

public function removeSubtopic(subtopic:String):void

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

Parameters

subtopic:String

ActionScript 3.0 Language and Components Reference	All Packages \| All Classes \| Language Elements \| Index \| Appendixes \| Conventions \| Frames No Frames
MultiTopicProducer	Properties \| Methods \| Events