Channel

Package	mx.messaging
Classe	public class Channel
Héritage	Channel EventDispatcher Object
Implémente	IMXMLObject
Sous-classes	PollingChannel

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 Channel est la classe de canal de message de base que tous les canaux dans le système d’échange de messages doivent développer.

Les canaux sont des conduits basés sur des protocoles spécifiques et destinés aux messages envoyés entre les classes MessageAgent et les destinations distantes. Les canaux préconfigurés sont obtenus au sein de la structure à l’aide de la méthode ServerConfig.getChannel(). Vous pouvez créer un canal directement à l’aide de l’opérateur new et l’ajouter directement à la classe ChannelSet.

Les canaux représentent une connexion physique à une extrémité distante. Par défaut, les canaux sont partagés à travers les destinations. Cela signifie qu’un client ciblant différentes destinations peut utiliser le même canal pour communiquer avec ces destinations.

Remarque : cette classe est destinée à une utilisation avancée uniquement. Utilisez cette classe pour créer des canaux personnalisés tels que les canaux RTMPChannel, AMFChannel et HTTPChannel existants.

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 le canal est authentifié.	Channel
		channelSets : Array [lecture seule] Fournit un accès aux classes ChannelSet connectées à ce canal.	Channel
		connected : Boolean [lecture seule] Indique si ce canal a établi une connexion à la destination distante.	Channel
		connectTimeout : int Fournit un accès au délai d’attente de connexion en secondes pour le canal.	Channel
		constructor : Object Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.	Object
		endpoint : String [lecture seule] Fournit un accès à l’extrémité de ce canal.	Channel
		failoverURIs : Array Fournit un accès au jeu d’URI d’extrémité vers lequel ce canal peut tenter de basculer si l’extrémité est clusterisée.	Channel
		id : String Fournit un accès à l’ID de ce canal.	Channel
		protocol : String [lecture seule] Fournit un accès au protocole que le canal utilise.	Channel
		reconnecting : Boolean [lecture seule] Indique si ce canal est en train de se reconnecter à une extrémité alternative.	Channel
		recordMessageSizes : Boolean [lecture seule] La propriété Channel détermine le niveau d’injection d’informations de performances - que nous injections des tailles de messages ou non.	Channel
		recordMessageTimes : Boolean [lecture seule] La propriété Channel détermine le niveau d’injection d’informations de performances - que nous injections des dates/heures ou non.	Channel
		requestTimeout : int Fournit un accès au délai d’attente de demande par défaut en secondes pour le canal.	Channel
		uri : String Fournit un accès à l’URI utilisée pour créer toute l’URI d’extrémité pour ce canal.	Channel

Propriétés protégées

	Propriété		Défini par
		shouldBeConnected : Boolean [lecture seule] Indique si ce canal doit être connecté à son extrémité.	Channel

Méthodes publiques

Masquer les méthodes publiques héritées

Afficher les méthodes publiques héritées

	Méthode		Défini par
		Channel(id:String = null, uri:String = null) Construit une instance d’un canal générique qui se connecte à l’URI d’extrémité spécifiée.	Channel
		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
		applySettings(settings:XML):void Les sous-classes doivent remplacer cette méthode pour appliquer les paramètres susceptibles d’être nécessaires à un canal individuel.	Channel
		connect(channelSet:ChannelSet):void Connecte la classe ChannelSet au canal.	Channel
		disconnect(channelSet:ChannelSet):void Déconnecte la classe ChannelSet du canal.	Channel
		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
		logout(agent:MessageAgent):void Envoie une classe CommandMessage au serveur pour se déconnecter si le canal est connecté.	Channel
		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(agent:MessageAgent, message:IMessage):void Envoie le message spécifié à sa destination cible.	Channel
		setCredentials(credentials:String, agent:MessageAgent = null, charset:String = null):void Définit les informations d’identification sur la valeur spécifiée.	Channel
		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 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

	Méthode		Défini par
		applyClientLoadBalancingSettings(props:XML):void Applique les URL d’équilibrage de charge client si elles existent.	Channel
		connectFailed(event:ChannelFaultEvent):void Traite une connexion interne échouée et distribue l’événement FAULT pour le canal.	Channel
		connectSuccess():void Traite une connexion interne réussie et distribue l’événement CONNECT pour le canal.	Channel
		connectTimeoutHandler(event:flash.events:TimerEvent):void Gère un délai d’attente de connexion en distribuant une classe ChannelFaultEvent.	Channel
		disconnectFailed(event:ChannelFaultEvent):void Traite une déconnexion interne échouée et distribue l’événement FAULT pour le canal.	Channel
		disconnectSuccess(rejected:Boolean = false):void Traite une déconnexion interne réussie et distribue l’événement DISCONNECT pour le canal.	Channel
		flexClientWaitHandler(event:PropertyChangeEvent):void Gère une modification de la condition de surveillance pour gérer la connexion de canal initiale pour l’application.	Channel
		getMessageResponder(agent:MessageAgent, message:IMessage):MessageResponder Renvoie la classe MessageResponder appropriée pour la méthode send() du canal.	Channel
		internalConnect():void Connecte le canal à son extrémité.	Channel
		internalDisconnect(rejected:Boolean = false):void Déconnecte le canal de son extrémité.	Channel
		internalSend(messageResponder:MessageResponder):void Envoie le message via le canal et achemine la réponse à la classe Responder.	Channel

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 que le canal se connecte à son extrémité.	Channel
channelDisconnect	Distribué après que le canal se déconnecte de son extrémité.	Channel
channelFault	Distribué après une erreur du canal.	Channel
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
message	Distribué lorsqu’un canal reçoit un message de son extrémité.	Channel
propertyChange	Distribué lorsqu’une propriété du canal change.	Channel

