AbstractProducer - Guide de référence de l’API Adobe ActionScript® 3 (AS3 BlazeDS LCDS)

Package	mx.messaging
Classe	public class AbstractProducer
Héritage	AbstractProducer MessageAgent EventDispatcher Object
Sous-classes	MultiTopicProducer, Producer

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

La classe AbstractProducer est la classe de base des classes Producer et MultiTopicConsumer. Ces classes vous permettent d’envoyer des messages vers le serveur.

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
		autoConnect : Boolean Si true, la classe Producer se connecte automatiquement à sa destination la première fois que la méthode send() est appelée.	AbstractProducer
		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
		defaultHeaders : Object En-têtes par défaut à appliquer aux messages envoyés par la classe Producer.	AbstractProducer
		destination : String Fournit un accès à la destination pour la classe MessageAgent.	MessageAgent
		priority : int Priorité de message par défaut des messages envoyés par la classe Producer.	AbstractProducer
		reconnectAttempts : int Nombre de tentatives de reconnexion effectuées par la classe Producer si la destination n’est pas disponible ou si la connexion à la destination est interrompue.	AbstractProducer
		reconnectInterval : int Nombre de millisecondes s’écoulant entre les tentatives de reconnexion.	AbstractProducer
		requestTimeout : int Fournit un accès au délai d’attente de demande en secondes pour les messages envoyés.	MessageAgent

Méthodes publiques

Masquer les méthodes publiques héritées

Afficher les méthodes publiques héritées

	Méthode		Défini par
		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
		connect():void Connecte la classe Producer à sa destination cible.	AbstractProducer
		disconnect():void [override] Déconnecte la classe Producer de sa destination distante.	AbstractProducer
		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
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Supprime un écouteur de l’objet EventDispatcher.	EventDispatcher
		send(message:IMessage):void Envoie le message spécifié à sa destination.	AbstractProducer
		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
		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
		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
		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
propertyChange	Distribué lorsque la propriété connected de la classe MessageAgent change.	MessageAgent

Détails de la propriété

autoConnect

propriété

autoConnect:Boolean

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

Si true, la classe Producer se connecte automatiquement à sa destination la première fois que la méthode send() est appelée. Si false, la méthode connect() doit être appelée explicitement pour établir une connexion à la destination. Par défaut, cette propriété est true, mais les applications devant opérer en mode hors-ligne peuvent la définir sur false pour empêcher la méthode send() d’établir implicitement une connexion.

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 autoConnect():Boolean
public function set autoConnect(value:Boolean):void

defaultHeaders

propriété

defaultHeaders: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

En-têtes par défaut à appliquer aux messages envoyés par la classe Producer. Les en-têtes par défaut n’existant pas dans le message seront créés. Si le message contient déjà un en-tête correspondant, la valeur dans le message a priorité et la valeur d’en-tête par défaut est ignorée.

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 defaultHeaders():Object
public function set defaultHeaders(value:Object):void

priority

propriété

priority:int

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

Priorité de message par défaut des messages envoyés par la classe Producer. Les valeurs possibles vont de 0 à 9 (0 étant la valeur la plus basse) et -1 signifie qu’aucune priorité n’est définie pour la classe Producer. Si une priorité est déjà définie pour le message, cette priorité l’emporte sur celle de la classe Producer.

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 priority():int
public function set priority(value:int):void

reconnectAttempts

propriété

reconnectAttempts:int

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

Nombre de tentatives de reconnexion effectuées par la classe Producer si la destination n’est pas disponible ou si la connexion à la destination est interrompue. Une valeur égale à -1 permet des tentatives illimitées. Une valeur égale à zéro désactive les tentatives de reconnexion.

Les tentatives de reconnexion sont effectuées à un rythme constant selon la valeur interne de reconnexion. Lorsqu’une tentative de reconnexion a lieu, si le canal sous-jacent de la classe Producer n’est pas connecté ou ne tente pas de se connecter, le canal commence une tentative de connexion. Les tentatives de reconnexion suivantes de la classe Producer qui se produisent alors que la tentative de connexion du canal sous-jacent est en attente sont ignorées jusqu’à ce que la tentative de connexion en attente du canal réussisse ou échoue.

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 reconnectAttempts():int
public function set reconnectAttempts(value:int):void

Eléments de l’API associés

mx.messaging.Producer.reconnectInterval

reconnectInterval

propriété

reconnectInterval:int

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

Nombre de millisecondes s’écoulant entre les tentatives de reconnexion. Si une classe Producer ne reçoit pas d’accusé pour une tentative de connexion, elle attend pendant le nombre de millisecondes spécifié avant d’effectuer une tentative de reconnexion suivante. Définir la valeur sur zéro désactive les tentatives de reconnexion.

Les tentatives de reconnexion sont effectuées à un rythme constant selon cette valeur. Lorsqu’une tentative de reconnexion a lieu, si le canal sous-jacent de la classe Producer n’est pas connecté ou ne tente pas de se connecter, le canal commence une tentative de connexion. Les tentatives de reconnexion suivantes de la classe Producer qui se produisent alors que la tentative de connexion du canal sous-jacent est en attente sont ignorées jusqu’à ce que la tentative de connexion en attente du canal réussisse ou échoue.

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 reconnectInterval():int
public function set reconnectInterval(value:int):void

Valeur émise

ArgumentError — Si la valeur assignée est négative.

Eléments de l’API associés

mx.messaging.Producer.reconnectInterval

Détails de la méthode

connect

()

méthode

public function connect():void

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

Connecte la classe Producer à sa destination cible. Lorsqu’une connexion est établie, la propriété connected est redéfinie sur true et peut être liée et génère des événements PropertyChangeEvent. Le message de commande TRIGGER_CONNECT_OPERATION interne envoyé résulte en un événement d’accusé ou d’erreur selon que le canal sous-jacent établit sa connexion ou non.

Valeur émise

InvalidDestinationError — Si aucune destination n’est définie.

Exemple
Comment utiliser cet exemple

         var producer:Producer = new Producer();
         producer.destination = "TestTopic";
         producer.addEventListener(PropertyChangeEvent.PROPERTY_CHANGE, handleConnect);
         producer.connect();

disconnect

()

méthode

override public function disconnect():void

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

Déconnecte la classe Producer de sa destination distante. Cette méthode n’attend pas que les opérations de réseau en attente se terminent. Après avoir invoqué la méthode disconnect(), la classe Producer signale qu’elle n’est pas connectée et ne reçoit aucun accusé ou aucune erreur de message en attente. La déconnexion arrête les tentatives de reconnexion automatiques si elles sont en cours d’exécution.

send

()

méthode

public function send(message:IMessage):void

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

Envoie le message spécifié à sa destination. Si la classe Producer est utilisée pour l’échange de messages de publication/d’abonnement, seuls les messages du type AsyncMessage doivent être envoyés, sauf si un type de message personnalisé est utilisé et que la destination du message sur le serveur a été configurée pour traiter le type de message personnalisé.

Paramètres

message:IMessage — Message à envoyer.

Valeur émise

InvalidDestinationError — Si aucune destination n’est définie.

Exemple
Comment utiliser cet exemple

         var producer:Producer = new Producer();
         producer.destination = "TestTopic";
         var msg:AsyncMessage = new AsyncMessage();
         msg.body = "test message";
         producer.send(msg);

Informations juridiques | Politique de confidentialité en ligne

AbstractProducer - AS3 BlazeDS LCDS

Classes x

autoConnect

defaultHeaders

priority

reconnectAttempts

reconnectInterval

connect

disconnect

send