 | Worker |
Kapselt den Aufruf einer externen Arbeitsroutine,
die als Reaktion auf eine definierte Änderung des Tree-Zustands
(TreeEvent) als externe Exe ausgeführt wird (fire and forget)
TODO: später eventuell auch als lightweight Dll-Plugin realisieren.
VererbungshierarchieNamensraum: LogicalTaskTree
Assembly: LogicalTaskTree (in LogicalTaskTree.dll) Version: 1.0.0+d75bac576d44afb64cfff79fd3665c8ca1172cbc
SyntaxDer WorkerShell Typ exponiert die folgenden Member.
Konstruktoren| Name | Beschreibung | |
|---|---|---|
 | WorkerShell(String, XElement) | Konstruktor - übernimmt den Pfad zur Worker-Exe, und einen Parameter-String, der beim Aufruf der Exe zusätzlich übergeben wird. Der Parameter-String kann neben beliebigen, durch die Programm-Session auflösbaren Platzhaltern folgende Platzhalter enthalten, die beim Aufruf der Worker-Exe durch aktuelle Laufzeit-Werte ersetzt werden: "%Event%" = Name des Ereignisses, das zum Aufruf des Workers geführt hat, "%Source%" = Quelle des Ereignisses (Knoten, in dem das Ereignis zuerst aufgetreten ist), "%Sender%" = Knoten, der aufgrund des Ereigniss aktuell den Worker aufruft, "%Timestamp%" = aktuelles Datum mit aktueller Uhrzeit im Format "dd.MM.yyyy HH.mm.ss", "%Logical%" = aktueller logischer Wert des Senders, "%Exception%" = Exception.Message, falls %Event% gleich "Exception" ist, ansonsten "". |
| WorkerShell(String, XElement, Boolean, INodeTrigger) | Konstruktor - übernimmt den Pfad zur Worker-Exe, und einen Parameter-String, der beim Aufruf der Exe zusätzlich übergeben wird. Optional kann zusätzlich ein Trigger übergeben werden, der einen einmal aktivierten Worker, wiederholt aufruft. Der Parameter-String kann neben beliebigen, durch die Programm-Session auflösbaren Platzhaltern folgende Platzhalter enthalten, die beim Aufruf der Worker-Exe durch aktuelle Laufzeit-Werte ersetzt werden: "%Event%" = Name des Ereignisses, das zum Aufruf des Workers geführt hat, "%Source%" = Quelle des Ereignisses (Knoten, in dem das Ereignis zuerst aufgetreten ist), "%Sender%" = Knoten, der aufgrund des Ereigniss aktuell den Worker aufruft, "%Timestamp%" = aktuelles Datum mit aktueller Uhrzeit im Format "dd.MM.yyyy HH.mm.ss", "%Logical%" = aktueller logischer Wert des Senders, "%Exception%" = Exception.Message, falls %Event% gleich "Exception" ist, ansonsten "". |
Eigenschaften| Name | Beschreibung | |
|---|---|---|
 | CanRunDll |
Dll mit der Instanz von ICanRun. Wenn vorhanden, wird CanRun vor jedem Start
eines Knotens aufgerufen. Liefert CanRun false zurück, wir der Start abgebrochen.
In CanRun können darüber hinaus die per ref übergebenen Parameter noch
modifiziert werden.
(Vererbt von NodeShellBase) |
 | CanRunDllPath |
Pfad zu einer optionalen Dll, die eine ICanRun-Instanz zur Verfügung stellt.
Wenn vorhanden, wird vor jedem Run des zugehörigen Checkers oder Workers
CanRun aufgerufen. Liefert CanRun false zurück, wird der Start abgebrochen.
Zusätzlich können in CanRun die übergebenen Parameter noch modifiziert werden.
(Vererbt von NodeShellBase) |
| SlavePathName | Die bei Änderung des Zustands von Logical aufzurufende Exe. |
| TransportByFile | Bei True werden die Parameter über eine XML-Datei übergeben, ansonsten über die Kommandozeile; Default: false. |
| Trigger | Ein optionaler Trigger, der den Job wiederholt aufruft oder null. Wird vom IJobProvider bei der Instanziierung mitgegeben. |
| WorkerState | Zustand des Workers. None, Valid, Invalid. |
Methoden| Name | Beschreibung | |
|---|---|---|
| BreakExec | Abbrechen der Task. Worker Scheduler (nicht den Worker!) über CancellationToken abbrechen. |
| CanRun |
Wird von Vishnu vor jedem Run eines Checkers, Workers oder vor
Start eines Triggers aufgerufen.
Returnt true, wenn der Run/Start ausgewführt werden kann.
(Vererbt von NodeShellBase) |
| Exec | Startet einen zuständigen Worker, nachdem sich ein definierter Zustand (TreEvent) im Tree geändert hat. Intern wird für jeden Exec eine eigene Task gestartet. |
| Exists | Returnt True, wenn der SlavePathName existiert und Zugriff möglich ist. |
Anmerkungen
File: WorkerShell.cs
Autor: Erik Nagel
01.03.2013 Erik Nagel: erstellt
Siehe auch