ActionScript® 3.0 Referenzhandbuch für die Adobe® Flash®-Plattform
Home  |  Liste der Pakete und Klassen ausblenden |  Pakete  |  Klassen  |  Neue Funktionen  |  Stichwortverzeichnis  |  Anhänge  |  Warum auf Englisch?
Filter: Daten werden vom Server abgerufen...
Daten werden vom Server abgerufen...
air.net 

ServiceMonitor  - AS3

Paketair.net
Klassepublic dynamic class ServiceMonitor
VererbungServiceMonitor Inheritance EventDispatcher Inheritance Object
Unterklassen SocketMonitor, URLMonitor

Laufzeitversionen: AIR 1.0

Die ServiceMonitor-Klasse implementiert das Framework zur Überwachung des Status und der Verfügbarkeit von Netzwerkdiensten. Die ServiceMonitor-Klasse dient als Basisklasse für alle anderen Service Monitors.

Diese Klasse ist in der Datei „aircore.swc“ enthalten. Adobe® Flash™; Builder™ lädt diese Klasse automatisch, wenn Sie ein Projekt für Adobe® AIR™ erstellen. Das Adobe® Flex™ SDK enthält ebenfalls die Datei „aircore.swc“, die Sie beim Kompilieren der Anwendung einschließen sollten, wenn Sie das Flex SDK verwenden.

In Adobe® Flash® CS3 Professional ist diese Klasse in der ServiceMonitorShim.sw-Datei enthalten. Um Klassen im air.net-Paket zu verwenden, müssen Sie zunächst die ServiceMonitorShim-Komponente aus dem Bedienfeld „Komponenten“ in die Bibliothek ziehen und dann die folgende import-Anweisung in den ActionScript 3.0-Code einfügen:

import air.net.*;

So verwenden Sie das air.net-Paket in Adobe® Flash® Professional (CS4 oder höher):

  1. Wählen Sie „Datei“ > „Einstellungen für Veröffentlichungen“.
  2. Klicken Sie im Flash-Bedienfeld auf die Schaltfläche „Einstellungen“ für ActionScript 3.0. Wählen Sie „Bibliothekspfad“.
  3. Klicken Sie auf die Schaltfläche „Zur SWC-Datei navigieren“. Navigieren Sie zur Datei „Adobe Flash CSn/AIKn.n/frameworks/libs/air/aircore.swc“ im Adobe Flash Professional-Installationsordner.
  4. Klicken Sie auf „OK“.
  5. Fügen Sie dem ActionScript 3.0-Code folgende import-Anweisung hinzu: import air.net.*;



Öffentliche Eigenschaften
 EigenschaftDefiniert von
      available : Boolean
Gibt an, ob der Dienst zurzeit als „verfügbar“ behandelt wird. Der ursprüngliche Wert ist „false“, bis die Eigenschaft durch eine Statusüberprüfung als „true“ festgelegt wird oder die Eigenschaft ausdrücklich als „true“ initialisiert wird. Normalerweise wird diese Eigenschaft durch eine checkStatus()-Implementierung in einer Subklasse oder durch einen Specializer gesetzt; wenn die Anwendung jedoch über unabhängige Informationen über die Verfügbarkeit eines Services verfügt (zum Beispiel weil gerade eine Anforderung erfolgreich war oder fehlgeschlagen ist), kann die Eigenschaft ausdrücklich gesetzt werden.
ServiceMonitor
 Inheritedconstructor : Object
Ein Verweis auf das Klassenobjekt oder die Konstruktorfunktion für eine angegebene Objektinstanz.
Object
      lastStatusUpdate : Date
[schreibgeschützt] Der Zeitpunkt der letzten Statusaktualisierung.
ServiceMonitor
      pollInterval : Number
Das Intervall zum Pollen des Servers in Millisekunden.
ServiceMonitor
      running : Boolean
[schreibgeschützt] Ob die Überwachung gestartet wurde.
ServiceMonitor
Öffentliche Methoden
 MethodeDefiniert von
  
    ServiceMonitor()
Erstellt ein ServiceMonitor-Objekt.
ServiceMonitor
 Inherited
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
 Inherited
Sendet ein Ereignis in den Ereignisablauf.
EventDispatcher
 Inherited
Überprüft, ob das EventDispatcher-Objekt Listener für einen bestimmten Ereignistyp registriert hat.
EventDispatcher
 Inherited
Gibt an, ob für ein Objekt eine bestimmte Eigenschaft definiert wurde.
Object
 Inherited
Gibt an, ob eine Instanz der Object-Klasse in der Prototypkette des Objekts vorhanden ist, das als Parameter angegeben wurde.
Object
  
    makeJavascriptSubclass(constructorFunction:Object):void
[statisch] Fügt dem Prototyp einer JavaScript-Konstrukturfunktion öffentliche ServiceMonitor-Methoden hinzu.
ServiceMonitor
 Inherited
Gibt an, ob die angegebene Eigenschaft vorhanden ist und durchlaufen werden kann.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Entfernt einen Listener aus dem EventDispatcher-Objekt.
EventDispatcher
 Inherited
