| Paquete | mx.messaging |
| Clase | public class AbstractConsumer |
| Herencia | AbstractConsumer  MessageAgent EventDispatcher Object |
| Subclases | Consumer, MultiTopicConsumer |
| Versión del lenguaje: | ActionScript 3.0 |
| Versiones de producto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Ocultar propiedades públicas heredadas
Mostrar propiedades públicas heredadas| Propiedad | Definido por | ||
|---|---|---|---|
 | authenticated : Boolean [solo lectura]
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 [solo lectura]
Provides access to the client id for the MessageAgent. | MessageAgent | |
| connected : Boolean [solo lectura]
Indicates whether this MessageAgent is currently connected to its
destination via its ChannelSet. | MessageAgent | |
| constructor : Object
Una referencia a la clase de objeto o función constructora para una instancia de objeto determinada. | 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 [solo lectura]
Indicates whether the Consumer is currently subscribed. | AbstractConsumer | ||
| timestamp : Number
Contains the timestamp of the most recent message this Consumer
has received. | AbstractConsumer | ||
| Propiedad | 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 un objeto de detector de eventos con un objeto EventDispatcher, de modo que el detector reciba la notificación de un evento. | EventDispatcher | |
|
Handles a CONNECT ChannelEvent. | MessageAgent | |
|
Handles a DISCONNECT ChannelEvent. | MessageAgent | |
|
Handles a ChannelFaultEvent. | MessageAgent | |
[override]
Disconnects the Consumer from its remote destination. | AbstractConsumer | ||
|
Distribuye un evento en el flujo del evento. | EventDispatcher | |
|
Invoked by a MessageResponder upon receiving a fault for a sent message. | MessageAgent | |
|
Comprueba si el objeto EventDispatcher tiene detectores registrados para un tipo concreto de evento. | EventDispatcher | |
|
Indica si un objeto tiene definida una propiedad especificada. | 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 si hay una instancia de la clase Object en la cadena de prototipo del objeto especificado como parámetro. | Object | |
|
Logs the MessageAgent out from its remote destination. | MessageAgent | |
|
Indica si existe la propiedad especificada y si es enumerable. | Object | |
Requests any messages that are queued for this Consumer on the server. | AbstractConsumer | ||
|
Elimina un detector del objeto EventDispatcher. | EventDispatcher | |
|
Sets the credentials that the MessageAgent uses to authenticate to
destinations. | MessageAgent | |
|
Establece la disponibilidad de una propiedad dinámica para operaciones de bucle. | 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 | ||
|
Devuelve la representación de cadena de este objeto, con formato según las convenciones específicas de configuración regional. | Object | |
|
Devuelve la representación de cadena del objeto especificado. | Object | |
Unsubscribes from the remote destination. | AbstractConsumer | ||
|
Devuelve el valor simple del objeto especificado. | Object | |
|
Comprueba si hay registrado un detector de eventos con este objeto EventDispatcher o con cualquiera de sus ascendientes para el tipo de evento concreto. | 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 | Resumen | Definido por | ||
|---|---|---|---|---|
| Dispatched when an acknowledge message is received for a sent message. | MessageAgent | ||
| [evento broadcast] Se distribuye cuando Flash Player o AIR pasan a estar activos. | 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 | ||
| [evento broadcast] Se distribuye cuando Flash Player o de AIR pasan a estar inactivos. | 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 | propiedad |
protected var _shouldBeSubscribed:Boolean| Versión del lenguaje: | ActionScript 3.0 |
| Versiones de producto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Flag indicating whether this consumer should be subscribed or not.
maxFrequency | propiedad |
maxFrequency:uint| Versión del lenguaje: | ActionScript 3.0 |
| Versiones de producto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Versiones de motor de ejecución: | 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.
Esta propiedad se puede utilizar como origen para la vinculación de datos. Cuando se modifica esta propiedad, distribuye el evento propertyChange .
Implementación
public function get maxFrequency():uint public function set maxFrequency(value:uint):voidresubscribeAttempts | propiedad |
resubscribeAttempts:int| Versión del lenguaje: | ActionScript 3.0 |
| Versiones de producto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Versiones de motor de ejecución: | 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.
Esta propiedad se puede utilizar como origen para la vinculación de datos. Cuando se modifica esta propiedad, distribuye el evento propertyChange .
Implementación
public function get resubscribeAttempts():int public function set resubscribeAttempts(value:int):voidElementos de API relacionados
resubscribeInterval | propiedad |
resubscribeInterval:int| Versión del lenguaje: | ActionScript 3.0 |
| Versiones de producto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Versiones de motor de ejecución: | 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.
Esta propiedad se puede utilizar como origen para la vinculación de datos. Cuando se modifica esta propiedad, distribuye el evento propertyChange .
Implementación
public function get resubscribeInterval():int public function set resubscribeInterval(value:int):voidEmite
ArgumentError — If the assigned value is negative.
|
Elementos de API relacionados
subscribed | propiedad |
subscribed:Boolean [solo lectura] | Versión del lenguaje: | ActionScript 3.0 |
| Versiones de producto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Indicates whether the Consumer is currently subscribed. The propertyChange
event is dispatched when this property changes.
Esta propiedad se puede utilizar como origen para la vinculación de datos. Cuando se modifica esta propiedad, distribuye el evento propertyChange .
Implementación
public function get subscribed():Booleantimestamp | propiedad |
timestamp:Number| Versión del lenguaje: | ActionScript 3.0 |
| Versiones de producto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Versiones de motor de ejecución: | 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.
Esta propiedad se puede utilizar como origen para la vinculación de datos. Cuando se modifica esta propiedad, distribuye el evento propertyChange .
Implementación
public function get timestamp():Number public function set timestamp(value:Number):voidAbstractConsumer | () | Información sobre |
public function AbstractConsumer()| Versión del lenguaje: | ActionScript 3.0 |
| Versiones de producto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Constructs a Consumer.
Ejemplo ( Cómo utilizar este ejemplo )
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| Versión del lenguaje: | ActionScript 3.0 |
| Versiones de producto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Returns a subscribe message. This method should be overridden by subclasses if they need custom subscribe messages.
Valor devueltoCommandMessage — The subscribe CommandMessage.
|
buildUnsubscribeMessage | () | método |
protected function buildUnsubscribeMessage(preserveDurable:Boolean):CommandMessage| Versión del lenguaje: | ActionScript 3.0 |
| Versiones de producto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Versiones de motor de ejecución: | 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| Versión del lenguaje: | ActionScript 3.0 |
| Versiones de producto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Versiones de motor de ejecución: | 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| Versión del lenguaje: | ActionScript 3.0 |
| Versiones de producto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Versiones de motor de ejecución: | 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| Versión del lenguaje: | ActionScript 3.0 |
| Versiones de producto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Subscribes to the remote destination.
Parámetros
clientId:String (default = null) |
Emite
InvalidDestinationError — If no destination is set.
|
unsubscribe | () | método |
public function unsubscribe(preserveDurable:Boolean = false):void| Versión del lenguaje: | ActionScript 3.0 |
| Versiones de producto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Versiones de motor de ejecución: | 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.MessageEventpropiedad MessageEvent.type =
mx.messaging.events.MessageEvent.MESSAGE| Versión del lenguaje: | ActionScript 3.0 |
| Versiones de producto: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Versiones de motor de ejecución: | 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. |
Tue Jun 12 2018, 02:12 PM Z