Constantes protégées

	Constante		Défini par
		CONNECT_TIMEOUT_SECONDS : String = "connect-timeout-seconds" [statique]	Channel
		ENABLE_SMALL_MESSAGES : String = "enable-small-messages" [statique]	Channel
		FALSE : String = "false" [statique]	Channel
		RECORD_MESSAGE_SIZES : String = "record-message-sizes" [statique]	Channel
		RECORD_MESSAGE_TIMES : String = "record-message-times" [statique]	Channel
		REQUEST_TIMEOUT_SECONDS : String = "request-timeout-seconds" [statique]	Channel
		SERIALIZATION : String = "serialization" [statique]	Channel
		TRUE : String = "true" [statique]	Channel

Détails de la propriété

authenticated

propriété

authenticated:Boolean [lecture seule]

Indique si le canal est authentifié.

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 authenticated():Boolean

endpoint

propriété

endpoint:String [lecture seule]

Fournit un accès à l’extrémité de ce canal. Cette valeur est calculée en fonction de la valeur de la propriété uri.

Implémentation
public function get endpoint():String

failoverURIs

propriété

failoverURIs:Array

Fournit un accès au jeu d’URI d’extrémité vers lequel ce canal peut tenter de basculer si l’extrémité est clusterisée.

Cette propriété est automatiquement renseignée lorsque le regroupement est activé. Si vous n’utilisez pas le regroupement, vous pouvez définir vos propres valeurs.

Implémentation
public function get failoverURIs():Array
public function set failoverURIs(value:Array):void

id

propriété

id:String

Fournit un accès à l’ID de ce canal.

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

protocol

propriété

protocol:String [lecture seule]

Fournit un accès au protocole que le canal utilise.

Remarque : les sous-classes Channel doivent remplacer cette méthode et renvoyer une chaîne qui représente leur protocole pris en charge. Par exemple, « rtmp », « http » ou « https » sont des chaînes de protocoles pris en charge.

Implémentation
public function get protocol():String

reconnecting

propriété

reconnecting:Boolean [lecture seule]

Indique si ce canal est en train de se reconnecter à une extrémité alternative.

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 reconnecting():Boolean

requestTimeout

propriété

requestTimeout:int

Fournit un accès au délai d’attente de demande par défaut en secondes pour le canal. Une valeur égale ou inférieure à 0 indique que les demandes sortantes n’expirent jamais sur le client.

Les délais d’attente de demandes sont très utiles pour l’échange de messages de style RPC nécessitant une réponse de la destination distante.

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

shouldBeConnected

propriété

shouldBeConnected:Boolean [lecture seule]

Indique si ce canal doit être connecté à son extrémité. Cet indicateur permet de contrôler le moment auquel un basculement doit être tenté et celui auquel une notification de déconnexion est envoyée à l’extrémité distante lors d’une déconnexion ou d’une erreur.

Implémentation
protected function get shouldBeConnected():Boolean

uri

propriété

uri:String

Fournit un accès à l’URI utilisée pour créer toute l’URI d’extrémité pour ce canal. L’URI peut être un chemin partiel, auquel cas l’URI d’extrémité entière est calculée selon les besoins.

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

Détails du constructeur

Détails de la méthode

applyClientLoadBalancingSettings

()

méthode

protected function applyClientLoadBalancingSettings(props:XML):void

Applique les URL d’équilibrage de charge client si elles existent. Choisit au hasard une URL dans le jeu d’URL d’équilibrage de charge client et la définit en tant qu’URL principale du canal, puis assigne le reste des URL en tant qu’URI failoverURI du canal.

Paramètres

props:XML — Section propriétés du fragment XML du fichier services-config.xml de ce canal.