Legt die Verfügbarkeit einer dynamischen Eigenschaft für Schleifenoperationen fest.
Object
  
    start():void
Startet die Dienstüberwachung.
ServiceMonitor
  
    stop():void
Beendet die Überwachung des Dienstes.
ServiceMonitor
 Inherited
Gibt die Stringdarstellung dieses Objekts zurück, formatiert entsprechend den Konventionen des Gebietsschemas.
Object
  
    toString():String
[override] Gibt das angegebene Objekt als String zurück.
ServiceMonitor
 Inherited
Gibt den Grundwert des angegebenen Objekts zurück.
Object
 Inherited
Ü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
 MethodeDefiniert von
  
    checkStatus():void
Überprüft den Dienststatus.
ServiceMonitor
Ereignisse
 Ereignis Übersicht Definiert von
 Inherited[broadcast event] Wird ausgelöst, wenn Flash Player oder eine AIR-Anwendung den Betriebssystemfokus erhält und aktiv wird.EventDispatcher
 Inherited[broadcast event] Wird ausgelöst, wenn Flash Player- oder die AIR-Anwendung den Fokus verliert und inaktiv wird.EventDispatcher
  
    status
Zeigt an, dass sich der Dienststatus geändert hat.ServiceMonitor
Eigenschaftendetails
    

available

Eigenschaft
available:Boolean

Laufzeitversionen: AIR 1.0

Gibt an, ob der Dienst zurzeit als „verfügbar“ behandelt wird.

Der ursprüngliche Wert ist false, bis die Eigenschaft durch eine Statusüberprüfung als true festgelegt wird oder die Eigenschaft ausdrücklich als true initialisiert wird.

Normalerweise wird diese Eigenschaft durch eine checkStatus()-Implementierung in einer Subklasse oder durch einen Specializer gesetzt; wenn die Anwendung jedoch über unabhängige Informationen über die Verfügbarkeit eines Services verfügt (zum Beispiel weil gerade eine Anforderung erfolgreich war oder fehlgeschlagen ist), kann die Eigenschaft ausdrücklich gesetzt werden.



Implementierung
    public function get available():Boolean
    public function set available(value:Boolean):void
    

lastStatusUpdate

Eigenschaft 
lastStatusUpdate:Date  [schreibgeschützt]

Laufzeitversionen: AIR 1.0

Der Zeitpunkt der letzten Statusaktualisierung.



Implementierung
    public function get lastStatusUpdate():Date
    

pollInterval

Eigenschaft 
pollInterval:Number

Laufzeitversionen: AIR 1.0

Das Intervall zum Pollen des Servers in Millisekunden.

Mit dem Wert null wird der Server nicht regelmäßig abgefragt, sondern nur direkt nach dem Aufruf von start() und bei einer Änderung des Netzwerkstatus.

Das ServiceMonitor-Objekt löst nur dann ein status-Ereignis aus, wenn sich der Dienststatus ändert (nicht bei jedem Abfrageintervall). Das Objekt löst auch nach Änderungen der Netzwerkkonnektivität ein status-Ereignis aus (unabhängig vom Abfrageintervall).

Der Standardwert ist 0.



Implementierung
    public function get pollInterval():Number
    public function set pollInterval(value:Number):void
    

running

Eigenschaft 
running:Boolean  [schreibgeschützt]

Laufzeitversionen: AIR 1.0

Ob die Überwachung gestartet wurde.



Implementierung
    public function get running():Boolean
Konstruktordetails
    

ServiceMonitor

()Konstruktor
public function ServiceMonitor()

Laufzeitversionen: AIR 1.0

Erstellt ein ServiceMonitor-Objekt.

Die Klasse weist normalerweise Unterklassen auf, um bestimmte Diensttypen zu überwachen.

Nach dem Erstellen eines ServiceMonitor-Objekts (oder eines Unterklassenobjekts) rufen Sie die start()-Methode auf, um die Überwachung des Dienststatus zu starten.

Wie beim Timer-Objekt sollte der Aufrufer einen Verweis auf das ServiceMonitor-Objekt beibehalten. Andernfalls wird das Objekt zur Laufzeit gelöscht und die Überwachung wird beendet.

Methodendetails

    checkStatus

()Methode
protected function checkStatus():void

Laufzeitversionen: AIR 1.0

Überprüft den Dienststatus.

Eine überschreibende Unterklassenmethode zum Überprüfen des Dienststatus.

Normalerweise initiiert diese Methode einen Netzwerkvorgang, dessen Ausführung oder Fehlschlagen zum Festlegen der available-Eigenschaft führt.

JavaScript-Code kann diese Methode spezialisieren, indem eine checkStatus()-Methode im „specializer“-Objekt definiert wird.

    makeJavascriptSubclass

()Methode 
public static function makeJavascriptSubclass(constructorFunction:Object):void

Laufzeitversionen: AIR 1.0

Fügt dem Prototyp einer JavaScript-Konstrukturfunktion öffentliche ServiceMonitor-Methoden hinzu.

