AbstractConsumer

Pacchetto	mx.messaging
Classe	public class AbstractConsumer
Ereditarietà	AbstractConsumer MessageAgent EventDispatcher Object
Sottoclassi	Consumer, MultiTopicConsumer

Versione linguaggio:

ActionScript 3.0

Versioni prodotto:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3

Versioni 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.

Proprietà pubbliche

Nascondi proprietà pubbliche ereditate

Mostra proprietà pubbliche ereditate

	Proprietà		Definito da
		authenticated : Boolean [sola lettura] 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 [sola lettura] Provides access to the client id for the MessageAgent.	MessageAgent
		connected : Boolean [sola lettura] Indicates whether this MessageAgent is currently connected to its destination via its ChannelSet.	MessageAgent
		constructor : Object Un riferimento all'oggetto classe o alla funzione di costruzione per una determinata istanza di oggetto.	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 [sola lettura] Indicates whether the Consumer is currently subscribed.	AbstractConsumer
		timestamp : Number Contains the timestamp of the most recent message this Consumer has received.	AbstractConsumer

Proprietà protette

	Proprietà		Definito da
		_shouldBeSubscribed : Boolean Flag indicating whether this consumer should be subscribed or not.	AbstractConsumer

Metodi pubblici

Nascondi metodi pubblici ereditati

Mostra metodi pubblici ereditati

	Metodo		Definito da
		AbstractConsumer() Constructs a Consumer.	AbstractConsumer
		acknowledge(ackMsg:AcknowledgeMessage, msg:IMessage):void 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 oggetto listener di eventi con un oggetto EventDispatcher, in modo che il listener riceva la notifica di un evento.	EventDispatcher
		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
		dispatchEvent(event:Event):Boolean Invia un evento nel flusso di eventi.	EventDispatcher
		fault(errMsg:ErrorMessage, msg:IMessage):void Invoked by a MessageResponder upon receiving a fault for a sent message.	MessageAgent
		hasEventListener(type:String):Boolean Verifica se per l'oggetto EventDispatcher sono presenti listener registrati per un tipo specifico di evento.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indica se per un oggetto è definita una proprietà specifica.	Object
		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
		isPrototypeOf(theClass:Object):Boolean Indica se un'istanza della classe Object si trova nella catena di prototipi dell'oggetto specificato come parametro.	Object
		logout():void Logs the MessageAgent out from its remote destination.	MessageAgent
		propertyIsEnumerable(name:String):Boolean Indica se la proprietà specificata esiste ed è enumerabile.	Object
		receive(timestamp:Number = 0):void Requests any messages that are queued for this Consumer on the server.	AbstractConsumer
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Rimuove un listener dall'oggetto EventDispatcher.	EventDispatcher
		setCredentials(username:String, password:String, charset:String = null):void Sets the credentials that the MessageAgent uses to authenticate to destinations.	MessageAgent
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Imposta la disponibilità di una proprietà dinamica per le operazioni cicliche.	Object
		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
		toLocaleString():String Restituisce la rappresentazione in formato stringa di questo oggetto, formattato in base alle convenzioni specifiche per le versioni localizzate.	Object
		toString():String Restituisce la rappresentazione in formato stringa dell'oggetto specificato.	Object
		unsubscribe(preserveDurable:Boolean = false):void Unsubscribes from the remote destination.	AbstractConsumer
		valueOf():Object Restituisce il valore di base dell'oggetto specificato.	Object
		willTrigger(type:String):Boolean Verifica se un listener di eventi è registrato con questo oggetto EventDispatcher o qualsiasi suo antenato per il tipo di evento specificato.	EventDispatcher

Metodi protetti

Nascondi metodi protetti ereditati

Mostra metodi protetti ereditati

	Metodo		Definito da
		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

Eventi

Fate clic per visualizzare altre informazioni sugli eventi

Nascondi eventi ereditati

Mostra eventi ereditati

	Riepilogo	Definito da
acknowledge	Dispatched when an acknowledge message is received for a sent message.	MessageAgent
activate	[evento di trasmissione] Inviato quando Flash Player o l'applicazione AIR ottiene lo stato di attivazione del sistema operativo ed entra nello stato attivo.	EventDispatcher
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
deactivate	[evento di trasmissione] Inviato quando Flash Player o l'applicazione AIR perde l'attivazione del sistema operativo e sta entrando nello stato inattivo.	EventDispatcher
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

Descrizione delle proprietà

_shouldBeSubscribed

proprietà

protected var _shouldBeSubscribed:Boolean

Versione linguaggio:

ActionScript 3.0

Versioni prodotto:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3

Versioni runtime:

