Referência do ActionScript® 3.0 para Adobe® Flash® Platform
Início  |  Ocultar listas de Pacotes e Classes |  Pacotes  |  Classes  |  Novidades  |  Índice  |  Apêndices  |  Por que inglês?
Filtros: Recuperando dados do servidor...
Recuperando dados do servidor...
mx.messaging 

AbstractConsumer  - AS3 BlazeDS LCDS

Pacotemx.messaging
Classepublic class AbstractConsumer
HerançaAbstractConsumer Inheritance MessageAgent Inheritance EventDispatcher Inheritance Object
Subclasses Consumer, MultiTopicConsumer

Versão da linguagem: ActionScript 3.0
Versões de produto: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Versões de runtime: 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.



Propriedades públicas
 PropriedadeDefinido por
 Inheritedauthenticated : Boolean
[somente leitura] Indicates if this MessageAgent is using an authenticated connection to its destination.
MessageAgent
 InheritedchannelSet : ChannelSet
Provides access to the ChannelSet used by the MessageAgent.
MessageAgent
 InheritedclientId : String
[somente leitura] Provides access to the client id for the MessageAgent.
MessageAgent
 Inheritedconnected : Boolean
[somente leitura] Indicates whether this MessageAgent is currently connected to its destination via its ChannelSet.
MessageAgent
 Inheritedconstructor : Object
Uma referência ao objeto de classe ou à função de construtor de uma determinada ocorrência de objeto.
Object
 Inheriteddestination : 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
 InheritedrequestTimeout : 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
[somente leitura] Indicates whether the Consumer is currently subscribed.
AbstractConsumer
  timestamp : Number
Contains the timestamp of the most recent message this Consumer has received.
AbstractConsumer
Propriedades protegidas
 PropriedadeDefinido por
  _shouldBeSubscribed : Boolean
Flag indicating whether this consumer should be subscribed or not.
AbstractConsumer
Métodos públicos
 MétodoDefinido por
  
Constructs a Consumer.
AbstractConsumer
 Inherited
Invoked by a MessageResponder upon receiving a result for a sent message.
MessageAgent
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registra um objeto de ouvinte de evento em um objeto EventDispatcher, de forma que o ouvinte receba a notificação de um evento.
EventDispatcher
 Inherited
Handles a CONNECT ChannelEvent.
MessageAgent
 Inherited
Handles a DISCONNECT ChannelEvent.
MessageAgent
 Inherited
Handles a ChannelFaultEvent.
MessageAgent
  
[substituir] Disconnects the Consumer from its remote destination.
AbstractConsumer
 Inherited
Envia um evento para o fluxo de eventos.
EventDispatcher
 Inherited
Invoked by a MessageResponder upon receiving a fault for a sent message.
MessageAgent
 Inherited
Verifica se o objeto EventDispatcher tem ouvintes registrados para um tipo específico de evento.
EventDispatcher
 Inherited
Indica se um objeto tem uma propriedade especificada definida.
Object
 Inherited
Returns true if there are any pending requests for the passed in message.
MessageAgent
 Inherited
Called after the implementing object has been created and all properties specified on the tag have been assigned.
MessageAgent
 Inherited
Indica se uma ocorrência da classe Object está na cadeia de protótipos do objeto especificado como o parâmetro.
Object
 Inherited
Logs the MessageAgent out from its remote destination.
MessageAgent
 Inherited
Indica se a propriedade especificada existe e é enumerável.
Object
  
receive(timestamp:Number = 0):void
Requests any messages that are queued for this Consumer on the server.
AbstractConsumer
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Remove um ouvinte do objeto EventDispatcher.
EventDispatcher
 Inherited
setCredentials(username:String, password:String, charset:String = null):void
Sets the credentials that the MessageAgent uses to authenticate to destinations.
MessageAgent
 Inherited
Define a disponibilidade de uma propriedade dinâmica para operações de repetição.
Object
 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
  
subscribe(clientId:String = null):void
Subscribes to the remote destination.
AbstractConsumer
 Inherited
Retorna a representação da string deste objeto, formatado segundo as convenções específicas para a localidade.
Object
 Inherited
Retorna a representação de string do objeto especificado.
Object
  
unsubscribe(preserveDurable:Boolean = false):void
Unsubscribes from the remote destination.
AbstractConsumer
 Inherited
Retorna o valor primitivo do objeto especificado.
Object
 Inherited
Verifica se um ouvinte de evento está registrado nesse objeto EventDispatcher ou em qualquer um de seus ancestrais para o tipo de evento especificado.
EventDispatcher
Métodos protegidos
 MétodoDefinido por
  
Returns a subscribe message.
AbstractConsumer
  
Returns an unsubscribe message.
AbstractConsumer
 Inherited
