AbstractConsumer

Paket	mx.messaging
Klasse	public class AbstractConsumer
Vererbung	AbstractConsumer MessageAgent EventDispatcher Object
Unterklassen	Consumer, MultiTopicConsumer

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 AbstractConsumer ist die Basisklasse für die Klassen Consumer und MultiTopicConsumer. Sie verwenden diese Klassen, um weitergeleitete Meldungen vom Server zu erhalten.

Öffentliche Eigenschaften

Vererbte öffentliche Eigenschaften ausblenden

Vererbte öffentliche Eigenschaften anzeigen

	Eigenschaft		Definiert von
		authenticated : Boolean [schreibgeschützt] Gibt an, ob dieser MessageAgent eine authentifizierte Verbindung zum Ziel verwendet.	MessageAgent
		channelSet : ChannelSet Stellt Zugriff auf den ChannelSet zur Verfügung, der von dem MessageAgent verwendet wird.	MessageAgent
		clientId : String [schreibgeschützt] Stellt Zugriff auf die Client-ID für den MessageAgent zur Verfügung.	MessageAgent
		connected : Boolean [schreibgeschützt] Gibt an, ob dieser MessageAgent derzeit über den zugehörigen ChannelSet mit dem jeweiligen Ziel verbunden ist.	MessageAgent
		constructor : Object Ein Verweis auf das Klassenobjekt oder die Konstruktorfunktion für eine angegebene Objektinstanz.	Object
		destination : String Stellt Zugriff auf das Ziel für den MessageAgent zur Verfügung.	MessageAgent
		maxFrequency : uint Bestimmt die maximale Anzahl von Meldungen pro Sekunde, die der Verbraucher erhalten möchte.	AbstractConsumer
		requestTimeout : int Gibt Zugriff auf die Zeitüberschreitung der Anforderung für übermittelte Meldungen.	MessageAgent
		resubscribeAttempts : int Die Anzahl der Versuche für erneute Abonnementerstellung durch den Verbraucher, falls das Ziel nicht verfügbar ist oder die Verbindung zum Ziel fehlschlägt.	AbstractConsumer
		resubscribeInterval : int Die Anzahl in Millisekunden zwischen Versuchen zum erneuten Abonnement.	AbstractConsumer
		subscribed : Boolean [schreibgeschützt] Gibt an, ob derzeit ein Abonnement des Verbrauchers besteht.	AbstractConsumer
		timestamp : Number Enthält den Zeitstempel der letzten Meldung, die dieser Verbraucher erhalten hat.	AbstractConsumer

Geschützte Eigenschaften

	Eigenschaft		Definiert von
		_shouldBeSubscribed : Boolean Flag, der angibt, ob für diesen Verbraucher ein Abonnement erstellt werden soll.	AbstractConsumer

Öffentliche Methoden

Vererbte öffentliche Methoden ausblenden

Vererbte öffentliche Methoden anzeigen

	Methode		Definiert von
		AbstractConsumer() Erstellt einen Verbraucher.	AbstractConsumer
		acknowledge(ackMsg:AcknowledgeMessage, msg:IMessage):void Aufgerufen von MessageResponder nach Erhalt eines Ergebnisses für eine gesendete Meldung.	MessageAgent
		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 ein CONNECT ChannelEvent.	MessageAgent
		channelDisconnectHandler(event:ChannelEvent):void Verarbeitet ein DISCONNECT ChannelEvent.	MessageAgent
		channelFaultHandler(event:ChannelFaultEvent):void Verarbeitet ein ChannelFaultEvent.	MessageAgent
		disconnect():void [override] Trennt den Verbraucher von dem Remote-Ziel.	AbstractConsumer
		dispatchEvent(event:Event):Boolean Sendet ein Ereignis in den Ereignisablauf.	EventDispatcher
		fault(errMsg:ErrorMessage, msg:IMessage):void Aufgerufen von einem MessageResponder nach Erhalt eines Fehlers für eine gesendete Meldung.	MessageAgent
		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
		hasPendingRequestForMessage(msg:IMessage):Boolean Gibt true zurück, wenn anstehende Anforderungen für die übergebene Meldung vorliegen.	MessageAgent
		initialized(document:Object, id:String):void Wird aufgerufen, nachdem das implementierende Objekt erstellt wurde und alle für das Tag angegebenen Eigenschaften zugewiesen wurden.	MessageAgent
		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
		logout():void Meldet MessageAgent vom Remote-Ziel ab.	MessageAgent
		propertyIsEnumerable(name:String):Boolean Gibt an, ob die angegebene Eigenschaft vorhanden ist und durchlaufen werden kann.	Object
		receive(timestamp:Number = 0):void Fordert alle Meldungen an, die sich für diesen Verbraucher am Server in der Warteschlange befinden.	AbstractConsumer
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Entfernt einen Listener aus dem EventDispatcher-Objekt.	EventDispatcher
		setCredentials(username:String, password:String, charset:String = null):void Definieren Sie die Benutzerdaten, die der MessageAgent zur Authentifizierung an den Zielen verwendet.	MessageAgent
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Legt die Verfügbarkeit einer dynamischen Eigenschaft für Schleifenoperationen fest.	Object
		setRemoteCredentials(username:String, password:String, charset:String = null):void Definiert die Remote-Benutzerdaten, die an das Remote-Ziel zur Authentifizierung von sekundären Systemen übergeben werden.	MessageAgent
		subscribe(clientId:String = null):void Erstellt das Abonnement am Remote-Ziel.	AbstractConsumer
		toLocaleString():String Gibt die Stringdarstellung dieses Objekts zurück, formatiert entsprechend den Konventionen des Gebietsschemas.	Object
		toString():String Gibt das angegebene Objekt als String zurück.	Object
		unsubscribe(preserveDurable:Boolean = false):void Hebt das Abonnement am Remote-Ziel auf.	AbstractConsumer
		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

