ChannelSet

Package	mx.messaging
Classe	public class ChannelSet
Héritage	ChannelSet EventDispatcher Object
Sous-classes	AdvancedChannelSet

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 ChannelSet est un jeu de canaux utilisés pour envoyer des messages à une destination cible. La classe ChannelSet améliore la qualité du service sur le client en passant en revue ses canaux pour envoyer des messages en cas de pannes du réseau ou de problèmes de canaux particuliers.

Propriété MXML par défautchannels

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 la classe ChannelSet comporte un canal sous-jacent ayant réussi a s’authentifier auprès de son extrémité.	ChannelSet
		channelIds : Array [lecture seule] ID des canaux utilisés par la classe ChannelSet.	ChannelSet
		channels : Array Fournit un accès aux canaux dans la classe ChannelSet.	ChannelSet
		clustered : Boolean Indique si la classe ChannelSet cible une destination clusterisée.	ChannelSet
		connected : Boolean [lecture seule] Indique si la classe ChannelSet est connectée.	ChannelSet
		constructor : Object Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.	Object
		currentChannel : Channel [lecture seule] Renvoie le canal actuel pour la classe ChannelSet.	ChannelSet
		heartbeatInterval : int Le nombre de millisecondes écoulées entre les battements envoyés à l’hôte distant pendant que cet objet ChannelSet est connecté activement mais inactif.	ChannelSet
		initialDestinationId : String Permet à la classe ChannelSet d’accéder à la destination à laquelle elle a d’abord accédé.	ChannelSet
		messageAgents : Array [lecture seule] Fournit un accès au jeu de classes MessageAgent qui utilisent cette classe ChannelSet.	ChannelSet

Méthodes publiques

Masquer les méthodes publiques héritées

Afficher les méthodes publiques héritées

	Méthode		Défini par
		ChannelSet(channelIds:Array = null, clusteredWithURLLoadBalancing:Boolean = false) Construit une classe ChannelSet.	ChannelSet
		addChannel(channel:Channel):void Ajoute un canal à la classe ChannelSet.	ChannelSet
		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 et redistribue l’événement.	ChannelSet
		channelDisconnectHandler(event:ChannelEvent):void Gère un événement ChannelEvent DISCONNECT et redistribue l’événement.	ChannelSet
		channelFaultHandler(event:ChannelFaultEvent):void Gère un événement ChannelFaultEvent et redistribue l’événement.	ChannelSet
		connect(agent:MessageAgent):void Connecte une classe MessageAgent à la classe ChannelSet.	ChannelSet
		disconnect(agent:MessageAgent):void Déconnecte une classe MessageAgent spécifique de la classe ChannelSet.	ChannelSet
		disconnectAll():void Déconnecte toutes les classes MessageAgent associées et les canaux sous-jacents connectés.	ChannelSet
		dispatchEvent(event:Event):Boolean Distribue un événement dans le flux d’événements.	EventDispatcher
		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
		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
		login(username:String, password:String, charset:String = null):mx.rpc:AsyncToken Authentifie la classe ChannelSet avec le serveur à l’aide des informations d’identification fournies.	ChannelSet
		logout(agent:MessageAgent = null):mx.rpc:AsyncToken Déconnecte la classe ChannelSet du serveur.	ChannelSet
		propertyIsEnumerable(name:String):Boolean Indique si la propriété spécifiée existe et est énumérable.	Object
		removeChannel(channel:Channel):void Supprime un canal de la classe ChannelSet.	ChannelSet
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Supprime un écouteur de l’objet EventDispatcher.	EventDispatcher
		send(agent:MessageAgent, message:IMessage):void Envoie un message d’une classe MessageAgent via le canal connecté.	ChannelSet
		setCredentials(credentials:String, agent:MessageAgent, charset:String = null):void Stocke les informations d’identification et les transmet à chaque canal connecté.	ChannelSet
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.	Object
		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 [override] Renvoie une chaîne contenant les ID des canaux dans la classe ChannelSet.	ChannelSet
		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

	Méthode		Défini par
		messageHandler(event:MessageEvent):void Redistribue les événements de messages du canal actuellement connecté.	ChannelSet

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
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é après qu’un canal de la classe ChannelSet se connecte à son extrémité.	ChannelSet
channelDisconnect	Distribué après qu’un canal de la classe ChannelSet se déconnecte de son extrémité.	ChannelSet
channelFault	Distribué après une erreur d’un canal de la classe ChannelSet.	ChannelSet
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	L’événement d’erreur est distribué lorsqu’un appel de connexion ou de déconnexion échoue.	ChannelSet
propertyChange	Distribué lorsqu’une propriété de la classe ChannelSet change.	ChannelSet
result	L’événement de résultat est distribué lorsqu’un appel de connexion ou de déconnexion est renvoyé avec succès.	ChannelSet

