Isom.Sys.Events.PeriodicTimer

 ISOM/L-Bibliothek für Serviceautoren: <br />Isom.Sys.Events.PeriodicTimer

ISOM/L-Bibliothek
für Serviceautoren

Version 9.10.1.0 vom 25 November 2013

Namensraum Isom.Sys.Events.PeriodicTimer

Beschreibung

Isom.Sys.Events.PeriodicTimer ist das Fachobjekt für periodisch auslösende Zeitgeber.



Funktionen

Isom.Sys.Events.PeriodicTimer.CreatePeriodicTimer

Erzeugt einen benannten Zeitgeber, der periodisch auslöst, wenn eine vorgegebene Zeitspanne verstrichen ist.

Isom.Sys.Events.PeriodicTimer Isom.Sys.Events.PeriodicTimer.CreatePeriodicTimer  ( Isom.Base.String  name,
Isom.Base.Number  delay,
Isom.Base.String  callback  )

Erzeugt einen benannten Zeitgeber, der periodisch auslöst, wenn eine vorgegebene Zeitspanne verstrichen ist.

Dann wird die angegebene Rückruffunktion asynchron aufgerufen.

Ein Zeitgeber, der mittels CreatePeriodicTimer(String,Number,String) erzeugt wurde, ist inaktiv. Zum Start der Zeitmessung muss Enable() aufgerufen werden.

Parameter:
name  Legt eine eindeutige Bezeichnung des Zeitgebers fest. Anhand dieser Bezeichnung kann der Zeitgeber mit der Funktion FindPeriodicTimer(String) abgerufen werden.
delay  Dauer bis zum Auslösen des Zeitgebers in Millisekunden
callback  Name der Rückruffunktion, die aufgerufen wird, wenn die angegebene Zeitspanne verstrichen ist. Die Funktion muss im aktuellen Namensraum oder im Namensraum des OEM vorhanden sein. Ihre Signatur muss lauten: Boolean (TimerInfo)
Rückgabe:
Die Instanz des Zeitgebers.
Ausnahmebehandlung:
Wenn name einen bereits existenten periodisch auslösenden Zeitgeber beschreibt
Wenn die angegebene Zeitspanne negativ ist
    // Beispielcode zur Demonstration von CreateTimer(String,Number,String), 
    // Enable(), Disable() 
    using Isom.Base.*; 
    using Isom.Sys.Events.*; 
    using Isom.Context.*; 

    Boolean ContextIdent() 
    { 
      PeriodicTimer envCheckTimer = PeriodicTimer.CreatePeriodicTimer("environmentCheckTimer", 5000, "OnEnvironmentCheckTimer"); 
      envCheckTimer.Enable(); 
      ... 
    } 

    Boolean OnEnvironmentCheckTimer(TimerInfo info) 
    { 
      // Prüfung des VCI-Zustandes 
    } 

Isom.Sys.Events.PeriodicTimer.Disable

Deaktiviert Rückrufe infolge des Zeitgebers.

objectbound Isom.Base.Boolean Isom.Sys.Events.PeriodicTimer.Disable  (  ) 

Deaktiviert Rückrufe infolge des Zeitgebers.

Rückgabe:
'true', falls der Rückrufempfänger erfolgreich deaktiviert wurde.
Ausnahmebehandlung:
wenn der Zeitgeber bereits mit Dispose() freigegeben wurde
Isom.Sys.Events.PeriodicTimer.Dispose

Gibt ein Zeitgeberobjekt frei.

objectbound Isom.Base.Boolean Isom.Sys.Events.PeriodicTimer.Dispose  (  ) 

Gibt ein Zeitgeberobjekt frei.

Der Zeitgeber ist nach diesem Aufruf nicht mehr nutzbar und wird nicht mehr durch FindPeriodicTimer(String) gefunden.

Rückgabe:
'true'
Ausnahmebehandlung:
wenn der Zeitgeber bereits mit Dispose() freigegeben wurde
Isom.Sys.Events.PeriodicTimer.Enable

Aktiviert den Zeitgeber und den Rückrufempfänger dieses Zeitgebers.

objectbound Isom.Base.Boolean Isom.Sys.Events.PeriodicTimer.Enable  (  ) 

Aktiviert den Zeitgeber und den Rückrufempfänger dieses Zeitgebers.

Die Zeitmessung beginnt, wenn Enable() aufgerufen wird, während der Zeitgeber deaktiviert ist. Die Zeitmessung kann nicht durch eine Folge von Disable() und Enable() pausiert werden.

Rückgabe:
'true', falls der Zeitgeber und der Rückrufempfänger erfolgreich aktiviert wurden
Ausnahmebehandlung:
wenn der Zeitgeber bereits mit Dispose() freigegeben wurde
Isom.Sys.Events.PeriodicTimer.FindPeriodicTimer

Sucht einen bereits durch PeriodicTimer.CreatePeriodicTimer(String,Number,String) erzeugten und benannten Zeitgeber.

Isom.Sys.Events.PeriodicTimer Isom.Sys.Events.PeriodicTimer.FindPeriodicTimer  ( Isom.Base.String  name  ) 

Sucht einen bereits durch PeriodicTimer.CreatePeriodicTimer(String,Number,String) erzeugten und benannten Zeitgeber.

Parameter:
name  Bezeichnung des Zeitgebers.
Rückgabe:
Den mit name bezeichneten Zeitgeber.
Ausnahmebehandlung:
Wenn name keinen bereits existierenden benannten Zeitgeber bezeichnet.
    // Beispielcode zur Verwendung von FindTimer(String); siehe dazu auch das 
    // Codebeispiel zu CreatePeriodicTimer(String,Number,String) 
    using Isom.Base.*; 
    using Isom.Sys.Events.*; 
    ... 
    Timer envCheckTimer = Timer.FindPerodicTimer("environmentCheckTimer"); 

Isom.Sys.Events.PeriodicTimer.IsVoid

Bestimmt, ob es sich um das Void-Objekt handelt.

objectbound Isom.Base.Boolean Isom.Sys.Events.PeriodicTimer.IsVoid  (  ) 

Bestimmt, ob es sich um das Void-Objekt handelt.

Rückgabe:
'true', falls dies das Void-Objekt ist, 'false' sonst.
Isom.Sys.Events.PeriodicTimer.Void

Erzeugt ein ungültiges Objekt.

Isom.Sys.Events.PeriodicTimer Isom.Sys.Events.PeriodicTimer.Void  (  ) 

Erzeugt ein ungültiges Objekt.

Die Funktion kann in Fehlerfällen verwendet werden, um z.B. einen ungültigen Funktionsrückgabewert zu erzeugen.

Rückgabe:
Ungültiges Objekt.

Version 9.10.1.0 vom 25 November 2013