Vererbte geschützte Methoden ausblenden

Vererbte geschützte Methoden anzeigen

	Methode		Definiert von
		buildSubscribeMessage():CommandMessage Gibt eine Meldung zum Abonnement zurück.	AbstractConsumer
		buildUnsubscribeMessage(preserveDurable:Boolean):CommandMessage Gibt eine Meldung zur Abonnementaufhebung zurück.	AbstractConsumer
		handleAuthenticationFault(errMsg:ErrorMessage, msg:IMessage):void Verarbeitet den Authentifizierungsfehler auf dem Server.	MessageAgent
		initChannelSet(message:IMessage):void Wird zum automatischen Initialisieren der Eigenschaft „channelSet“ für den MessageAgent verwendet, bevor erstmalig eine Verbindung hergestellt wird.	MessageAgent
		internalSend(message:IMessage, waitForClientId:Boolean = true):void Sendet mithilfe des ChannelSet des Agenten eine Meldung von dem MessageAgent zum Ziel.	MessageAgent
		reAuthorize(msg:IMessage):void Diese Funktion muss von Unterklassen überschrieben werden, um eine erneute Authentifizierung aufgrund der Zeitüberschreitung der Serversitzung zu implementieren.	MessageAgent

Ereignisse

Klicken Sie, um weitere Informationen zu Ereignissen zu erhalten.

Vererbte Ereignisse ausblenden

Vererbte Ereignisse anzeigen

	Übersicht	Definiert von
acknowledge	Ausgelöst, wenn eine Bestätigungsmeldung für eine gesendete Meldung erhalten wird.	MessageAgent
activate	[broadcast event] Wird ausgelöst, wenn Flash Player oder eine AIR-Anwendung den Betriebssystemfokus erhält und aktiv wird.	EventDispatcher
channelConnect	Ausgelöst, wenn der zugrundeliegende Kanal, der von dem MessageAgent verwendet wird, eine Verbindung herstellt.	MessageAgent
channelDisconnect	Ausgelöst, wenn die Verbindung beim zugrundeliegende Kanal, der von dem MessageAgent verwendet wird, getrennt wird.	MessageAgent
channelFault	Ausgelöst, wenn beim zugrundeliegende Kanal, der von dem MessageAgent verwendet wird, Fehler auftreten.	MessageAgent
deactivate	[broadcast event] Wird ausgelöst, wenn Flash Player- oder die AIR-Anwendung den Fokus verliert und inaktiv wird.	EventDispatcher
fault	Ausgelöst, wenn ein Meldungsfehler auftritt.	MessageAgent
message	Ausgelöst, wenn eine Meldung vom Verbraucher erhalten wird.	AbstractConsumer
propertyChange	Ausgelöst, wenn die Eigenschaft „connected“ von dem MessageAgent geändert wird.	MessageAgent

Eigenschaftendetails

_shouldBeSubscribed

Eigenschaft

protected var _shouldBeSubscribed:Boolean

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

Flag, der angibt, ob für diesen Verbraucher ein Abonnement erstellt werden soll.

maxFrequency