Détails de la propriété

connected

propriété

connected:Boolean [lecture seule]

Indique si la classe ChannelSet est connecté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 connected():Boolean

heartbeatInterval

propriété

heartbeatInterval:int

Le nombre de millisecondes écoulées entre les battements envoyés à l’hôte distant pendant que cet objet ChannelSet est connecté activement mais inactif. Tout trafic de message sortant retarde les battements temporairement, avec ce nombre de millisecondes après le dernier message envoyé avant que le prochain battement ne soit émise.

Cette propriété est très utile pour les applications qui se connectent à un hôte distant pour les mises à jour poussées reçues et n’envoyant pas activement de messages, mais que vous souhaitez être tenu informé de la perte de connexion même lorsque le calque de mise en réseau ne fournit pas les notifications directement. En émettant des battements périodiques, le client peut forcer le calque de mise en réseau pour signaler un délai si la connexion sous-jacente a abandonné sans notification et que l’application peut répondre à la déconnexion de façon appropriée.

Un valeur non positive désactive les battements vers l’hôte distant. La valeur par défaut est 0 indiquant que les battements sont désactivés. Si l’application définit cette valeur qui doit préférer un intervalle plus long plutôt que plus court, pour éviter de placer une charge inutile sur l’hôte distant. Pour illustrer cela, un socket TCP de bas niveau maintient en général par défaut à un intervalle de 2 heures. Cet intervalle est plus long que la plupart des applications permettant les battements ne seraient susceptibles d’utiliser, mais il sert de précédent évident pour préférer un intervalle plus long par rapport à un intervalle plus court.

Si le canal sous-jacent connecté actuellement émet des requêtes de sondage à l’hôte distant, les battements sont supprimés car les requêtes de sondage périodiques,prennent efficacement leur place.

Implémentation
public function get heartbeatInterval():int
public function set heartbeatInterval(value:int):void

Détails du constructeur

Détails de la méthode

logout

()

méthode

public function logout(agent:MessageAgent = null):mx.rpc:AsyncToken

Déconnecte la classe ChannelSet du serveur. Contrairement aux autres opérations effectuées sur les canaux et la classe ChannelSet, cette opération renvoie un jeton asynchrone auquel le code client peut ajouter un répondeur afin de gérer directement les réussites ou les échecs. Si la déconnexion réussit, les informations d’identification ayant été mises en cache pour être utilisées lors des reconnexions automatiques sont effacées pour la classe ChannelSet et les canaux du jeu, ainsi que leur état authentifié, sont définis sur false. Si la classe ChannelSet n’est pas connectée au serveur lorsque cette méthode est invoquée, elle déclenche une tentative de connexion et, si cette tentative réussit, envoie une commande de déconnexion au serveur.

L’argument MessageAgent est présent pour prendre en charge le comportement de déconnexion existant et le code client qui invoque cette méthode ne doit pas transmettre une référence MessageAgent. Invoquez simplement logout() ne transmettant aucun argument.

Cette méthode est également invoquée par les composants de services à partir de leurs méthodes logout(), et ces composants transmettent une référence MessageAgent à cette méthode lorsqu’ils se déconnectent. Cet argument est le déclencheur pour exécuter le comportement de déconnexion existant qui diffère du nouveau comportement décrit ci-dessus. Le comportement existant envoie uniquement une demande de déconnexion au serveur si le client est connecté et authentifié. Si ces conditions ne sont pas observées, le comportement existant de cette méthode consiste à ne rien faire d’autre que d’effacer les informations d’identification ayant été mises en cache pour être utilisées lors des reconnexions automatiques.

Paramètres

agent:MessageAgent (default = null) — Argument existant. Classe MessageAgent qui initialise la déconnexion.

Valeur renvoyée

mx.rpc:AsyncToken — Renvoie un jeton auquel le code client peut ajouter un répondeur afin de gérer directement les réussites ou les échecs.

Valeur émise

IllegalOperationError — Si une opératon de connexion ou de déconnexion est en cours.

messageHandler

()

méthode

protected function messageHandler(event:MessageEvent):void

Redistribue les événements de messages du canal actuellement connecté.

