Consumer

Package	mx.messaging
Classe	public class Consumer
Héritage	Consumer AbstractConsumer MessageAgent EventDispatcher Object

Version du langage:

ActionScript 3.0

Versions du produit:

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

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Une classe Consumer s’abonne à une destination pour recevoir des messages. Les classes Consumer envoient des messages d’abonnement et de désabonnement qui génèrent une classe MessageAckEvent ou MessageFaultEvent selon que l’opération réussit ou échoue. Une fois abonnée, une classe Consumer distribue un événement MessageEvent pour chaque message qu’elle reçoit. Les classes Consumer offrent la possibilité de filtrer les messages à l’aide d’un sélecteur. Ces sélecteurs doivent être compris par la destination.

Syntaxe MXML expanded

Masquer la syntaxe MXML

The <mx:Consumer> tag inherits all the tag attributes of its superclass, and adds the following tag attributes:

   <mx:Consumer
    Properties
    resubscribeAttempts="5"
    resubscribeInterval="5000"
    selector="No default."
    timestamp="No default."
  />

Propriétés publiques

Masquer les propriétés publiques héritées

Afficher les propriétés publiques héritées

	Propriété		Défini par
		authenticated : Boolean [lecture seule] Indique si cette classe MessageAgent utilise une connexion à sa destination authentifiée.	MessageAgent
		channelSet : ChannelSet Fournit un accès à la classe ChannelSet utilisée par la classe MessageAgent.	MessageAgent
		clientId : String [lecture seule] Fournit un accès à l’ID client pour la classe MessageAgent.	MessageAgent
		connected : Boolean [lecture seule] Indique si cette classe MessageAgent est actuellement connectée à sa destination via sa classe ChannelSet.	MessageAgent
		constructor : Object Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.	Object
		destination : String Fournit un accès à la destination pour la classe MessageAgent.	MessageAgent
		maxFrequency : uint Détermine le nombre maximal de messages par seconde que la classe Consumer souhaite recevoir.	AbstractConsumer
		requestTimeout : int Fournit un accès au délai d’attente de demande en secondes pour les messages envoyés.	MessageAgent
		resubscribeAttempts : int Nombre de tentatives de réabonnement effectuées par la classe Consumer si la destination n’est pas disponible ou si la connexion à la destination est interrompue.	AbstractConsumer
		resubscribeInterval : int Nombre de millisecondes s’écoulant entre les tentatives de réabonnement.	AbstractConsumer
		selector : String Sélecteur de la classe Consumer.	Consumer
		subscribed : Boolean [lecture seule] Indique si la classe Consumer est actuellement abonnée.	AbstractConsumer
		subtopic : String Fournit un accès à la sous-rubrique de la destination que la classe MessageAgent utilise.	Consumer
		timestamp : Number Contient la date et l’heure du message le plus récent que cette classe Consumer a reçu.	AbstractConsumer

Propriétés protégées

Masquer les propriétés protégées héritées

Afficher les propriétés protégées héritées

	Propriété		Défini par
		_shouldBeSubscribed : Boolean Indicateur spécifiant si cette classe Consumer doit être abonnée ou non.	AbstractConsumer

Méthodes publiques

Masquer les méthodes publiques héritées