Eigenschaft

maxFrequency:uint

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

Bestimmt die maximale Anzahl von Meldungen pro Sekunde, die der Verbraucher erhalten möchte. Ein Server, der diesen Wert interpretieren kann, verwendet ihn als Eingabe und bestimmt, wie schnell die Meldungen an den Verbraucher gesendet werden. Der Standardwert ist 0. Das heißt, der Verbraucher verfügt über keine Voreinstellung für die Meldungsgeschwindigkeit. Diese Eigenschaft sollte vor der Abonnementerstellung des Verbrauchers festgelegt werden. Alle Änderungen nach der Abonnementerstellung des Verbrauchers werden erst dann wirksam, nachdem der Verbraucher das Abonnement aufgehoben hat und ein erneutes Abonnement erstellt hat.

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

resubscribeAttempts

Eigenschaft

resubscribeAttempts:int

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

Die Anzahl der Versuche für erneute Abonnementerstellung durch den Verbraucher, falls das Ziel nicht verfügbar ist oder die Verbindung zum Ziel fehlschlägt. Ein Wert von -1 ermöglicht eine unendliche Anzahl von Versuchen. Ein Wert von null deaktiviert Versuche zur erneuten Abonnementerstellung.

Die Versuche zur erneuten Abonnementerstellung werden gemäß des Intervallwerts für erneute Abonnements konstant durchgeführt. Wenn bei einem erneuten Abonnementherstellungsversuch der zugrundeliegende Kanal für den Verbraucher nicht verbunden ist oder eine Verbindungsherstellung versucht, beginnt der Kanal einen Verbindungsversuch. Nachfolgende Versuche zu erneutem Abonnement vom Verbraucher, die während des zugrundeliegenden Verbindungsversuchs vom Kanal durchgeführt werden, werden effektiv ignoriert, bis der ausstehende Verbindungsversuch des Kanals erfolgreich ist oder fehlschlägt.

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

Verwandte API-Elemente

mx.messaging.Consumer.resubscribeInterval

resubscribeInterval

Eigenschaft

resubscribeInterval:int

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

Die Anzahl in Millisekunden zwischen Versuchen zum erneuten Abonnement. Wenn ein Verbraucher keine Bestätigung für eine Abonnementanforderung erhält, wartet er die angegebene Anzahl von Millisekunden, bevor er eine erneute Abonnementerstellung versucht. Durch Festlegen des Werts auf null werden erneute Abonnementerstellungen deaktiviert.

Versuche zur erneuten Abonnementerstellung werden gemäß dieses Werts konstant durchgeführt. Wenn bei einem erneuten Abonnementherstellungsversuch der zugrundeliegende Kanal für den Verbraucher nicht verbunden ist oder eine Verbindungsherstellung versucht, beginnt der Kanal einen Verbindungsversuch. Nachfolgende Versuche zu erneutem Abonnement vom Verbraucher, die während des zugrundeliegenden Verbindungsversuchs vom Kanal durchgeführt werden, werden effektiv ignoriert, bis der ausstehende Verbindungsversuch des Kanals erfolgreich ist oder fehlschlägt.

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

Auslöser

ArgumentError — Im Falle, dass der zugewiesene Wert negativ ist.

Verwandte API-Elemente

mx.messaging.Consumer.resubscribeInterval

subscribed

Eigenschaft

subscribed:Boolean [schreibgeschützt]

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

Gibt an, ob derzeit ein Abonnement des Verbrauchers besteht. Das Ereignis propertyChange wird ausgelöst, wenn diese Eigenschaft sich ändert.

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

timestamp

Eigenschaft

timestamp:Number

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

Enthält den Zeitstempel der letzten Meldung, die dieser Verbraucher erhalten hat. Dieser Wert wird durch den Aufruf receive() an das Ziel übergeben, um die Zustellung von Meldungen für den Verbraucher ab dem Zeitstempel anzufordern. Alle Meldungen mit einem Zeitstempelwert, der größer als der Wert timestamp ist, werden während eines Abfragevorgangs zurückgegeben. Durch Festlegen dieses Werts auf -1 werden alle zwischengespeicherten Meldungen vom Ziel abgerufen.

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

Konstruktordetails

()

Konstruktor

public function AbstractConsumer()

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

Erstellt einen Verbraucher.

Beispiel ( Verwendung dieses Beispiels )

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

Methodendetails

buildSubscribeMessage

()

Methode

protected function buildSubscribeMessage():CommandMessage

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

