CoProcess - Versionsgeschichte

Justme am 26. Januar 2019 um 16:19 Uhr

2019-01-26T16:19:27Z

← Nächstältere Version		Version vom 26. Januar 2019, 18:19 Uhr
Zeile 12:		Zeile 12:
	* status Readings		* status Readings

			= Einführung =

	~~= Allgemein =~~		Das Modul CoProcess.pm wurde entwickelt, um in die Kontrolle ständig laufender externer Hilfsprozesse zu vereinfachen. Hierzu
			wird der externe Prozess mit umgeleiteter Standard-Ein- und -Ausgabe gestartet.

	Das Modul CoProcess~~.pm wurde entwickelt, um in die Kontrolle ständig laufender externer Hilfsprozesse zu vereinfachen~~.		= Benutzung =
			* Um die CoProcess Routinen zu verwenden müssen diese mit <code>use CoProcess;</code> eingebunden werden.
			* Im Device-Hash müssen Information zum externen Prozess hinterlegt werden. Dies geschieht z.b. in der DefineFn.
			* Das Modul muss eine ReadFn Implementieren in der <code>CoProcess::readFn($hash)</code> aufgerufen wird.

			== Vorbereitung ==

	~~= Benutzung =~~
	~~=== Vorbereitung ===~~
	* Um die CoProcess Routinen zu verwenden werden diese mit <code>use CoProcess;</code> eingebunden.
	* Danach müßen im Device-Hash Information zum externen Prozess hinterlegt werden. Dies geschieht z.b. in der DefineFn:
	:<syntaxhighlight lang="perl" xstyle="width:80%;">		:<syntaxhighlight lang="perl" xstyle="width:80%;">
	$hash->{CoProcess} = { name => 'alexaFHEM',		sub
	cmdFn => 'alexa_getCMD',		alexa_Define($$) {
	};		...
			$hash->{CoProcess} = { name => 'alexaFHEM',
			cmdFn => 'alexa_getCMD',
			};
			...
			}
	</syntaxhighlight>		</syntaxhighlight>

Zeile 34:		Zeile 41:
	\| '''<code>name</code>''' \|\| nein \|\| 'alexaFHEM' \|\| Ein Name für diese CoProcess Klasse. Wird verendet um Defaults für Reading- und Attribut-Namen zu erzeugen.		\| '''<code>name</code>''' \|\| nein \|\| 'alexaFHEM' \|\| Ein Name für diese CoProcess Klasse. Wird verendet um Defaults für Reading- und Attribut-Namen zu erzeugen.
	\|-		\|-
	\| '''<code>cmdFn</code>''' \|\| nein \|\| 'alexa_getCMD' \|\| Der Name der Perlfunktion, die die komplette Kommandozeile des zu startenden Prozesses liefert. Wird mit dem Device-Hash als Parameter aufgerufen. Kann '''<code>undef</code>''' zurückliefen wenn nichts gestartet werden soll oder kann.		\| '''<code>cmdFn</code>''' \|\| nein \|\| 'alexa_getCMD' \|\| Der Name der Perlfunktion, die die komplette Kommandozeile des zu startenden Prozesses liefert. Wird mit dem Device-Hash als Parameter aufgerufen. Kann '''<code>(undef,$error)</code>''' zurückliefen wenn nichts gestartet werden soll oder kann.
	\|}		\|}

	* Das Modul muss eine ReadFn Implementieren in der <code>CoProcess::readFn($hash)</code> aufgerufen wird.		== Starten und Stoppen ==

			'''<code>CoProcess::start($hash)</code>'''
			'''<code>CoProcess::stop($hash)</code>'''
			'''<code>CoProcess::terminate($hash)</code>'''

			== Lesen und Schreiben ==
			Damit der gestartete Prozess nicht blockiert, müssen dessen Ausgaben auf jeden Fall abgeholt werden. Dies geschieht über den Aufruf von

	~~=== Starten und Stoppen ===~~		'''<code>CoProcess::readFn($hash)</code>'''

	~~'''<code>CoProcess::start($)</code>'''~~		aus der ReadFn des Moduls. Dies muss auch dann geschehen wenn diese Ausgaben nicht weiter verarbeitet werden sollen.
	~~'''<code>CoProcess::stop($)</code>'''~~
	~~'''<code>CoProcess::terminate($)</code>'''~~

	=== ~~Logfile handling~~ ===		:<syntaxhighlight lang="perl" xstyle="width:80%;">
			sub
			alexa_Initialize($) {
			...
			$hash->{ReadFn} = "alexa_Read";
			...
			}
			sub
			alexa_Read($) {
			my ($hash) = @_;
			my $name = $hash->{NAME};

			my $buf = CoProcess::readFn($hash);
			return undef if( !$buf );

			...
			}
			</syntaxhighlight>

	==~~= Lesen und Schreiben =~~==		== Logfile handling ==

	'''~~<code>~~CoProcess::readFn($)~~</code>~~'''		Sobald <code>$hash->{logfile}</code> gesetzt ist werden alle Ausgaben des des gestarteten Prozesses dorthin geschrieben. Dies geschieht durch '''CoProcess::readFn($)'''.
	~~Muss in der ReadFn des Moduls verwendet werden um~~

	=== Relevante Internals ===		== Relevante Internals ==
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-
Zeile 73:		Zeile 98:
	\|}		\|}

	=== Relevante Attribute ===		== Relevante Attribute ==

	Im FHEM-Device das CoProcess mit einem Logfile verwendet kann das <code>nrarchive</code> verwendet werden um alte Logfiles zu löschen.		Im FHEM-Device das CoProcess mit einem Logfile verwendet kann das <code>nrarchive</code> verwendet werden um alte Logfiles zu löschen.

