ChannelSet

Paket	mx.messaging
Klasse	public class ChannelSet
Vererbung	ChannelSet EventDispatcher Object
Unterklassen	AdvancedChannelSet

Sprachversion:

ActionScript 3.0

Produktversionen:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services für Java EE 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Der ChannelSet ist ein Satz von Kanälen, die zum Senden von Meldungen an das Ziel verwendet werden. Der ChannelSet verbessert die Dienstqualität auf dem Client, indem die Kanäle durchsucht werden, um bei Netzwerkfehlern oder Fehlern bei einzelnen Kanälen Meldungen zu senden.

Standard-MXML-Eigenschaftchannels

Öffentliche Eigenschaften

Vererbte öffentliche Eigenschaften ausblenden

Vererbte öffentliche Eigenschaften anzeigen

	Eigenschaft		Definiert von
		authenticated : Boolean [schreibgeschützt] Gibt an, ob der ChannelSet über einen zugrundeliegenden Kanal verfügt, der eine erfolgreiche Authentifizierung mit dem zugehörigen Endpunkt aufweist.	ChannelSet
		channelIds : Array [schreibgeschützt] Die IDs der Kanäle, die vom ChannelSet verwendet werden.	ChannelSet
		channels : Array Stellt Zugriff auf Kanäle im ChannelSet zur Verfügung.	ChannelSet
		clustered : Boolean Gibt an, ob der ChannelSet auf ein Cluster-Ziel gerichtet ist.	ChannelSet
		connected : Boolean [schreibgeschützt] Gibt an, ob der ChannelSet verbunden ist.	ChannelSet
		constructor : Object Ein Verweis auf das Klassenobjekt oder die Konstruktorfunktion für eine angegebene Objektinstanz.	Object
		currentChannel : Channel [schreibgeschützt] Gibt den aktuellen Kanal für den ChannelSet zurück.	ChannelSet
		heartbeatInterval : int Die Anzahl von Millisekunden zwischen Heartbeats, die an den Remote-Host gesendet werden, während dieser ChannelSet aktiv verbunden ist, aber inaktiv ist.	ChannelSet
		initialDestinationId : String Stellt Zugriff auf das ursprüngliche Ziel zur Verfügung, den der ChannelSet für den Zugriff verwendet.	ChannelSet
		messageAgents : Array [schreibgeschützt] Stellt Zugriff auf den Satz von MessageAgents zur Verfügung, die diesen ChannelSet verwenden.	ChannelSet

Öffentliche Methoden

Vererbte öffentliche Methoden ausblenden

