| Pacote | mx.messaging |
| Classe | public class AbstractConsumer |
| Herança | AbstractConsumer  MessageAgent EventDispatcher 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 |
Ocultar propriedades públicas herdadas
Mostrar propriedades públicas herdadas| Propriedade | Definido por | ||
|---|---|---|---|
 | authenticated : Boolean [somente leitura]
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 [somente leitura]
Provides access to the client id for the MessageAgent. | MessageAgent | |
| connected : Boolean [somente leitura]
Indicates whether this MessageAgent is currently connected to its
destination via its ChannelSet. | MessageAgent | |
| constructor : Object
Uma referência ao objeto de classe ou à função de construtor de uma determinada ocorrência de objeto. | Object | |
| 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 [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 | ||
| Propriedade | Definido por | ||
|---|---|---|---|
| _shouldBeSubscribed : Boolean
Flag indicating whether this consumer should be subscribed or not. | AbstractConsumer | ||
| Método | Definido por | ||
|---|---|---|---|
Constructs a Consumer. | AbstractConsumer | ||
|
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
Registra um objeto de ouvinte de evento em um objeto EventDispatcher, de forma que o ouvinte receba a notificação de um evento. | EventDispatcher | |
|
Handles a CONNECT ChannelEvent. | MessageAgent | |
|
Handles a DISCONNECT ChannelEvent. | MessageAgent | |
|
Handles a ChannelFaultEvent. | MessageAgent | |
[substituir]
Disconnects the Consumer from its remote destination. | AbstractConsumer | ||
|
Envia um evento para o fluxo de eventos. | EventDispatcher | |
|
Invoked by a MessageResponder upon receiving a fault for a sent message. | MessageAgent | |
|
Verifica se o objeto EventDispatcher tem ouvintes registrados para um tipo específico de evento. | EventDispatcher | |
|
Indica se um objeto tem uma propriedade especificada definida. | Object | |
|
Returns true if there are any pending requests for the passed in message. | MessageAgent | |
|
Called after the implementing object has been created
and all properties specified on the tag have been assigned. | MessageAgent | |
|
Indica se uma ocorrência da classe Object está na cadeia de protótipos do objeto especificado como o parâmetro. | Object | |
|
Logs the MessageAgent out from its remote destination. | MessageAgent | |
|
Indica se a propriedade especificada existe e é enumerável. | Object | |
Requests any messages that are queued for this Consumer on the server. | AbstractConsumer | ||
|
Remove um ouvinte do objeto EventDispatcher. | EventDispatcher | |
|
Sets the credentials that the MessageAgent uses to authenticate to
destinations. | MessageAgent | |
|
Define a disponibilidade de uma propriedade dinâmica para operações de repetição. | Object | |
|
Sets the remote credentials that will be passed through to the remote destination
for authenticating to secondary systems. | MessageAgent | |
Subscribes to the remote destination. | AbstractConsumer | ||
|
Retorna a representação da string deste objeto, formatado segundo as convenções específicas para a localidade. | Object | |
|
Retorna a representação de string do objeto especificado. | Object | |
Unsubscribes from the remote destination. | AbstractConsumer | ||
|
Retorna o valor primitivo do objeto especificado. | Object | |
|
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étodo | Definido por | ||
|---|---|---|---|
Returns a subscribe message. | AbstractConsumer | ||
Returns an unsubscribe message. | AbstractConsumer | ||
|
Handles the authentication fault on the server. | MessageAgent | |
|
Used to automatically initialize the channelSet property for the
MessageAgent before it connects for the first time. | MessageAgent | |
|
Sends a Message from the MessageAgent to its destination using the
agent's ChannelSet. | MessageAgent | |
|
This function should be overriden by sublasses to implement reauthentication due to
server session time-out behavior specific to them. | MessageAgent | |
| Evento | Resumo | Definido por | ||
|---|---|---|---|---|
| Dispatched when an acknowledge message is received for a sent message. | MessageAgent | ||
| [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 | ||
| 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 | ||
| [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 | ||
| Dispatched when a message fault occurs. | MessageAgent | ||
| Dispatched when a message is received by the Consumer. | AbstractConsumer | |||
| Dispatched when the connected property of the MessageAgent changes. | MessageAgent | ||
_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):voidresubscribeAttempts | 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):voidElementos 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):voidLanç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():Booleantimestamp | 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):voidAbstractConsumer | () | 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());
}
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.
RetornaCommandMessage — 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
|
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) |
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) |
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) |
message | Evento |
mx.messaging.events.MessageEventpropriedade 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:
| 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 Jun 13 2018, 11:10 AM Z