Afficher les méthodes publiques héritées

	Méthode		Défini par
		Consumer(messageType:String = "flex.messaging.messages.AsyncMessage") Constructeur.	Consumer
		acknowledge(ackMsg:AcknowledgeMessage, msg:IMessage):void Invoqué par une classe MessageResponder à la réception d’un résultat pour un message envoyé.	MessageAgent
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Enregistre un objet écouteur d’événement auprès d’un objet EventDispatcher afin que l’écouteur soit averti d’un événement.	EventDispatcher
		channelConnectHandler(event:ChannelEvent):void Gère un événement ChannelEvent CONNECT.	MessageAgent
		channelDisconnectHandler(event:ChannelEvent):void Gère un événement ChannelEvent DISCONNECT.	MessageAgent
		channelFaultHandler(event:ChannelFaultEvent):void Gère un événement ChannelFaultEvent.	MessageAgent
		disconnect():void [override] Déconnecte la classe Consumer de sa destination distante.	AbstractConsumer
		dispatchEvent(event:Event):Boolean Distribue un événement dans le flux d’événements.	EventDispatcher
		fault(errMsg:ErrorMessage, msg:IMessage):void Invoqué par une classe MessageResponder à la réception d’une erreur pour un message envoyé.	MessageAgent
		hasEventListener(type:String):Boolean Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indique si la propriété spécifiée d’un objet est définie.	Object
		hasPendingRequestForMessage(msg:IMessage):Boolean Renvoie true si des demandes sont en attente pour le message transmis.	MessageAgent
		initialized(document:Object, id:String):void Appelé une fois que l’objet d’implémentation a été créé et que toutes les propriétés spécifiées sur la balise ont été affectées.	MessageAgent
		isPrototypeOf(theClass:Object):Boolean Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l’objet spécifié en tant que paramètre.	Object
		logout():void Déconnecte la classe MessageAgent de sa destination distante.	MessageAgent
		propertyIsEnumerable(name:String):Boolean Indique si la propriété spécifiée existe et est énumérable.	Object
		receive(timestamp:Number = 0):void Demande les messages mis en file d’attente pour cette classe Consumer sur le serveur.	AbstractConsumer
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Supprime un écouteur de l’objet EventDispatcher.	EventDispatcher
		setCredentials(username:String, password:String, charset:String = null):void Définit les informations d’identification que la classe MessageAgent utilise pour s’authentifier auprès des destinations.	MessageAgent
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.	Object
		setRemoteCredentials(username:String, password:String, charset:String = null):void Définit les informations d’identification distantes allant être transmises à la destination distante en vue de l’authentification auprès des systèmes secondaires.	MessageAgent
		subscribe(clientId:String = null):void S’abonne à la destination distante.	AbstractConsumer
		toLocaleString():String Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur.	Object
		toString():String Renvoie la représentation sous forme de chaîne de l’objet spécifié.	Object
		unsubscribe(preserveDurable:Boolean = false):void Se désabonne de la destination distante.	AbstractConsumer
		valueOf():Object Renvoie la valeur primitive de l’objet spécifié.	Object
		willTrigger(type:String):Boolean Vérifie si un écouteur d’événement est enregistré auprès de cet objet EventDispatcher ou de ses ancêtres pour le type d’événement spécifié.	EventDispatcher

Méthodes protégées

Masquer les méthodes protégées héritées

Afficher les méthodes protégées héritées

	Méthode		Défini par
		buildSubscribeMessage():CommandMessage Renvoie un message d’abonnement.	AbstractConsumer
		buildUnsubscribeMessage(preserveDurable:Boolean):CommandMessage Renvoie un message de désabonnement.	AbstractConsumer
		handleAuthenticationFault(errMsg:ErrorMessage, msg:IMessage):void Gère l’erreur d’authentification sur le serveur.	MessageAgent
		initChannelSet(message:IMessage):void Permet d’initialiser automatiquement la propriété channelSet pour la classe MessageAgent avant qu’elle ne se connecte pour la première fois.	MessageAgent
		internalSend(message:IMessage, waitForClientId:Boolean = true):void Envoie un message de la classe MessageAgent vers sa destination à l’aide de la classe ChannelSet de l’agent.	MessageAgent
		reAuthorize(msg:IMessage):void Cette fonction doit être remplacée par les sous-classes pour mettre en oeuvre la réauthentification résultant d’un comportement de dépassement de délai de session sur le serveur qui leur est spécifique.	MessageAgent

Evénements

Cliquez pour plus d’informations sur les événements

Masquer les événements hérités