Vererbte öffentliche Methoden anzeigen

	Methode		Definiert von
		ChannelSet(channelIds:Array = null, clusteredWithURLLoadBalancing:Boolean = false) Erstellt einen ChannelSet.	ChannelSet
		addChannel(channel:Channel):void Fügt einen Kanal zum ChannelSet hinzu.	ChannelSet
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registriert ein Ereignis-Listener-Objekt bei einem EventDispatcher-Objekt, sodass der Listener über ein Ereignis benachrichtigt wird.	EventDispatcher
		channelConnectHandler(event:ChannelEvent):void Verarbeitet CONNECT ChannelEvent und löst das Ereignis erneut aus.	ChannelSet
		channelDisconnectHandler(event:ChannelEvent):void Verarbeitet DISCONNECT ChannelEvent und löst das Ereignis erneut aus.	ChannelSet
		channelFaultHandler(event:ChannelFaultEvent):void Verarbeitet ChannelFaultEvent und löst das Ereignis erneut aus.	ChannelSet
		connect(agent:MessageAgent):void Verbindet einen MessageAgent mit dem ChannelSet.	ChannelSet
		disconnect(agent:MessageAgent):void Trennt die Verbindung eines bestimmten MessageAgent vom ChannelSet.	ChannelSet
		disconnectAll():void Trennt die Verbindung aller verknüpften MessageAgents und trennt die Verbindung aller zugrundeliegenden verbundenen Kanäle.	ChannelSet
		dispatchEvent(event:Event):Boolean Sendet ein Ereignis in den Ereignisablauf.	EventDispatcher
		hasEventListener(type:String):Boolean Überprüft, ob das EventDispatcher-Objekt Listener für einen bestimmten Ereignistyp registriert hat.	EventDispatcher
		hasOwnProperty(name:String):Boolean Gibt an, ob für ein Objekt eine bestimmte Eigenschaft definiert wurde.	Object
		isPrototypeOf(theClass:Object):Boolean Gibt an, ob eine Instanz der Object-Klasse in der Prototypkette des Objekts vorhanden ist, das als Parameter angegeben wurde.	Object
		login(username:String, password:String, charset:String = null):mx.rpc:AsyncToken Authentifiziert den ChannelSet, wobei der Server die zur Verfügung gestellten Benutzerdaten verwendet.	ChannelSet
		logout(agent:MessageAgent = null):mx.rpc:AsyncToken Meldet den ChannelSet vom Server ab.	ChannelSet
		propertyIsEnumerable(name:String):Boolean Gibt an, ob die angegebene Eigenschaft vorhanden ist und durchlaufen werden kann.	Object
		removeChannel(channel:Channel):void Entfernt einen Kanal aus dem ChannelSet.	ChannelSet
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Entfernt einen Listener aus dem EventDispatcher-Objekt.	EventDispatcher
		send(agent:MessageAgent, message:IMessage):void Sendet eine Meldung vom MessageAgent über den derzeit verbundenen Kanal.	ChannelSet
		setCredentials(credentials:String, agent:MessageAgent, charset:String = null):void Speichert die Benutzerdaten und übergibt sie zu den verbundenen Kanälen.	ChannelSet
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Legt die Verfügbarkeit einer dynamischen Eigenschaft für Schleifenoperationen fest.	Object
		toLocaleString():String Gibt die Stringdarstellung dieses Objekts zurück, formatiert entsprechend den Konventionen des Gebietsschemas.	Object
		toString():String [override] Gibt einen String zurück, der die IDs der Kanäle im ChannelSet enthält.	ChannelSet
		valueOf():Object Gibt den Grundwert des angegebenen Objekts zurück.	Object
		willTrigger(type:String):Boolean Überprüft, ob bei diesem EventDispatcher-Objekt oder bei einem seiner Vorgänger ein Ereignis-Listener für einen bestimmten Ereignistyp registriert ist.	EventDispatcher

Geschützte Methoden

	Methode		Definiert von
		messageHandler(event:MessageEvent):void Löst Meldungsereignisse von dem derzeit verbundenen Kanal erneut aus.	ChannelSet

Ereignisse

Klicken Sie, um weitere Informationen zu Ereignissen zu erhalten.

Vererbte Ereignisse ausblenden

Vererbte Ereignisse anzeigen

	Übersicht	Definiert von
activate	[broadcast event] Wird ausgelöst, wenn Flash Player oder eine AIR-Anwendung den Betriebssystemfokus erhält und aktiv wird.	EventDispatcher
channelConnect	Ausgelöst, nachdem ein Kanal im ChannelSet eine Verbindung zum zugehörigen Endpunkt hergestellt hat.	ChannelSet
channelDisconnect	Ausgelöst, nachdem ein Kanal im ChannelSet die Verbindung vom zugehörigen Endpunkt aufgehoben hat.	ChannelSet
channelFault	Ausgelöst, nachdem ein Kanal im ChannelSet fehlgeschlagen ist.	ChannelSet
deactivate	[broadcast event] Wird ausgelöst, wenn Flash Player- oder die AIR-Anwendung den Fokus verliert und inaktiv wird.	EventDispatcher
fault	Das Fehlerereignis wird ausgelöst, wenn ein Aufruf zur Anmeldung oder Abmeldung fehlschlägt.	ChannelSet
propertyChange	Ausgelöst, wenn eine Eigenschaft des ChannelSet sich ändert.	ChannelSet
result	Das Ergebnisereignis wird ausgelöst, wenn ein Aufruf zur Anmeldung oder Abmeldung erfolgreich zurückgegeben wird.	ChannelSet

Eigenschaftendetails

connected

Eigenschaft

connected:Boolean [schreibgeschützt]

Gibt an, ob der ChannelSet verbunden ist.

Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das propertyChange -Ereignis ausgelöst.

Implementierung
public function get connected():Boolean

heartbeatInterval

Eigenschaft

heartbeatInterval:int

