| Package | mx.messaging |
| Class | public class Consumer |
| Inheritance | Consumer  AbstractConsumer MessageAgent flash.events.EventDispatcher |
| Language Version : | ActionScript 3.0 |
| Product Versions : | BlazeDS 4, LCDS 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Hide MXML SyntaxThe <mx:Consumer> tag inherits all the tag attributes of its superclass, and adds the following tag attributes:
Show MXML Syntax
<mx:Consumer
Properties
resubscribeAttempts="5"
resubscribeInterval="5000"
selector="No default."
timestamp="No default."
/>
| Property | Defined By | ||
|---|---|---|---|
 | authenticated : Boolean [read-only]
Indicates if this MessageAgent is using an authenticated connection to
its destination. | MessageAgent | |
| 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 | |
| destination : String
Provides access to the destination for the MessageAgent. | MessageAgent | |
| maxFrequency : uint
Determines the maximum number of messages per second the Consumer wants
to receive. | AbstractConsumer | |
| requestTimeout : int
Provides access to the request timeout in seconds for sent messages. | MessageAgent | |
| resubscribeAttempts : int
The number of resubscribe attempts that the Consumer makes in the event
that the destination is unavailable or the connection to the destination fails. | AbstractConsumer | |
| resubscribeInterval : int
The number of milliseconds between resubscribe attempts. | AbstractConsumer | |
| selector : String
The selector for the Consumer. | Consumer | ||
| subscribed : Boolean [read-only]
Indicates whether the Consumer is currently subscribed. | AbstractConsumer | |
| subtopic : String
Provides access to the subtopic for the remote destination that the MessageAgent uses. | Consumer | ||
| timestamp : Number
Contains the timestamp of the most recent message this Consumer
has received. | AbstractConsumer | |
| Method | Defined By | ||
|---|---|---|---|
Consumer(messageType:String = flex.messaging.messages.AsyncMessage)
Constructor. | Consumer | ||
|
Invoked by a MessageResponder upon receiving a result for a sent
message. | MessageAgent | |
| 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 | |
| disconnect():void [override]
Disconnects the Consumer from its remote destination. | AbstractConsumer | |
|
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 | |
| receive(timestamp:Number = 0):void
Requests any messages that are queued for this Consumer on the server. | AbstractConsumer | |
| 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 | |
| subscribe(clientId:String = null):void
Subscribes to the remote destination. | AbstractConsumer | |
| unsubscribe(preserveDurable:Boolean = false):void
Unsubscribes from the remote destination. | AbstractConsumer | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when an acknowledge message is received for a sent message. | MessageAgent | ||
| Dispatched when the underlying Channel the MessageAgent is using connects. | MessageAgent | ||
| Dispatched when the underlying Channel the MessageAgent is using disconnects. | MessageAgent | ||
| Dispatched when the underlying Channel the MessageAgent is using faults. | MessageAgent | ||
| Dispatched when a message fault occurs. | MessageAgent | ||
| Dispatched when a message is received by the Consumer. | Consumer | |||
| Dispatched when the connected property of the MessageAgent changes. | MessageAgent | ||
| selector | property |
selector:String| Language Version : | ActionScript 3.0 |
| Product Versions : | BlazeDS 4, LCDS 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
The selector for the Consumer. This is an expression that is passed to the destination which uses it to filter the messages delivered to the Consumer.
Before a call to the subscribe() method, this property
can be set with no side effects.
After the Consumer has subscribed to its destination, changing this
value has the side effect of updating the Consumer's subscription to
use the new selector expression immediately.
The remote destination must understand the value of the selector expression.
This property can be used as the source for data binding.
public function get selector():String public function set selector(value:String):void| subtopic | property |
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.
public function get subtopic():String public function set subtopic(value:String):void| Consumer | () | Constructor |
public function Consumer(messageType:String = flex.messaging.messages.AsyncMessage)| Language Version : | ActionScript 3.0 |
| Product Versions : | BlazeDS 4, LCDS 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Constructor.
ParametersmessageType:String (default = flex.messaging.messages.AsyncMessage) |
function initConsumer():void
{
var consumer:Consumer = new Consumer();
consumer.destination = "NASDAQ";
consumer.selector = "operation IN ('Bid','Ask')";
consumer.addEventListener(MessageEvent.MESSAGE, messageHandler);
consumer.subscribe();
}
function messageHandler(event:MessageEvent):void
{
var msg:IMessage = event.message;
var info:Object = msg.body;
trace("-App recieved message: " + msg.toString());
}
| message | Event |
mx.messaging.events.MessageEventmx.messaging.events.MessageEvent.MESSAGE| Language Version : | ActionScript 3.0 |
| Product Versions : | BlazeDS 4, LCDS 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Dispatched when a message is received by the Consumer.
The MESSAGE event type; dispatched upon receipt of a message.The value of this constant is "message".
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
message | The message associated with this event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |