| { "type": "class", | |
| "qname": "mx.messaging.AbstractConsumer", | |
| "baseClassname": "mx.messaging.MessageAgent" | |
| , | |
| "description": "The AbstractConsumer is the base class for both the Consumer and MultiTopicConsumer classes. You use those classes to receive pushed messages from the server.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "members": [ | |
| { "type": "method", | |
| "qname": "mx.messaging.AbstractConsumer", | |
| "namespace": "", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Constructs a Consumer. <listing version="3.0"> 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()); } </listing>", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "example", | |
| "values": []}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "", | |
| "params": []} | |
| , | |
| { "type": "field", | |
| "qname": "_shouldBeSubscribed", | |
| "return": "Boolean", | |
| "namespace": "protected", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Flag indicating whether this consumer should be subscribed or not.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "String", | |
| "qname": "destination", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["override"], | |
| "deprecated": {}, | |
| "description": "Provides access to the destination for the MessageAgent. Changing the destination will disconnect the MessageAgent if it is currently connected. zero-length.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1", "Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3", "BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "throws", | |
| "values": ["mx.messaging.errors.InvalidDestinationError If the destination is null or", "mx.messaging.errors.InvalidDestinationError If the destination is null or"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0", "3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "uint", | |
| "qname": "maxFrequency", | |
| "namespace": "public", | |
| "bindable": ["propertyChange"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Determines the maximum number of messages per second the Consumer wants to receive. A server that understands this value will use it as an input while it determines how fast to send messages to the Consumer. Default is 0 which means Consumer does not have a preference for the message rate. Note that this property should be set before the Consumer subscribes and any changes after Consumer subscription will not have any effect until Consumer unsubscribes and resubscribes.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "int", | |
| "qname": "resubscribeAttempts", | |
| "namespace": "public", | |
| "bindable": ["propertyChange"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "The number of resubscribe attempts that the Consumer makes in the event that the destination is unavailable or the connection to the destination fails. A value of -1 enables infinite attempts. A value of zero disables resubscribe attempts. <p> Resubscribe attempts are made at a constant rate according to the resubscribe interval value. When a resubscribe attempt is made if the underlying channel for the Consumer is not connected or attempting to connect the channel will start a connect attempt. Subsequent Consumer resubscribe attempts that occur while the underlying channel connect attempt is outstanding are effectively ignored until the outstanding channel connect attempt succeeds or fails. </p>", | |
| "tags": [ | |
| { "tagName": "see", | |
| "values": ["mx.messaging.Consumer#resubscribeInterval"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "int", | |
| "qname": "resubscribeInterval", | |
| "namespace": "public", | |
| "bindable": ["propertyChange"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "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. <p> Resubscribe attempts are made at a constant rate according to this value. When a resubscribe attempt is made if the underlying channel for the Consumer is not connected or attempting to connect the channel will start a connect attempt. Subsequent Consumer resubscribe attempts that occur while the underlying channel connect attempt is outstanding are effectively ignored until the outstanding channel connect attempt succeeds or fails. </p>", | |
| "tags": [ | |
| { "tagName": "see", | |
| "values": ["mx.messaging.Consumer#resubscribeInterval"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "throws", | |
| "values": ["ArgumentError If the assigned value is negative."]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-only", | |
| "return": "Boolean", | |
| "qname": "subscribed", | |
| "namespace": "public", | |
| "bindable": ["propertyChange"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Indicates whether the Consumer is currently subscribed. The <code>propertyChange</code> event is dispatched when this property changes.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "Number", | |
| "qname": "timestamp", | |
| "namespace": "public", | |
| "bindable": ["propertyChange"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Contains the timestamp of the most recent message this Consumer has received. This value is passed to the destination in a <code>receive()</code> call to request that it deliver messages for the Consumer from the timestamp forward. All messages with a timestamp value greater than the <code>timestamp</code> value will be returned during a poll operation. Setting this value to -1 will retrieve all cached messages from the destination.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "method", | |
| "qname": "disconnect", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["override"], | |
| "deprecated": {}, | |
| "description": "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. Disconnecting stops automatic resubscription attempts if they are running.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "void", | |
| "params": []} | |
| , | |
| { "type": "method", | |
| "qname": "receive", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Requests any messages that are queued for this Consumer on the server. This method should only be used for Consumers that subscribe over non-realtime, non-polling channels. This method is a no-op if the Consumer is not subscribed.", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["timestamp This argument is deprecated and is ignored."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "void", | |
| "params": [{ "name": "timestamp", "type": "Number"}]} | |
| , | |
| { "type": "method", | |
| "qname": "subscribe", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Subscribes to the remote destination. value must be supplied every time the Consumer subscribes in order to reconnect to the correct durable subscription in the remote destination.", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["clientId The client id to subscribe with. Use null for non-durable Consumers. If the subscription is durable, a consistent"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "throws", | |
| "values": ["mx.messaging.errors.InvalidDestinationError If no destination is set."]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "void", | |
| "params": [{ "name": "clientId", "type": "String"}]} | |
| , | |
| { "type": "method", | |
| "qname": "unsubscribe", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Unsubscribes from the remote destination. In the case of durable JMS subscriptions, this will destroy the durable subscription on the JMS server. allowing consumers to later resubscribe and receive missed messages", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["preserveDurable - when true, durable JMS subscriptions are not destroyed"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "void", | |
| "params": [{ "name": "preserveDurable", "type": "Boolean"}]} | |
| , | |
| { "type": "method", | |
| "qname": "buildSubscribeMessage", | |
| "namespace": "protected", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Returns a subscribe message. This method should be overridden by subclasses if they need custom subscribe messages.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "return", | |
| "values": ["The subscribe CommandMessage."]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "mx.messaging.messages.CommandMessage", | |
| "params": []} | |
| , | |
| { "type": "method", | |
| "qname": "buildUnsubscribeMessage", | |
| "namespace": "protected", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Returns an unsubscribe message. This method should be overridden by subclasses if they need custom unsubscribe messages. allowing consumers to later resubscribe and receive missed messages", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["preserveDurable - when true, durable JMS subscriptions are not destroyed"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "return", | |
| "values": ["The unsubscribe CommandMessage."]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "mx.messaging.messages.CommandMessage", | |
| "params": [{ "name": "preserveDurable", "type": "Boolean"}]} | |
| ] | |
| , | |
| "events": [ | |
| { "qname": "message", | |
| "type": "mx.messaging.events.MessageEvent" | |
| , | |
| "description": "Dispatched when a message is received by the Consumer.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "eventType", | |
| "values": ["mx.messaging.events.MessageEvent.MESSAGE"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}] | |
| } |