Die Anzahl von Millisekunden zwischen Heartbeats, die an den Remote-Host gesendet werden, während dieser ChannelSet aktiv verbunden ist, aber inaktiv ist. Alle ausgehenden Meldungen verzögern Heartbeats vorübergehend. Dabei vergeht diese Anzahl von Millisekunden nach der letzten gesendeten Meldung und vor der Ausgabe des nächsten Heartbeat.

Diese Eigenschaft ist hilfreich für Anwendungen, die eine Verbindung zu einem Remote-Host herstellen, um Aktualisierungen im Push-Verfahren zu erhalten ( also nicht, um Meldungen aktiv zu senden), und dabei auch dann über die Unterbrechung der Verbindung benachrichtigt werden möchten, wenn durch die Netzwerkebene eine derartige Benachrichtigung nicht zur Verfügung gestellt wird. Durch die Ausgabe von regelmäßigen Heartbeats kann der Client die Netzwerkebene zwingen, eine Zeitüberschreitung zu melden, wenn die zugrunde liegende Verbindung ohne Benachrichtigung unterbrochen wurde und die Anwendung ordnungsgemäß auf die Trennung reagieren kann.

Durch einen nicht positiven Wert werden Heartbeats an den Remote-Host deaktiviert. Der Standardwert ist 0. Dies bedeutet, dass Heartbeats deaktiviert sind. Wenn die Anwendung diesen Wert definiert, ist ein längeres vor einem kürzeren Intervall vorzuziehen, um den Remote-Host nicht unnötig zu belasten. Beispielsweise verwenden Keep-Alives mit TCP-Socket auf niedriger Ebene standardmäßig ein Intervall von zwei Stunden. Dieses Intervall ist länger als in den meisten Anwendungen, die Heartbeats aktivieren, verwendet. Das Beispiel macht jedoch deutlich, weshalb ein längeres Intervall zu bevorzugen ist.

Wenn der derzeit verbundene zugrundeliegende Kanal Abfrageanforderungen an den Remote-Host sendet, werden Heartbeats unterdrückt, da die regelmäßigen Abfrageanforderungen diese Funktion effizient übernehmen.

Implementierung
public function get heartbeatInterval():int
public function set heartbeatInterval(value:int):void

Konstruktordetails

Methodendetails

logout

()

Methode

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

Meldet den ChannelSet vom Server ab. Im Gegensatz zu anderen Vorgängen auf Kanälen und im ChannelSet, gibt dieser Vorgang ein AsyncToken zurück, zu dem der Client-Code einen Responder hinzufügen kann, um die erfolgreiche oder fehlerhafte Durchführung direkt zu verarbeiten. Wenn eine erfolgreiche Abmeldung durchgeführt wurde, werden die für automatische Neuverbindungen gegebenenfalls zwischengespeicherten Benutzerdaten für den ChannelSet und die zugehörigen Kanäle gelöscht und deren authentifizierter Status wird auf „false“ gesetzt. Wenn bei Aufruf dieser Methode der ChannelSet nicht mit dem Server verbunden ist, wird ein Verbindungsversuch ausgelöst, der bei erfolgreicher Durchführung einen Abmeldebefehl an den Server sendet.

Das MessageAgent-Argument ist vorhanden, um älteres Abmeldeverhalten zu unterstützen, und Client-Code, der diese Methode aufruft, sollte keinen MessageAgent-Verweis übergeben. Es wird nur die logout()-Methode aufgerufen, ohne dass Argumente übergeben werden.

Diese Methode wird ebenfalls von den Dienstkomponenten der zugehörigen logout()-Methoden aufgerufen. Diese Komponenten übergeben einen MessageAgent-Verweis auf diese Methode, wenn sie sich abmelden. Durch das Auftreten dieses Arguments wird die Ausführung des älteren Abmeldeverhaltens ausgelöst. Dieses Verhalten unterscheidet sich von dem oben beschriebenen neuen Verhalten. Älteres Verhalten sendet nur eine Abmeldeanforderung an den Server, wenn der Client verbunden ist und Authentifizierung aufweist. Wenn diese Bedingungen nicht erfüllt sind, wird durch das ältere Verhalten dieser Methode nur für automatische Neuverbindungen gegebenenfalls zwischengespeicherte Benutzerdaten gelöscht.

Parameter