applySettings

()

méthode

public function applySettings(settings:XML):void

Les sous-classes doivent remplacer cette méthode pour appliquer les paramètres susceptibles d’être nécessaires à un canal individuel. Assurez-vous d’appeler super.applySettings() afin d’appliquer les paramètres communs pour le canal. Cette méthode est principalement utilisée dans les sous-classes Channel.

Paramètres

settings:XML — Fragment XML du fichier services-config.xml de ce canal.

connect

()

méthode

public final function connect(channelSet:ChannelSet):void

Connecte la classe ChannelSet au canal. Si le canal ne s’est pas encore connecté à son extrémité, il tente de le faire. Les sous-classes Channel doivent remplacer la méthode internalConnect() et appeler la méthode connectSuccess() une fois la connexion sous-jacente établie.

Paramètres

channelSet:ChannelSet — Classe ChannelSet à connecter au canal.

connectFailed

()

méthode

protected function connectFailed(event:ChannelFaultEvent):void

Traite une connexion interne échouée et distribue l’événement FAULT pour le canal. Si le canal comporte des valeurs failoverURI, il tente de se reconnecter automatiquement en essayant ces valeurs URI dans l’ordre jusqu’à établissement d’une connexion ou épuisement des valeurs disponibles.

Paramètres

event:ChannelFaultEvent — Classe ChannelFaultEvent de la connexion échouée.

connectSuccess

()

méthode

protected function connectSuccess():void

Traite une connexion interne réussie et distribue l’événement CONNECT pour le canal.

connectTimeoutHandler

()

méthode

protected function connectTimeoutHandler(event:flash.events:TimerEvent):void

Gère un délai d’attente de connexion en distribuant une classe ChannelFaultEvent. Les sous-types peuvent remplacer ceci pour arrêter la tentative de connexion actuelle mais doivent appeler l’événement super.connectTimeoutHandler(event).

Paramètres

event:flash.events:TimerEvent — Evénement Timer indiquant que le délai d’attente de connexion a été atteint.

disconnect

()

méthode

public final function disconnect(channelSet:ChannelSet):void

Déconnecte la classe ChannelSet du canal. Si le canal est connecté à son extrémité et qu’il ne comporte pas d’autres classes ChannelSet connectées, il se déconnecte en interne.

Les sous-classes Channel doivent remplacer la méthode internalDisconnect() et appeler la méthode disconnectSuccess() une fois la connexion sous-jacente terminée.

Paramètres

channelSet:ChannelSet — Classe ChannelSet à déconnecter du canal.

disconnectFailed

()

méthode

protected function disconnectFailed(event:ChannelFaultEvent):void

Traite une déconnexion interne échouée et distribue l’événement FAULT pour le canal.

Paramètres

event:ChannelFaultEvent — Classe ChannelFaultEvent de la déconnexion échouée.

disconnectSuccess

()

méthode

protected function disconnectSuccess(rejected:Boolean = false):void

Traite une déconnexion interne réussie et distribue l’événement DISCONNECT pour le canal. Si la déconnexion est liée à une panne de réseau et que le canal comporte des valeurs failoverURI, il tente de se reconnecter automatiquement en essayant ces valeurs URI dans l’ordre jusqu’à établissement d’une connexion ou épuisement des valeurs disponibles.

Paramètres

rejected:Boolean (default = false) — true si la déconnexion doit ignorer un traitement de basculement qui serait sinon tenté ; false si le traitement de basculement doit être autorisé.

flexClientWaitHandler

()

méthode

protected function flexClientWaitHandler(event:PropertyChangeEvent):void

Gère une modification de la condition de surveillance pour gérer la connexion de canal initiale pour l’application. Lorsque ceci est invoqué, cela signifie que ce canal attend pour essayer de se connecter.

Paramètres

event:PropertyChangeEvent — Classe PropertyChangeEvent distribuée par le singleton FlexClient.

getMessageResponder

()

méthode

protected function getMessageResponder(agent:MessageAgent, message:IMessage):MessageResponder

Renvoie la classe MessageResponder appropriée pour la méthode send() du canal. Doit être remplacé.

Paramètres

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

	`message:IMessage` — Message à envoyer.

Valeur renvoyée

MessageResponder — Classe MessageResponder devant gérer le résultat ou l’erreur.

Valeur émise

IllegalOperationError — Si la sous-classe Channel ne remplace pas cette méthode.

internalConnect

()

méthode

protected function internalConnect():void

Connecte le canal à son extrémité. Doit être remplacé.

internalDisconnect

()

méthode

protected function internalDisconnect(rejected:Boolean = false):void

Déconnecte le canal de son extrémité. Doit être remplacé.

Paramètres