Paramètres

event:MessageEvent — Evénement MessageEvent du canal.

Détails de l’événement

Informations juridiques | Politique de confidentialité en ligne

Propriété	Valeur
`bubbles`	false
`cancelable`	false
`channel`	Canal ayant généré cet événement.
`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`.
`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`.
`reconnecting`	Indique si le canal ayant généré cet événement est en train de se reconnecter.
`rejected`	Indique si le canal ayant généré cet événement a été rejeté. true si le canal a été déconnecté pour inactivité et ne doit pas tenter de basculer ou de se connecter sur le canal alternatif.

Propriété	Valeur
`bubbles`	false
`cancelable`	false
`channel`	Canal ayant généré cet événement.
`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`.
`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`.
`reconnecting`	Indique si le canal ayant généré cet événement est en train de se reconnecter.
`rejected`	Indique si le canal ayant généré cet événement a été rejeté. true si le canal a été déconnecté pour inactivité et ne doit pas tenter de basculer ou de se connecter sur le canal alternatif.

Propriété	Valeur
`bubbles`	false
`cancelable`	false
`channel`	Canal ayant généré cet événement.
`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`.
`faultCode`	Fournit des détails spécifiques à la destination relatifs à l’erreur.
`faultDetail`	Fournit un accès à la cause de l’erreur spécifique à la destination.
`faultString`	Fournit un accès à la cause sous-jacente de l’erreur si le canal n’a pas généré l’erreur lui-même.
`reconnecting`	Indique si le canal ayant généré cet événement est en train de se reconnecter.
`rootCause`	Fournit un accès à la cause sous-jacente de l’erreur si le canal n’a pas généré l’erreur lui-même.
`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`.

Propriété	Valeur
`bubbles`	false
`cancelable`	true, appeler preventDefault() à partir de la méthode responder.fault du jeton associé empêchera le service ou l’opération de distribuer cet événement.
`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`.
`fault`	Objet d’erreur contenant les détails relatifs à l’élément ayant provoqué l’événement.
`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`.
`token`	Jeton représentant l’appel à la méthode. Utilisé dans le modèle de jeton d’achèvement asynchrone.

Propriété	Valeur
`bubbles`	Valeur déterminée par le constructeur, false par défaut.
`cancelable`	Valeur déterminée par le constructeur, false par défaut.
`kind`	Type de modification : PropertyChangeEventKind.UPDATE ou PropertyChangeEventKind.DELETE.
`oldValue`	Valeur d’origine de la propriété.
`newValue`	Nouvelle valeur de la propriété, le cas échéant.
`property`	Propriété modifiée.
`source`	Objet contenant la propriété modifiée.
`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`.
`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`.

ChannelSet - AS3 BlazeDS LCDS

Packagesx

Eléments du langage

Annexes

Package mx.messaging

authenticated

channelIds

channels

clustered

connected

currentChannel

heartbeatInterval

initialDestinationId

messageAgents

addChannel

channelConnectHandler

channelDisconnectHandler

channelFaultHandler

connect

disconnect

disconnectAll

login

logout

messageHandler

removeChannel

send

setCredentials

toString

channelConnect

channelDisconnect

channelFault

fault

propertyChange

result

	`channelIds:Array` (default = `null`) — ID des canaux configurés obtenus à partir de ServerConfig à utiliser par cette classe ChannelSet. Si null, les canaux doivent être manuellement ajoutés à la classe ChannelSet.

	`clusteredWithURLLoadBalancing:Boolean` (default = `false`) — True si les canaux dans la classe ChannelSet sont clusterisés via l’équilibrage de charge URL.

	`username:String` — Nom d’utilisateur.

	`password:String` — Mot de passe.

	`charset:String` (default = `null`) — Codage de jeu de caractères à utiliser lors du codage des informations d’identification. La valeur par défaut est null, ce qui implique le jeu de caractères existant, ISO-Latin-1. Le seul autre jeu de caractères pris en charge est « UTF-8 ».

	`agent:MessageAgent` — Classe MessageAgent envoyant le message.

	`message:IMessage` — Message à envoyer.

	`credentials:String` — Informations d’identification de la classe MessageAgent.

	`agent:MessageAgent` — Classe MessageAgent qui définit les informations d’identification.

	`charset:String` (default = `null`) — Codage de jeu de caractères utilisé lors du codage des informations d’identification. La valeur par défaut est null, ce qui implique le codage existant, ISO-Latin-1.