Packagemx.messaging
Classpublic class Producer
InheritanceProducer Inheritance AbstractProducer Inheritance MessageAgent Inheritance flash.events.EventDispatcher
Subclasses AsyncRequest

Language Version : ActionScript 3.0
Product Versions : BlazeDS 4, LCDS 3
Runtime Versions : Flash Player 9, AIR 1.1

A Producer sends messages to a destination. Producers dispatch a MessageAckEvent or MessageFaultEvent for each message they send depending upon whether the outbound message was sent and processed successfully or not.

MXML SyntaxexpandedHide MXML Syntax

The <mx:Producer> tag inherits all the tag attributes of its superclass, and adds the following tag attributes:

   <mx:Producer
    Properties
    defaultHeaders="No default."
  />
  


Public Properties
 PropertyDefined By
 Inheritedauthenticated : Boolean
[read-only] Indicates if this MessageAgent is using an authenticated connection to its destination.
MessageAgent
 InheritedautoConnect : Boolean
If true the Producer automatically connects to its destination the first time the send() method is called.
AbstractProducer
 InheritedchannelSet : ChannelSet
Provides access to the ChannelSet used by the MessageAgent.
MessageAgent
 InheritedclientId : String
[read-only] Provides access to the client id for the MessageAgent.
MessageAgent
 Inheritedconnected : Boolean
[read-only] Indicates whether this MessageAgent is currently connected to its destination via its ChannelSet.
MessageAgent
 InheriteddefaultHeaders : Object
The default headers to apply to messages sent by the Producer.
AbstractProducer
 Inheriteddestination : String
Provides access to the destination for the MessageAgent.
MessageAgent
 Inheritedpriority : int
The default message priority for the messages sent by the Producer.
AbstractProducer
 InheritedreconnectAttempts : 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
 InheritedreconnectInterval : int
The number of milliseconds between reconnect attempts.
AbstractProducer
 InheritedrequestTimeout : int
Provides access to the request timeout in seconds for sent messages.
MessageAgent
  subtopic : String
Provides access to the subtopic for the remote destination that the MessageAgent uses.
Producer
Public Methods
 MethodDefined By
  
Constructor.
Producer
 Inherited
Invoked by a MessageResponder upon receiving a result for a sent message.
MessageAgent
 Inherited
Handles a CONNECT ChannelEvent.
MessageAgent
 Inherited
Handles a DISCONNECT ChannelEvent.
MessageAgent
 Inherited
Handles a ChannelFaultEvent.
MessageAgent
 Inherited
connect():void
Connects the Producer to its target destination.
AbstractProducer
 Inherited
disconnect():void
[override] Disconnects the Producer from its remote destination.
AbstractProducer
 Inherited
fault(errMsg:ErrorMessage, msg:IMessage):void
Invoked by a MessageResponder upon receiving a fault for a sent message.
MessageAgent
 Inherited
Returns true if there are any pending requests for the passed in message.
MessageAgent
 Inherited
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
 Inherited
logout():void
Logs the MessageAgent out from its remote destination.
MessageAgent
 Inherited
send(message:IMessage):void
Sends the specified message to its destination.
AbstractProducer
 Inherited
setCredentials(username:String, password:String, charset:String = null):void
Sets the credentials that the MessageAgent uses to authenticate to destinations.
MessageAgent
 Inherited
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
 MethodDefined By
 Inherited
Handles the authentication fault on the server.
MessageAgent
 Inherited
initChannelSet(message:IMessage):void
Used to automatically initialize the channelSet property for the MessageAgent before it connects for the first time.
MessageAgent
 Inherited
internalSend(message:IMessage, waitForClientId:Boolean = true):void
Sends a Message from the MessageAgent to its destination using the agent's ChannelSet.
MessageAgent
 Inherited
This function should be overriden by sublasses to implement reauthentication due to server session time-out behavior specific to them.
MessageAgent
Events
 Event Summary Defined By
 InheritedDispatched when an acknowledge message is received for a sent message.MessageAgent
 InheritedDispatched when the underlying Channel the MessageAgent is using connects.MessageAgent
 InheritedDispatched when the underlying Channel the MessageAgent is using disconnects.MessageAgent
 InheritedDispatched when the underlying Channel the MessageAgent is using faults.MessageAgent
 InheritedDispatched when a message fault occurs.MessageAgent
 InheritedDispatched when the connected property of the MessageAgent changes.MessageAgent
Public Constants
 ConstantDefined By
  DEFAULT_PRIORITY : int = 4
[static] The default message priority.
Producer
Property Detail
subtopicproperty
subtopic:String

Language Version : ActionScript 3.0
Product Versions : BlazeDS 4, LCDS 3
Runtime Versions : Flash Player 9, AIR 1.1

Provides access to the subtopic for the remote destination that the MessageAgent uses.

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


Implementation
    public function get subtopic():String
    public function set subtopic(value:String):void
Constructor Detail
Producer()Constructor
public function Producer()

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:Producer = new Producer();
           producer.destination = "NASDAQ";
           var msg:AsyncMessage = new AsyncMessage();
           msg.headers.operation = "UPDATE";
           msg.body = {"SYMBOL":50.00};
           producer.send(msg);
       }
       
Constant Detail
DEFAULT_PRIORITYConstant
public static const DEFAULT_PRIORITY:int = 4

Language Version : ActionScript 3.0
Product Versions : BlazeDS 4, LCDS 3
Runtime Versions : Flash Player 9, AIR 1.1

The default message priority.