Justme: /* Relevante Internals */

2019-01-25T18:31:04Z

Relevante Internals

← Nächstältere Version		Version vom 25. Januar 2019, 20:31 Uhr
Zeile 60:		Zeile 60:
	! Internal !! Optional !! Beschreibung		! Internal !! Optional !! Beschreibung
	\|-		\|-
	\| '''<code>logfile</code>''' \|\| ja \|\| Muster für den ~~Logfile~~ Namen. ~~Bei '''FHEM''' wird~~ Siehe {{Link2CmdRef\|Anker=FileLog}}. Beispiel: '''./log/alexa-%Y-%m-%d.log'''. Bei '''FHEM''' wird das Standard FHEM Logfile verwendet. Wenn nicht gesetzt werden die Prozess ausgaben nicht automatisch geloggt.		\| '''<code>CoProcess</code>''' \|\| nein \|\| s.o.
			\|-
			\| '''<code>logfile</code>''' \|\| ja \|\| Muster für den Namen des zu verwendenden Logfiles. Siehe {{Link2CmdRef\|Anker=FileLog}}. Beispiel: '''./log/alexa-%Y-%m-%d.log'''. Bei '''FHEM''' wird das Standard FHEM Logfile verwendet. Wenn nicht gesetzt, werden die Prozess ausgaben nicht automatisch geloggt.
	\|-		\|-
	\| '''<code>currentlogfile</code>''' \|\| - \|\| Wird von CoProcess automatisch auf den Namen des Aktuellen Logfiles gesetzt wenn '''<code>logfile</code>''' verwendet wird.		\| '''<code>currentlogfile</code>''' \|\| - \|\| Wird von CoProcess automatisch auf den Namen des Aktuellen Logfiles gesetzt wenn '''<code>logfile</code>''' verwendet wird.

Justme am 25. Januar 2019 um 18:28 Uhr

2019-01-25T18:28:46Z

← Nächstältere Version		Version vom 25. Januar 2019, 20:28 Uhr
Zeile 53:		Zeile 53:

	'''<code>CoProcess::readFn($)</code>'''		'''<code>CoProcess::readFn($)</code>'''
	~~Muß~~ in der ReadFn des Moduls verwendet werden um		Muss in der ReadFn des Moduls verwendet werden um

	=== Relevante Internals ===		=== Relevante Internals ===
