Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
AbstractConsumer

Package | mx.messaging
Class | public class AbstractConsumer
Inheritance | AbstractConsumer MessageAgent flash.events.EventDispatcher
Subclasses | Consumer, MultiTopicConsumer

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

The AbstractConsumer is the base class for both the Consumer and MultiTopicConsumer classes. You use those classes to receive pushed messages from the server.

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
|  | 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
|  | subscribed : Boolean [read-only] Indicates whether the Consumer is currently subscribed. | AbstractConsumer
|  | timestamp : Number Contains the timestamp of the most recent message this Consumer has received. | AbstractConsumer

Protected Properties

| Property | Defined By
--- | --- | ---
|  | _shouldBeSubscribed : Boolean Flag indicating whether this consumer should be subscribed or not. | AbstractConsumer

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | AbstractConsumer() Constructs a Consumer. | AbstractConsumer
|  | acknowledge(ackMsg:AcknowledgeMessage, msg:IMessage):void 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
|  | fault(errMsg:ErrorMessage, msg:IMessage):void 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

Protected Methods
Show Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | buildSubscribeMessage():CommandMessage Returns a subscribe message. | AbstractConsumer
|  | buildUnsubscribeMessage(preserveDurable:Boolean):CommandMessage Returns an unsubscribe message. | AbstractConsumer
|  | handleAuthenticationFault(errMsg:ErrorMessage, msg:IMessage):void Handles the authentication fault on the server. | 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 Sends a Message from the MessageAgent to its destination using the agent's ChannelSet. | MessageAgent
|  | reAuthorize(msg:IMessage):void This function should be overriden by sublasses to implement reauthentication due to server session time-out behavior specific to them. | MessageAgent

Events
Hide Inherited Events
Show Inherited Events

| Event | 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. | AbstractConsumer
|  | propertyChange | Dispatched when the connected property of the MessageAgent changes. | MessageAgent

Property Detail

_shouldBeSubscribed | property

`protected var _shouldBeSubscribed:Boolean`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

Flag indicating whether this consumer should be subscribed or not.

maxFrequency | property |

`maxFrequency:uint`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

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.

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

Implementation
`public function get maxFrequency():uint`
`public function set maxFrequency(value:uint):void`

resubscribeAttempts | property |

`resubscribeAttempts:int`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

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.

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.

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

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

See also

mx.messaging.Consumer.resubscribeInterval

resubscribeInterval | property |

`resubscribeInterval:int`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

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.

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.

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

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

| `ArgumentError` — If the assigned value is negative.

See also

mx.messaging.Consumer.resubscribeInterval

subscribed | property |

`subscribed:Boolean` [read-only]

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

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`

timestamp | property |

`timestamp:Number`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

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.

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

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

AbstractConsumer | () | Constructor

`public function AbstractConsumer()`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

Constructs a Consumer.

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

buildSubscribeMessage | () | method

`protected function buildSubscribeMessage():CommandMessage`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

Returns

| `CommandMessage` — The subscribe CommandMessage.

buildUnsubscribeMessage | () | method |

`protected function buildUnsubscribeMessage(preserveDurable:Boolean):CommandMessage`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

Parameters

| `preserveDurable:Boolean` — - when true, durable JMS subscriptions are not destroyed allowing consumers to later resubscribe and receive missed messages

Returns

| `CommandMessage` — The unsubscribe CommandMessage.

disconnect | () | method |

`override public function disconnect():void`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

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.

receive | () | method |

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

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

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.

Parameters

| `timestamp:Number` (default = `0`)`` — This argument is deprecated and is ignored.

subscribe | () | method |

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

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

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(preserveDurable:Boolean = false):void`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

Parameters

| `preserveDurable:Boolean` (default = `false`)`` — - when true, durable JMS subscriptions are not destroyed allowing consumers to later resubscribe and receive missed messages

Event Detail

message | Event

Event Object Type: `mx.messaging.events.MessageEvent`
MessageEvent.type property = `mx.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.

Wed Nov 15 2017, 09:50 AM +01:00