Afficher les événements hérités

	Synthèse	Défini par
acknowledge	Distribué lorsqu’un message d’accusé est reçu pour un message envoyé.	MessageAgent
activate	[Evénement de diffusion] Distribué lorsque l’application Flash Player obtient le focus du système d’exploitation et devient active.	EventDispatcher
channelConnect	Distribué lorsque le canal sous-jacent de la classe MessageAgent utilise des connexions.	MessageAgent
channelDisconnect	Distribué lorsque le canal sous-jacent de la classe MessageAgent utilise des déconnexions.	MessageAgent
channelFault	Distribué lorsque le canal sous-jacent utilisé par la classe MessageAgent génère des erreurs.	MessageAgent
deactivate	[Evénement de diffusion] Distribué lorsque l’application Flash Player ou AIR perd le focus du système d’exploitation et devient inactive.	EventDispatcher
fault	Distribué lorsqu’une erreur de message se produit.	MessageAgent
message	Distribué lorsqu’un message est reçu par la classe Consumer.	Consumer
propertyChange	Distribué lorsque la propriété connected de la classe MessageAgent change.	MessageAgent

Détails de la propriété

selector

propriété

selector:String

Version du langage:

ActionScript 3.0

Versions du produit:

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

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Sélecteur de la classe Consumer. Il s’agit d’une expression transmise à la destination qui l’utilise pour filtrer les messages délivrés à la classe Consumer.

Avant un appel à la méthode subscribe(), cette propriété peut être définie sans effets secondaires. Une fois que la classe Consumer s’est abonnée à sa destination, changer cette valeur présente pour effet secondaire de mettre à jour l’abonnement de la classe Consumer pour utiliser immédiatement la nouvelle expression de sélecteur.

La destination distante doit comprendre la valeur de l’expression de sélecteur.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange .

Implémentation
public function get selector():String
public function set selector(value:String):void

subtopic

propriété

subtopic:String

Version du langage:

ActionScript 3.0

Versions du produit:

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

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Fournit un accès à la sous-rubrique de la destination que la classe MessageAgent utilise.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange .

Implémentation
public function get subtopic():String
public function set subtopic(value:String):void

Détails du constructeur

()

Constructeur

public function Consumer(messageType:String = "flex.messaging.messages.AsyncMessage")

Version du langage:

ActionScript 3.0

Versions du produit:

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

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Constructeur.

Paramètres

messageType:String (default = "flex.messaging.messages.AsyncMessage") — Alias du type de message traité par le service hébergeant la destination auquel la classe Consumer va s’abonner. Cet argument est déconseillé et est ignoré par le constructeur.

Exemple ( Comment utiliser cet exemple )

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

Détails de l’événement

message

Evénement

Type d’objet d’événement: mx.messaging.events.MessageEvent
propriété MessageEvent.type = mx.messaging.events.MessageEvent.MESSAGE

Version du langage:

ActionScript 3.0

Versions du produit:

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

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Distribué lorsqu’un message est reçu par la classe Consumer.

Type d’événement MESSAGE ; distribué à la réception d’un message.

La valeur de cette constante est "message".

Les valeurs des propriétés de l’objet d’événement sont les suivantes :

Propriété	Valeur
`bubbles`	false
`cancelable`	false
`currentTarget`	Objet définissant l’écouteur d’événement qui traite l’événement. Par exemple, si vous utilisez `myButton.addEventListener()` pour enregistrer un écouteur d’événement, myButton est la valeur de `currentTarget`.
`message`	Message associé à cet événement.
`target`	Objet qui a distribué l’événement (il ne s’agit pas toujours de l’objet qui écoute l’événement). Pour accéder systématiquement à l’objet qui écoute l’événement, utilisez la propriété `currentTarget`.

Informations juridiques | Politique de confidentialité en ligne

Consumer - AS3 BlazeDS LCDS

Classes x

selector

subtopic

Consumer

message