Zeile 78:		Zeile 78:
	== Verwenden von UndefFn, DelayedShutdownFn und ShutdownFn um laufende CoProzesse korrekt zu beenden ==		== Verwenden von UndefFn, DelayedShutdownFn und ShutdownFn um laufende CoProzesse korrekt zu beenden ==

	In der [[DevelopmentModuleIntro#X_Undef\|UndefFn]], [[DevelopmentModuleIntro#X_DelayedShutdown\|DelayedShutdownFn]] und [[DevelopmentModuleIntro#X_Shutdown\|ShutdownFn]] des Moduls ~~muß~~ sichergestellt werden, dass die laufenden externen Prozesse sauber beendet werden.		In der [[DevelopmentModuleIntro#X_Undef\|UndefFn]], [[DevelopmentModuleIntro#X_DelayedShutdown\|DelayedShutdownFn]] und [[DevelopmentModuleIntro#X_Shutdown\|ShutdownFn]] des Moduls muss sichergestellt werden, dass die laufenden externen Prozesse sauber beendet werden.

	<u>Beispiel</u>		<u>Beispiel</u>

Justme am 25. Januar 2019 um 18:27 Uhr

2019-01-25T18:27:59Z

@@ Zeile 19: / Zeile 19: @@
 = Benutzung =
- $hash->{CoProccess}
+:{| class="wikitable"
-  name
+|-
-  cmdFn
+! Parameter !! Optional !! Beispiel !! Beschreibung
- $hash->{logfile}
+* Das Modul muss eine ReadFn Implementieren in der <code>CoProcess::readFn($hash)</code> aufgerufen wird.
-= Einschränkungen =
+  '''<code>CoProcess::start($)</code>'''
-Wenn gerade ein BlockingCall läuft und man will FHEM herunterfahren oder neustarten kann das problematisch werden, da ja immer noch Unterprozesse laufen und so einen kompletten Stop verhindern können.
+=== Lesen und Schreiben ===
-Daher muss in der [[DevelopmentModuleIntro#X_Undef|UndefFn]], [[DevelopmentModuleIntro#X_DelayedShutdown|DelayedShutdownFn]] und [[DevelopmentModuleIntro#X_Shutdown|ShutdownFn]] des Moduls sichergestellt werden, dass ein laufender BlockingCall beendet wird.
+  '''<code>CoProcess::readFn($)</code>'''
 <u>Beispiel</u>

Justme: Die Seite wurde neu angelegt: „{{Baustelle}} Dieser Artikel soll Hinweise und Best Practices im Umgang mit dem Modul CoProcess.pm und den daraus bereitgestellten Funktionen bieten. CoProces…“

2019-01-25T08:29:02Z

Die Seite wurde neu angelegt: „{{Baustelle}} Dieser Artikel soll Hinweise und Best Practices im Umgang mit dem Modul CoProcess.pm und den daraus bereitgestellten Funktionen bieten. CoProces…“

Neue Seite

{{Baustelle}}
Dieser Artikel soll Hinweise und Best Practices im Umgang mit dem Modul CoProcess.pm und den daraus bereitgestellten Funktionen bieten.

CoProcess.pm enthält eine Sammlung von Routinen um das Ausführen permanent laufender, externen Hilfsprozesse aus FHEM zu vereinfachen. Hierzu gehören:
* Starten und Stoppen
* Überwachen und automatisch am Laufen halten
* Automatisch bei FHEM Start und Stop
* jeder Zeit manuell
* lokales oder entferntes Starten per SSH
* Umleiten von STDOUT und STDERR des Prozesses ins FHEM log oder in ein separates Logfile
* Rotieren und löschen dieses Logfiles nach FHEM Konventionen
* status Readings

= Allgemein =

Das Modul CoProcess.pm wurde entwickelt, um in die Kontrolle ständig laufender externer Hilfsprozesse zu vereinfachen.

= Benutzung =

$hash->{CoProccess}
name
cmdFn

$hash->{logfile}
$hash->{currentlogfile}

nrarchive

CoProcess::start
CoProcess::stop
CoProcess::terminate

= Einschränkungen =

== Verwenden von UndefFn, DelayedShutdownFn und ShutdownFn um laufende CoProzesse zu beenden ==

Wenn gerade ein BlockingCall läuft und man will FHEM herunterfahren oder neustarten kann das problematisch werden, da ja immer noch Unterprozesse laufen und so einen kompletten Stop verhindern können.

Daher muss in der [[DevelopmentModuleIntro#X_Undef|UndefFn]], [[DevelopmentModuleIntro#X_DelayedShutdown|DelayedShutdownFn]] und [[DevelopmentModuleIntro#X_Shutdown|ShutdownFn]] des Moduls sichergestellt werden, dass ein laufender BlockingCall beendet wird.

<u>Beispiel</u>

sub
alexa_Undefine($$) {
my ($hash, $name) = @_;

if( $hash->{PID} ) {
$hash->{undefine} = 1;
$hash->{undefine} = $hash->{CL} if( $hash->{CL} );

$hash->{reason} = 'delete';
CoProcess::stop($hash);

return "$name will be deleted after alexa-fhem has stopped or after 5 seconds. whatever comes first.";
}

delete $modules{$hash->{TYPE}}{defptr};

return undef;
}

sub
alexa_DelayedShutdownFn($){
my ($hash) = @_;

if( $hash->{PID} ) {
$hash->{shutdown} = 1;
$hash->{shutdown} = $hash->{CL} if( $hash->{CL} );

$hash->{reason} = 'shutdown';
CoProcess::stop($hash);

return 1;
}

return undef;
}

sub
alexa_Shutdown($){
my ($hash) = @_;

CoProcess::terminate($hash);

delete $modules{$hash->{TYPE}}{defptr};

return undef;
}

= Anzeige der laufenden CoProzesse =

Mit dem FHEM-Befehl <code>coprocessinfo</code> lassen sich die laufenden [[CoProcess|CoProzesse]] anzeigen.

= Module, die CoProcess.pm verwenden =

Folgende Module verwenden aktuell CoProcess.pm um parallel laufende Prozesse zu steuern:

* '''30_tradfri.pm'''
* '''39_alexa.pm'''
* '''39_gassistant.pm'''
* '''39_siri.pm'''

[[Kategorie:Development]]