Fügt dem Prototyp der JavaScript-Konstruktorfunktion Funktionen hinzu, die öffentliche ServiceMonitor-Funktionen an das ServiceMonitor-Objekt weiterleiten. Dies entspricht etwa einer normalen JavaScript-Unterklasse der ActionScript-Basisklasse.

Eine JavaScript-Klasse, die einen ServiceMonitor spezialisiert, sieht folgendermaßen aus:

     // JavaScript Constructor function
     function MyHTTPMonitor(url, method)
     {
         // "that" variable makes "this" available in closures below
         var that = this;
         // Required initialization of the service monitor, returns the actual ServiceMonitor object.
         this.monitor = this.initServiceMonitor();
         // Initializes URLStream and event handlers.
         this._urlStream = new air.URLStream();
         this._urlRequest = new air.URLRequest(url);
         if (method)
         {
             this._urlRequest.method = method;
         }
         else
         {
             this._urlRequest.method = "GET";
         }
         function onStatus(event) {
             that.monitor.available = Number(event.status) == 200;
             that._urlStream.close();
         }
         function onError(event)
         {
             that.monitor.available = false;
             that._urlStream.close();
         }
         this._urlStream.addEventListener(air.HTTPStatusEvent.HTTP_RESPONSE_STATUS, onStatus);
         this._urlStream.addEventListener(air.SecurityErrorEvent.SECURITY_ERROR, onError);
         this._urlStream.addEventListener(air.IOErrorEvent.IO_ERROR, onError);
     }
     
     // Augment JavaScript prototype with public methods from ServiceMonitor
     air.ServiceMonitor.makeJavascriptSubclass(MyHTTPMonitor);
     
     // Implement specializer functions, just as you would when subclassing a JavaScript class
     MyHTTPMonitor.prototype.checkStatus = function()
     {
         air.trace('OVERRIDDEN checkStatus!', this);
         this._urlStream.load(this._urlRequest);
     }
     

Verwenden der JavaScript-Klasse:

     var httpMon = new MyHTTPMonitor('http://www.adobe.com')
     

Laden Sie die Dateien AIRAliases.js und aircore.swf mit script-Tags.

Parameter

constructorFunction:Object — Die prototype-Eigenschaft des JavaScript-Objekts. Wenn das als specializer-Objekt verwendete JavaScript-Objekt zum Beispiel mit MyHTTPMonitor benannt ist, übergeben Sie MyHTTPMonitor.prototype als Wert für diesen Parameter.

    start

()Methode 
public function start():void

Laufzeitversionen: AIR 1.0

Startet die Dienstüberwachung.

    stop

()Methode 
public function stop():void

Laufzeitversionen: AIR 1.0

Beendet die Überwachung des Dienstes.

    toString

()Methode 
override public function toString():String

Laufzeitversionen: AIR 1.0

Gibt das angegebene Objekt als String zurück.

Hinweis: Methoden der Object-Klasse werden für den Prototyp des Objekts dynamisch erstellt. Um diese Methode in eine Unterklasse von Object umzudefinieren, sollten Sie nicht das Schlüsselwort override verwenden. So implementiert eine Unterklasse von Object beispielsweise function toString():String anstatt die Basisklasse per „override“ außer Kraft zu setzen.

Rückgabewerte
String — Die Stringdarstellung des Objekts.
Ereignisdetails
    

status

Ereignis
Ereignisobjekttyp: flash.events.StatusEvent
Eigenschaft StatusEvent.type = flash.events.StatusEvent.STATUS

Laufzeitversionen: AIR 1.0

Zeigt an, dass sich der Dienststatus geändert hat.

Der Wert der code-Eigenschaft ist entweder "Service.available" oder "Service.unavailable", es wird jedoch empfohlen, den Wert der ServiceMonitor.available-Eigenschaft zu überprüfen.

Definiert den Wert der Eigenschaft type eines status-Ereignisobjekts.

Dieses Ereignis verfügt über die folgenden Eigenschaften:

EigenschaftWert
bubblesfalse
cancelablefalse. Es gibt kein Standardverhalten, das abgebrochen werden kann.
codeEine Beschreibung des Objektstatus.
currentTargetDas Objekt, welches das Ereignisobjekt aktiv mit einem Ereignis-Listener verarbeitet.
EbeneDie Kategorie der Meldung, z. B. "status", "warning" oder "error".
targetDas Objekt, dessen Status gemeldet wird.




[ X ]Warum auf Englisch?
Inhalt des ActionScript 3.0-Referenzhandbuchs wird in englischer Sprache angezeigt

Nicht alle Teile des ActionScript 3.0-Referenzhandbuchs wurden in alle Sprachen übersetzt. Wenn der Text zu einem Sprachelement nicht übersetzt wurde, wird er auf Englisch angezeigt. Zum Beispiel wurden die Informationen zur ga.controls.HelpBox-Klasse nicht in andere Sprachen übersetzt. In der deutschen Version des Referenzhandbuchs erscheint der Abschnitt zur ga.controls.HelpBox-Klasse deshalb auf Englisch.