agent:MessageAgent (default = null) — Älteres Argument. Der MessageAgent startet die Abmeldung.

Rückgabewerte

mx.rpc:AsyncToken — Gibt ein Token zurück, zu dem der Client-Code einen Responder hinzufügen kann, um die erfolgreiche oder fehlerhafte Durchführung direkt zu verarbeiten.

Auslöser

IllegalOperationError — Im Falle, dass ein Anmelde- oder Abmeldevorgang derzeit ausgeführt wird.

messageHandler

()

Methode

protected function messageHandler(event:MessageEvent):void

Löst Meldungsereignisse von dem derzeit verbundenen Kanal erneut aus.

Parameter

event:MessageEvent — Das MessageEvent vom Kanal.

Ereignisdetails

Rechtliche Hinweise | Onlinedatenschutzerklärung

Eigenschaft	Wert
`bubbles`	false
`cancelable`	false
`channel`	Der Kanal, durch den dieses Ereignis generiert wurde.
`currentTarget`	Das Objekt, das den Ereignis-Listener definiert, der das Ereignis übernimmt. Wenn Sie beispielsweise `myButton.addEventListener()` zur Registrierung eines Ereignis-Listeners verwenden, weist `currentTarget` den Wert „myButton“ auf.
`target`	Das Objekt, von dem das Ereignis ausgelöst wurde. Dies ist nicht immer das Objekt, das auf das Ereignis wartet. Verwenden Sie die `currentTarget`-Eigenschaft, damit immer auf das Objekt, das auf das Ereignis wartet, zugegriffen wird.
`reconnecting`	Gibt an, ob der Kanal, der dieses Ereignis generiert hat, eine erneute Verbindung erstellt.
`rejected`	Gibt an, ob der Kanal, der dieses Ereignis generiert hat, zurückgewiesen wurde. Dies wäre der Fall, wenn die Verbindung des Kanals aufgrund von Inaktivität aufgehoben ist und keine Ausfallsicherung oder Verbindung zu einem alternativen Kanal versucht werden sollte.

Eigenschaft	Wert
`bubbles`	false
`cancelable`	false
`channel`	Der Kanal, durch den dieses Ereignis generiert wurde.
`currentTarget`	Das Objekt, das den Ereignis-Listener definiert, der das Ereignis übernimmt. Wenn Sie beispielsweise `myButton.addEventListener()` zur Registrierung eines Ereignis-Listeners verwenden, weist `currentTarget` den Wert „myButton“ auf.
`target`	Das Objekt, von dem das Ereignis ausgelöst wurde. Dies ist nicht immer das Objekt, das auf das Ereignis wartet. Verwenden Sie die `currentTarget`-Eigenschaft, damit immer auf das Objekt, das auf das Ereignis wartet, zugegriffen wird.
`reconnecting`	Gibt an, ob der Kanal, der dieses Ereignis generiert hat, eine erneute Verbindung erstellt.
`rejected`	Gibt an, ob der Kanal, der dieses Ereignis generiert hat, zurückgewiesen wurde. Dies wäre der Fall, wenn die Verbindung des Kanals aufgrund von Inaktivität aufgehoben ist und keine Ausfallsicherung oder Verbindung zu einem alternativen Kanal versucht werden sollte.

Eigenschaft	Wert
`bubbles`	false
`cancelable`	false
`channel`	Der Kanal, durch den dieses Ereignis generiert wurde.
`currentTarget`	Das Objekt, das den Ereignis-Listener definiert, der das Ereignis übernimmt. Wenn Sie beispielsweise `myButton.addEventListener()` zur Registrierung eines Ereignis-Listeners verwenden, weist `currentTarget` den Wert „myButton“ auf.
`faultCode`	Stellt zielspezifische Details zum Fehler zur Verfügung.
`faultDetail`	Stellt Zugriff auf den zielspezifischen Grund für den Fehler zur Verfügung.
`faultString`	Stellt Zugriff auf den zugrundeliegenden Grund für den Fehler zur Verfügung, wenn der Fehler nicht durch den Kanal selbst entstanden ist.
`reconnecting`	Gibt an, ob der Kanal, der dieses Ereignis generiert hat, eine erneute Verbindung erstellt.
`rootCause`	Stellt Zugriff auf den zugrundeliegenden Grund für den Fehler zur Verfügung, wenn der Fehler nicht durch den Kanal selbst entstanden ist.
`target`	Das Objekt, von dem das Ereignis ausgelöst wurde. Dies ist nicht immer das Objekt, das auf das Ereignis wartet. Verwenden Sie die `currentTarget`-Eigenschaft, damit immer auf das Objekt, das auf das Ereignis wartet, zugegriffen wird.