Gibt eine Meldung zum Abonnement zurück. Diese Methode sollte von Unterklassen überschrieben werden, wenn sie benutzerdefinierte Abonnementmeldungen benötigen.

Rückgabewerte

CommandMessage — Die Abonnement-CommandMessage.

buildUnsubscribeMessage

()

Methode

protected function buildUnsubscribeMessage(preserveDurable:Boolean):CommandMessage

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

Gibt eine Meldung zur Abonnementaufhebung zurück. Diese Methode sollte von Unterklassen überschrieben werden, wenn sie benutzerdefinierte Meldungen zur Abonnementaufhebung benötigen.

Parameter

preserveDurable:Boolean — Beim Wert „true“ werden permanente JMS-Abonnements nicht zerstört. Dadurch können Verbraucher zu einem späteren Zeitpunkt erneut abonnieren und fehlende Meldungen empfangen.

Rückgabewerte

CommandMessage — Die Abonnementaufhebungs-CommandMessage.

disconnect

()

Methode

override public function disconnect():void

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

Trennt den Verbraucher von dem Remote-Ziel. Diese Methode sollte auf einem Verbraucher aufgerufen werden, der nach der Abonnementaufhebung nicht mehr von einer Anwendung benötigt wird. Diese Methode wartet nicht auf den Abschluss von ausstehenden Netzwerkvorgängen und sendet keine Meldung zur Abonnementaufhebung an den Server. Nach dem Aufrufen von disconnect() meldet der Consumer, dass er sich in einem getrennten, nicht abonnierten Zustand befindet, da er keine weiteren Meldungen erhält, bis er erneut eine Verbindung und ein Abonnement erstellt. Durch die Trennung der Verbindung werden automatische Versuche zur erneuten Abonnementerstellung gestoppt, falls diese ausgeführt werden.

receive

()

Methode

public function receive(timestamp:Number = 0):void

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

Fordert alle Meldungen an, die sich für diesen Verbraucher am Server in der Warteschlange befinden. Diese Methode sollte nur für Verbraucher verwendet werden, die ein Abonnement über Kanäle durchführen, die keine Echtzeitverarbeitung verwenden und keine Abfragen durchführen. Diese Methode wird als Leerbefehl betrachtet, wenn der Verbraucher über kein Abonnement verfügt.

Parameter

timestamp:Number (default = 0) — Dieses Argument ist veraltet und wird ignoriert.

()

Methode

public function subscribe(clientId:String = null):void

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

Erstellt das Abonnement am Remote-Ziel.

Parameter

clientId:String (default = null) — Die Client-ID für das Abonnement. Verwenden Sie einen Leerwert für nicht permanente Verbraucher. Wenn das Abonnement permanent ist, muss bei jeder Abonnementerstellung des Verbrauchers ein einheitlicher Wert zur Verfügung gestellt werden, um eine Neuverbindung zum richtigen permanenten Abonnement am Remote-Ziel herzustellen.

Auslöser

InvalidDestinationError — In dem Falle, dass kein Ziel festgelegt ist.

unsubscribe

()

Methode

public function unsubscribe(preserveDurable:Boolean = false):void

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

Hebt das Abonnement am Remote-Ziel auf. Im Falle von permanenten JMS-Abonnements wird dadurch das permanente Abonnement am JMS-Server zerstört.

Parameter

preserveDurable:Boolean (default = false) — Beim Wert „true“ werden permanente JMS-Abonnements nicht zerstört. Dadurch können Verbraucher zu einem späteren Zeitpunkt erneut abonnieren und fehlende Meldungen empfangen.

Ereignisdetails

message

Ereignis

Ereignisobjekttyp: mx.messaging.events.MessageEvent
Eigenschaft MessageEvent.type = mx.messaging.events.MessageEvent.MESSAGE

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

Ausgelöst, wenn eine Meldung vom Verbraucher erhalten wird.

Der Ereignistyp MESSAGE. Wird nach Erhalt einer Meldung ausgelöst.

Der Wert dieser Konstante ist "message".

Die Eigenschaften des Ereignisobjekts haben die folgenden Werte:

Eigenschaft	Wert
`bubbles`	false
`cancelable`	false
`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.
`message`	Die Meldung, die mit diesem Ereignis verknüpft 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.

Rechtliche Hinweise | Onlinedatenschutzerklärung

AbstractConsumer - AS3 BlazeDS LCDS

Klassen x

_shouldBeSubscribed

maxFrequency

resubscribeAttempts

resubscribeInterval

subscribed

timestamp