rejected:Boolean (default = false) — true si la déconnexion est due à un délai d’attente ou à un rejet de connexion, la reconnexion ne devant pas être tentée automatiquement ; dans le cas contraire, false.

internalSend

()

méthode

protected function internalSend(messageResponder:MessageResponder):void

Envoie le message via le canal et achemine la réponse à la classe Responder. Doit être remplacé.

Paramètres

messageResponder:MessageResponder — Classe MessageResponder devant gérer la réponse.

logout

()

méthode

public function logout(agent:MessageAgent):void

Envoie une classe CommandMessage au serveur pour se déconnecter si le canal est connecté. Les informations d’identification actuelles sont effacées.

Paramètres

agent:MessageAgent — Classe MessageAgent à déconnecter.

send

()

méthode

public function send(agent:MessageAgent, message:IMessage):void

Envoie le message spécifié à sa destination cible. Les sous-classes doivent remplacer la méthode internalSend() pour effectuer l’envoi effectif.

Paramètres

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

	`message:IMessage` — Message à envoyer.

Valeur émise

InvalidDestinationError — Si ni la classe MessageAgent ni le message ne spécifient une destination.

setCredentials

()

méthode

public function setCredentials(credentials:String, agent:MessageAgent = null, charset:String = null):void

Définit les informations d’identification sur la valeur spécifiée. Si les informations d’identification ne sont pas nulles et que le canal est connecté, cette méthode envoie également une classe CommandMessage au serveur pour se connecter à l’aide des informations d’identification.

Paramètres

	`credentials:String` — Chaîne d’informations d’identification.

	`agent:MessageAgent` (default = `null`) — Classe MessageAgent devant se connecter et allant traiter le résultat de connexion.

	`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 jeu de caractères existant, ISO-Latin-1.

Valeur émise

IllegalOperationError — dans deux situations ; si les informations d’identification ont déjà été définies et qu’une authentification est en cours au niveau de la destination distante, ou si l’authentification et les informations d’identification spécifiées ne correspondent pas aux informations d’identification actuellement authentifiées.

Détails de l’événement

channelConnect

Evénement

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

Distribué après que le canal se connecte à son extrémité.

Channel et ses sous-classes émettent un code Channel.Connect.Failed chaque fois qu’un problème se présente lors des tentatives de connexion d’un canal à une destination distante. Un objet AMFChannel émet un code Channel.Call.Failed code lorsque le canal est déjà connecté mais obtient un code Call.Failed de sa classe NetConnection sous-jacente.

Type d’événement CONNECT ; indique que le canal s’est connecté à son extrémité.

La valeur de cette constante est "channelConnect".

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

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.

Détails de la constante

CONNECT_TIMEOUT_SECONDS

Constante

protected static const CONNECT_TIMEOUT_SECONDS:String = "connect-timeout-seconds"

ENABLE_SMALL_MESSAGES

Constante

protected static const ENABLE_SMALL_MESSAGES:String = "enable-small-messages"

FALSE

Constante

protected static const FALSE:String = "false"

RECORD_MESSAGE_SIZES

Constante

protected static const RECORD_MESSAGE_SIZES:String = "record-message-sizes"

RECORD_MESSAGE_TIMES

Constante

protected static const RECORD_MESSAGE_TIMES:String = "record-message-times"

REQUEST_TIMEOUT_SECONDS

Constante

protected static const REQUEST_TIMEOUT_SECONDS:String = "request-timeout-seconds"

SERIALIZATION

Constante

protected static const SERIALIZATION:String = "serialization"

TRUE

Constante

protected static const TRUE:String = "true"

Informations juridiques | Politique de confidentialité en ligne

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

	`id:String` (default = `null`) — ID de ce canal.

	`uri:String` (default = `null`) — URI d’extrémité de ce canal.

Channel - AS3 BlazeDS LCDS

Packagesx

Eléments du langage

Annexes

Package mx.messaging

authenticated

channelSets

connected

connectTimeout

endpoint

failoverURIs

id

protocol

reconnecting

recordMessageSizes

recordMessageTimes

requestTimeout

shouldBeConnected

uri

applyClientLoadBalancingSettings

applySettings

connect

connectFailed

connectSuccess

connectTimeoutHandler

disconnect

disconnectFailed

disconnectSuccess

flexClientWaitHandler

getMessageResponder

internalConnect

internalDisconnect

internalSend

logout

send

setCredentials

channelConnect

channelDisconnect

channelFault

message

propertyChange

CONNECT_TIMEOUT_SECONDS

ENABLE_SMALL_MESSAGES

FALSE

RECORD_MESSAGE_SIZES

RECORD_MESSAGE_TIMES

REQUEST_TIMEOUT_SECONDS

SERIALIZATION

TRUE