Flash Player 9, AIR 1.1

Flag indicating whether this consumer should be subscribed or not.

maxFrequency

proprietà

maxFrequency:uint

Versione linguaggio:

ActionScript 3.0

Versioni prodotto:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3

Versioni 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.

Questa proprietà può essere utilizzata come origine per l’associazione di dati. Quando questa proprietà viene modificata, invia l’evento propertyChange .

Implementazione
public function get maxFrequency():uint
public function set maxFrequency(value:uint):void

resubscribeAttempts

proprietà

resubscribeAttempts:int

Versione linguaggio:

ActionScript 3.0

Versioni prodotto:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3

Versioni 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.

Questa proprietà può essere utilizzata come origine per l’associazione di dati. Quando questa proprietà viene modificata, invia l’evento propertyChange .

Implementazione
public function get resubscribeAttempts():int
public function set resubscribeAttempts(value:int):void

Elementi API correlati

mx.messaging.Consumer.resubscribeInterval

resubscribeInterval

proprietà

resubscribeInterval:int

Versione linguaggio:

ActionScript 3.0

Versioni prodotto:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3

Versioni 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.

Questa proprietà può essere utilizzata come origine per l’associazione di dati. Quando questa proprietà viene modificata, invia l’evento propertyChange .

Implementazione
public function get resubscribeInterval():int
public function set resubscribeInterval(value:int):void

Genera

ArgumentError — If the assigned value is negative.

Elementi API correlati

mx.messaging.Consumer.resubscribeInterval

subscribed

proprietà

subscribed:Boolean [sola lettura]

Versione linguaggio:

ActionScript 3.0

Versioni prodotto:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3

Versioni runtime:

Flash Player 9, AIR 1.1

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

Questa proprietà può essere utilizzata come origine per l’associazione di dati. Quando questa proprietà viene modificata, invia l’evento propertyChange .

Implementazione
public function get subscribed():Boolean

timestamp

proprietà

timestamp:Number

Versione linguaggio:

ActionScript 3.0

Versioni prodotto:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3

Versioni 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.

Questa proprietà può essere utilizzata come origine per l’associazione di dati. Quando questa proprietà viene modificata, invia l’evento propertyChange .

Implementazione
public function get timestamp():Number
public function set timestamp(value:Number):void

Descrizione della funzione di costruzione

()

Funzione di costruzione

public function AbstractConsumer()

Versione linguaggio:

ActionScript 3.0

Versioni prodotto:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3

Versioni runtime:

Flash Player 9, AIR 1.1

Constructs a Consumer.

Esempio ( Come utilizzare questo esempio )

       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());
       }

Descrizione dei metodi

buildSubscribeMessage

()

metodo

protected function buildSubscribeMessage():CommandMessage

Versione linguaggio:

ActionScript 3.0

Versioni prodotto:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3

Versioni runtime:

Flash Player 9, AIR 1.1

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

Restituisce

CommandMessage — The subscribe CommandMessage.

buildUnsubscribeMessage

()

metodo

protected function buildUnsubscribeMessage(preserveDurable:Boolean):CommandMessage

Versione linguaggio:

ActionScript 3.0

Versioni prodotto:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3

Versioni runtime:

Flash Player 9, AIR 1.1

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

Parametri

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

Restituisce

CommandMessage — The unsubscribe CommandMessage.

disconnect

()

metodo

override public function disconnect():void

Versione linguaggio:

ActionScript 3.0

Versioni prodotto:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3

Versioni 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

()

metodo

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

Versione linguaggio:

ActionScript 3.0

Versioni prodotto:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3

Versioni 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.

Parametri

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

()

metodo

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

Versione linguaggio:

ActionScript 3.0

Versioni prodotto:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3

Versioni runtime:

Flash Player 9, AIR 1.1

Subscribes to the remote destination.

Parametri

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.

Genera

InvalidDestinationError — If no destination is set.

unsubscribe

()

metodo

public function unsubscribe(preserveDurable:Boolean = false):void

Versione linguaggio:

ActionScript 3.0

Versioni prodotto:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3

Versioni 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.

Parametri

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

Descrizione degli eventi

message

Evento

Tipo di oggetto evento: mx.messaging.events.MessageEvent
proprietà MessageEvent.type = mx.messaging.events.MessageEvent.MESSAGE

Versione linguaggio:

ActionScript 3.0

Versioni prodotto:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services per Java EE 3

Versioni 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.

Note legali | Informativa sulla privacy online

AbstractConsumer - AS3 BlazeDS LCDS

Classi x

_shouldBeSubscribed

maxFrequency

resubscribeAttempts

resubscribeInterval

subscribed

timestamp