Handles the authentication fault on the server.
MessageAgent
 Inherited
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
Eventos
 Evento Resumo Definido por
 InheritedDispatched when an acknowledge message is received for a sent message.MessageAgent
 Inherited[transmissão de evento] Despachado quando o Flash Player ou o aplicativo do AIR ganha o foco do sistema operacional e está se tornando inativo.EventDispatcher
 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
 Inherited[transmissão de evento] Despachado quando o Flash Player ou o aplicativo do AIR perde o foco do sistema operacional e está se tornando inativo.EventDispatcher
 InheritedDispatched when a message fault occurs.MessageAgent
  Dispatched when a message is received by the Consumer.AbstractConsumer
 InheritedDispatched when the connected property of the MessageAgent changes.MessageAgent
Detalhes da propriedade

_shouldBeSubscribed

propriedade
protected var _shouldBeSubscribed:Boolean

Versão da linguagem: ActionScript 3.0
Versões de produto: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Versões de runtime: Flash Player 9, AIR 1.1

Flag indicating whether this consumer should be subscribed or not.

maxFrequency

propriedade 
maxFrequency:uint

Versão da linguagem: ActionScript 3.0
Versões de produto: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Versões de runtime: 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.

Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento propertyChange .



Implementação
    public function get maxFrequency():uint
    public function set maxFrequency(value:uint):void

resubscribeAttempts

propriedade 
resubscribeAttempts:int

Versão da linguagem: ActionScript 3.0
Versões de produto: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Versões de runtime: 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.

Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento propertyChange .



Implementação
    public function get resubscribeAttempts():int
    public function set resubscribeAttempts(value:int):void

Elementos da API relacionados

resubscribeInterval

propriedade 
resubscribeInterval:int

Versão da linguagem: ActionScript 3.0
Versões de produto: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Versões de runtime: 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.

Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento propertyChange .



Implementação
    public function get resubscribeInterval():int
    public function set resubscribeInterval(value:int):void

Lança
ArgumentError — If the assigned value is negative.

Elementos da API relacionados

subscribed

propriedade 
subscribed:Boolean  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versões de produto: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Versões de runtime: Flash Player 9, AIR 1.1

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

Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento propertyChange .



Implementação
    public function get subscribed():Boolean

timestamp

propriedade 
timestamp:Number

Versão da linguagem: ActionScript 3.0
Versões de produto: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Versões de runtime: 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.

Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento propertyChange .



Implementação
    public function get timestamp():Number
    public function set timestamp(value:Number):void
Detalhes do construtor

AbstractConsumer

()Construtor
public function AbstractConsumer()

Versão da linguagem: ActionScript 3.0
Versões de produto: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Versões de runtime: Flash Player 9, AIR 1.1

Constructs a Consumer.


Exemplo  ( Como usar este exemplo )
       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());
       }
       
Detalhes do método

buildSubscribeMessage

()método
protected function buildSubscribeMessage():CommandMessage

Versão da linguagem: ActionScript 3.0
Versões de produto: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Versões de runtime: Flash Player 9, AIR 1.1

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

Retorna
CommandMessage — The subscribe CommandMessage.

buildUnsubscribeMessage

()método 
protected function buildUnsubscribeMessage(preserveDurable:Boolean):CommandMessage

Versão da linguagem: ActionScript 3.0
Versões de produto: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Versões de runtime: Flash Player 9, AIR 1.1

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

Parâmetros

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

Retorna
CommandMessage — The unsubscribe CommandMessage.

disconnect

()método 
override public function disconnect():void

Versão da linguagem: ActionScript 3.0
Versões de produto: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Versões de runtime: 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

()método 
public function receive(timestamp:Number = 0):void

Versão da linguagem: ActionScript 3.0
Versões de produto: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Versões de runtime: 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.

Parâmetros

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

subscribe

()método 
public function subscribe(clientId:String = null):void

Versão da linguagem: ActionScript 3.0
Versões de produto: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Versões de runtime: Flash Player 9, AIR 1.1

Subscribes to the remote destination.

Parâmetros

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.


Lança
InvalidDestinationError — If no destination is set.

unsubscribe

()método 
public function unsubscribe(preserveDurable:Boolean = false):void

Versão da linguagem: ActionScript 3.0
Versões de produto: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Versões de runtime: 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.

Parâmetros

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

Detalhe do evento

message

Evento
Tipo do objeto de evento: mx.messaging.events.MessageEvent
propriedade MessageEvent.type = mx.messaging.events.MessageEvent.MESSAGE

Versão da linguagem: ActionScript 3.0
Versões de produto: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Versões de runtime: 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:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
messageThe message associated with this event.
targetThe 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.




[ X ]Por que inglês?
O conteúdo na Referência do ActionScript 3.0 aparece em inglês

Nem todas as partes da Referência do ActionScript 3.0 estão traduzidas em todos os idiomas. Quando um elemento de um idioma não está traduzido, ele é exibido em inglês. Por exemplo, a classe ga.controls.HelpBox não está traduzida em nenhum idioma. Por isso, na versão da referência em português do Brasil, a classe ga.controls.HelpBox é exibida em inglês.