mx.messaging.Consumer (Flex 2)

	Property	Defined by
		channelSet : ChannelSet Provides access to the ChannelSet used by the MessageAgent.	MessageAgent
		clientId : String Provides access to the client id for the MessageAgent.	MessageAgent
		connected : Boolean 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
		destination : String Provides access to the destination for the MessageAgent.	MessageAgent
		messageType : String [read-only] The server alias for the type of message the Consumer can process.	Consumer
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		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 connection to its destination fails.	Consumer
		resubscribeInterval : int The number of milliseconds between resubscribe attempts.	Consumer
		selector : String The selector for the Consumer.	Consumer
		subscribed : Boolean [read-only] Indicates whether the Consumer is currently subscribed.	Consumer
		subtopic : String [write-only] Setting the subtopic when the Consumer is connected and subscribed has the side effect of unsubscribing and resubscribing the Consumer.	Consumer
		timestamp : Number Contains the timestamp of the most recent message this Consumer has received.	Consumer

Public Methods

	Method		Defined by
		Consumer(messageType:String = "flex.messaging.messages.AsyncMessage") Constructs a Consumer.	Consumer
		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
		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 Disconnects the Consumer from its remote destination.	Consumer
		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
		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
		receive(timestamp:Number = 0):void Requests any messages that are pending from the server from the specified timestamp to the present.	Consumer
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setCredentials(username:String, password:String):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):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.	Consumer
		toString():String Returns the string representation of the specified object.	Object
		unsubscribe():void Unsubscribes from the remote destination.	Consumer
		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
		getSubscribeMessage():CommandMessage Returns a subscribe message.	Consumer
		getUnsubscribeMessage():CommandMessage Returns an unsubscribe message.	Consumer
		initChannelSet(message:IMessage):void Consumer overrides this method and initializes its ChannelSet based upon the value of `messageType`.	Consumer
		internalSend(message:IMessage):void Sends a Message from the MessageAgent to its destination using the agent's ChannelSet.	MessageAgent

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
message	Dispatched when a message is received by the Consumer.	Consumer
propertyChange	Dispatched when the `connected` property of the MessageAgent changes.	MessageAgent

Property detail

messageType

property

messageType:String [read-only]

The server alias for the type of message the Consumer can process.

Implementation
public function get messageType():String

resubscribeAttempts

property

resubscribeAttempts:int [read-write]

The number of resubscribe attempts that the Consumer makes in the event that the connection to its destination fails. A value of -1 enables infinite attempts.

Implementation
public function get resubscribeAttempts():int
public function set resubscribeAttempts(value:int):void

resubscribeInterval

property

resubscribeInterval:int [read-write]

The number of milliseconds between resubscribe attempts. If a Consumer doesn't receive an acknowledgement for a subscription request, it will wait the specified number of milliseconds before attempting to resubscribe. Setting the value to zero disables resubscriptions.

Implementation
public function get resubscribeInterval():int
public function set resubscribeInterval(value:int):void

Throws

ArgumentError — If the assigned value is negative.

selector

property

selector:String [read-write]

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.

Implementation
public function get selector():String
public function set selector(value:String):void

subscribed

property

subscribed:Boolean [read-only]

Indicates whether the Consumer is currently subscribed. The propertyChange event is dispatched when this property changes.

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

Implementation
public function get subscribed():Boolean

subtopic

property

subtopic:String [write-only]

Setting the subtopic when the Consumer is connected and subscribed has the side effect of unsubscribing and resubscribing the Consumer.

Implementation
public function set subtopic(value:String):void

timestamp

property

timestamp:Number [read-write]

Contains the timestamp of the most recent message this Consumer has received. This value is passed to the destination in a receive() call to request that it deliver messages for the Consumer from the timestamp forward. All messages with a timestamp value greater than the timestamp value will be returned during a poll operation. Setting this value to -1 will retrieve all cached messages from the destination.

Implementation
public function get timestamp():Number
public function set timestamp(value:Number):void

Constructor detail

Consumer

()

constructor

public function Consumer(messageType:String = "flex.messaging.messages.AsyncMessage")

Constructs a Consumer.

Parameters

messageType:String (default = "flex.messaging.messages.AsyncMessage") — The alias for the message type processed by the service hosting the remote destination the Consumer will subscribe to.

Example

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

Method detail

disconnect

()

method

public override function disconnect():void

Disconnects the Consumer from its remote destination. This method should be invoked on a Consumer that is no longer needed by an application after unsubscribing. This method does not wait for outstanding network operations to complete and does not send an unsubscribe message to the server. After invoking disconnect(), the Consumer will report that it is in an disconnected, unsubscribed state because it will not receive any more messages until it has reconnected and resubscribed.

getSubscribeMessage

()

method

protected function getSubscribeMessage():CommandMessage

Returns a subscribe message. This method should be overridden by subclasses if they need custom subscribe messages.

Returns

CommandMessage — The subscribe CommandMessage.

getUnsubscribeMessage

()

method

protected function getUnsubscribeMessage():CommandMessage

Returns an unsubscribe message. This method should be overridden by subclasses if they need custom unsubscribe messages.

Returns

CommandMessage — The unsubscribe CommandMessage.

initChannelSet

()

method

protected override function initChannelSet(message:IMessage):void

Consumer overrides this method and initializes its ChannelSet based upon the value of messageType.

Parameters

message:IMessage — The message that needs to be sent.

receive

()

method

public function receive(timestamp:Number = 0):void

Requests any messages that are pending from the server from the specified timestamp to the present.

Parameters

timestamp:Number (default = 0) — The timestamp to request messages from.

()

method

public function subscribe(clientId:String = null):void

Subscribes to the remote destination.

Parameters

clientId:String (default = null) — The client id to subscribe with. Use null for non-durable Consumers. If the subscription is durable, a consistent value must be supplied every time the Consumer subscribes in order to reconnect to the correct durable subscription in the remote destination.

Throws

InvalidDestinationError — If no destination is set.

unsubscribe

()

method

public function unsubscribe():void

Unsubscribes from the remote destination. In the case of durable JMS subscriptions, this will destroy the durable subscription on the JMS server.

Event detail

message

event

Event object type: mx.messaging.events.MessageEvent
MessageEvent.type property = mx.messaging.events.MessageEvent.MESSAGE

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.

Current page: http://livedocs.adobe.com/flex/2/langref/mx/messaging/Consumer.html

Adobe^® Flex™ 2 Language Reference		All Packages \| All Classes \| Language Elements \| Index \| Appendixes \| Conventions \| Frames No Frames
Class Consumer	Properties \| Methods \| Events

Package	mx.messaging
Class	public class Consumer
Inheritance	Consumer MessageAgent EventDispatcher Object