Eigenschaft	Wert
`bubbles`	false
`cancelable`	„true“; durch Aufrufen von „preventDefault()“ von der responder.fault-Methode des verknüpften Tokens wird das Auslösen dieses Ereignisses durch den Dienst oder den Vorgang verhindert.
`currentTarget`	Das Objekt, das den Ereignis-Listener definiert, der das Ereignis übernimmt. Wenn Sie beispielsweise `myButton.addEventListener()` zur Registrierung eines Ereignis-Listeners verwenden, weist `currentTarget` den Wert „myButton“ auf.
`fault`	Das Fault-Objekt, das die Details über den Auslöser dieses Ereignisses enthält.
`message`	Die mit diesem Ereignis verknüpfte Meldung.
`target`	Das Objekt, von dem das Ereignis ausgelöst wurde. Dies ist nicht immer das Objekt, das auf das Ereignis wartet. Verwenden Sie die `currentTarget`-Eigenschaft, damit immer auf das Objekt, das auf das Ereignis wartet, zugegriffen wird.
`token`	Das Token, das den Aufruf der Methode darstellt. Wird im asynchronen Abschluss-Token-Muster verwendet.

Eigenschaft	Wert
`bubbles`	Wird vom Konstruktor bestimmt; standardmäßig „false“.
`cancelable`	Wird vom Konstruktor bestimmt; standardmäßig „false“.
`kind`	Art der Änderung; PropertyChangeEventKind.UPDATE oder PropertyChangeEventKind.DELETE.
`oldValue`	Der ursprüngliche Eigenschaftswert.
`newValue`	Der neue Eigenschaftswert, falls vorhanden.
`property`	Die geänderte Eigenschaft.
`source`	Das Objekt mit der geänderten Eigenschaft.
`currentTarget`	Das Objekt, das den Ereignis-Listener definiert, der das Ereignis übernimmt. Wenn Sie beispielsweise `myButton.addEventListener()` zur Registrierung eines Ereignis-Listeners verwenden, weist `currentTarget` den Wert „myButton“ auf.
`target`	Das Objekt, von dem das Ereignis ausgelöst wurde. Dies ist nicht immer das Objekt, das auf das Ereignis wartet. Verwenden Sie die `currentTarget`-Eigenschaft, damit immer auf das Objekt, das auf das Ereignis wartet, zugegriffen wird.

ChannelSet - AS3 BlazeDS LCDS

Paketex

Sprachelemente

Anhänge

Paket 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`) — Die IDs von konfigurierten Kanälen, die von ServerConfig für diesen ChannelSet erhalten wurden. Falls kein Wert vorhanden, müssen Kanäle manuell zum ChannelSet hinzugefügt werden.

	`clusteredWithURLLoadBalancing:Boolean` (default = `false`) — Der Wert „true“, wenn die Kanäle im ChannelSet mithilfe von URL-Lastausgleich zu Clustern zusammengefügt werden.

	`username:String` — Der Benutzername.

	`password:String` — Das Kennwort.

	`charset:String` (default = `null`) — Die zu verwendende Zeichensatzkodierung für die Kodierung der Daten. Der Standardwert ist null, d. h. dass der ältere Zeichensatz ISO Lateinisch-1 unterstützt wird. Der einzige unterstützte Zeichensatz ist „UTF-8“.

	`agent:MessageAgent` — Der MessageAgent, der die Meldung sendet.

	`message:IMessage` — Die zu sendende Meldung.

	`credentials:String` — Die Benutzerdaten für den MessageAgent.

	`agent:MessageAgent` — Der MessageAgent, von dem die Benutzerdaten festgelegt werden.

	`charset:String` (default = `null`) — Die zur Kodierung der Benutzerdaten verwendete Zeichensatzkodierung. Der Standardwert ist leer, dadurch wird die ältere Kodierung ISO-Latin-1 verwendet.