Blocking Call - Versionsgeschichte

Torxgewinde: /* Kurzes, vollständiges Beispiel für BlockingCall() */

2025-02-21T07:51:51Z

Kurzes, vollständiges Beispiel für BlockingCall()

← Nächstältere Version		Version vom 21. Februar 2025, 09:51 Uhr
Zeile 177:		Zeile 177:

	=== Kurzes, vollständiges Beispiel für BlockingCall() ===		=== Kurzes, vollständiges Beispiel für BlockingCall() ===
			[[Datei:BlockingCallTest in Benutzung.png\|mini\|300x300px\|BlockingCallTest mit einem Ergebniss]]
	Folgendes Beispiel erlaubt das Ausführen von Shell Befehlen die blockieren würden. Die Ergebnisse der Befehle werden in dem Reading "result" angezeigt.		Folgendes Beispiel erlaubt das Ausführen von Shell Befehlen die blockieren würden. Die Ergebnisse der Befehle werden in dem Reading "result" angezeigt.

Torxgewinde: Kurzes Beispiel für BlockingCall ergänzt

2025-02-21T07:29:35Z

Kurzes Beispiel für BlockingCall ergänzt

Änderungen zeigen

Beta-User: typo

2022-07-18T08:29:52Z

typo

← Nächstältere Version		Version vom 18. Juli 2022, 10:29 Uhr
Zeile 153:		Zeile 153:
	my $decoded;		my $decoded;
	if ( !eval { $decoded = JSON->new->decode($content) ; 1 } ) {		if ( !eval { $decoded = JSON->new->decode($content) ; 1 } ) {
	Log3($hash->{NAME}, 1, "JSON decoding error in ~~Blocking call~~ return: $@");		Log3($hash->{NAME}, 1, "JSON decoding error in BlockingCall return: $@");
	#weiterer Code für Fehlerbehandlung...		#weiterer Code für Fehlerbehandlung...
	return;		return;

Beta-User: encode_json/decode_json durch JSON->new-> Methoden ergänzt; Forum #126088

2022-07-18T08:29:03Z

encode_json/decode_json durch JSON->new-> Methoden ergänzt; Forum #126088

← Nächstältere Version		Version vom 18. Juli 2022, 10:29 Uhr
Zeile 149:		Zeile 149:
	So kann man z.B. den Rückgabestring "Wert1\|Wert2\|Wert3" verwenden und diesen anschließend mit split() wieder in ein Array verwandeln und dann via Index gezielt darauf zugreifen.		So kann man z.B. den Rückgabestring "Wert1\|Wert2\|Wert3" verwenden und diesen anschließend mit split() wieder in ein Array verwandeln und dann via Index gezielt darauf zugreifen.

	Eine weitere Möglichkeit auch kompliziertere Datenstrukturen zurückzugeben ist <code>~~encode_json~~</code> zum serialisieren und <code>~~decode_json~~</code> zum deserialisieren zu verwenden.		Eine weitere Möglichkeit auch kompliziertere Datenstrukturen zurückzugeben ist <code>JSON->new->encode()</code> (Perl-Modul JSON) oder <code>toJSON</code> (aus fhem.pl) zum serialisieren und <code>JSON->new->decode()</code> zum deserialisieren zu verwenden. Achtung: Man kann hierfür zwar auch <code>encode_json</code> bzw. <code>decode_json</code> aus dem Perl-Modul JSON verwenden, sollte dabei aber beachten, dass hierdurch auch das encoding geändert wird! Außerdem führen unerwartete Rückgaben (mit Ausnahme von der Serialisierung durch <code>toJSON</code>) ggf. dazu, dass FHEM komplett beendet wird; alle decoding- und encoding-Anweisungen aus dem JSON-Modul sollten daher unbedingt durch eine (Block-) <code>eval</code>-Anweisung geschützt werden:
			<syntaxhighlight lang="Perl">
			my $decoded;
			if ( !eval { $decoded = JSON->new->decode($content) ; 1 } ) {
			Log3($hash->{NAME}, 1, "JSON decoding error in Blocking call return: $@");
			#weiterer Code für Fehlerbehandlung...
			return;
			}
			</syntaxhighlight>

	== Rückgabewert muss unbedingt den Namen des Devices enthalten, von dem der Call gestartet wurde ==		== Rückgabewert muss unbedingt den Namen des Devices enthalten, von dem der Call gestartet wurde ==

Trelle: /* Verwenden einer UndefFn um laufende BlockingCalls zu beenden */ ShutdownFn ergänzt

2018-09-03T21:28:52Z

Verwenden einer UndefFn um laufende BlockingCalls zu beenden: ShutdownFn ergänzt

← Nächstältere Version		Version vom 3. September 2018, 23:28 Uhr
Zeile 159:		Zeile 159:
	Daher ist es wichtig, den Devicenamen beim Start des Blockingcalls zu übergeben.		Daher ist es wichtig, den Devicenamen beim Start des Blockingcalls zu übergeben.

	== Verwenden einer UndefFn um laufende BlockingCalls zu beenden ==		== Verwenden einer UndefFn und ShutdownFn um laufende BlockingCalls 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.		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 UndefFn des Moduls sichergestellt werden, dass ein laufender BlockingCall beendet wird. Dazu wird als Argument der Return-Hash von BlockingCall benötigt in dem unter anderem die PID des Unterprozesses enthalten ist. Die Funktion BlockingKill() erledigt dann den Rest.		Daher muss in der [[DevelopmentModuleIntro#X_Undef\|UndefFn]] und [[DevelopmentModuleIntro#X_Shutdown\|ShutdownFn]] des Moduls sichergestellt werden, dass ein laufender BlockingCall beendet wird. Dazu wird als Argument der Return-Hash von BlockingCall benötigt in dem unter anderem die PID des Unterprozesses enthalten ist. Die Funktion BlockingKill() erledigt dann den Rest.

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

Trelle: /* Begrenzen des Blocking Calls */

2018-01-24T16:53:27Z

Begrenzen des Blocking Calls

← Nächstältere Version		Version vom 24. Januar 2018, 18:53 Uhr
Zeile 183:		Zeile 183:
	Mit dem FHEM-Befehl <code>blockinginfo</code> lassen sich die laufenden [[Blocking Call\|Blocking Calls]] anzeigen.		Mit dem FHEM-Befehl <code>blockinginfo</code> lassen sich die laufenden [[Blocking Call\|Blocking Calls]] anzeigen.

	= Begrenzen ~~des~~ Blocking Calls =		= Begrenzen der Blocking Calls =

	Mit dem globalen [[Attribute\|Attribut]] <code>blockingCallMax</code> können die gleichzeitig laufenden [[Blocking Call\|Blocking Calls]] begrenzt werden.		Mit dem globalen [[Attribute\|Attribut]] <code>blockingCallMax</code> können die gleichzeitig laufenden [[Blocking Call\|Blocking Calls]] begrenzt werden.

Trelle: /* Anzeige der laufenden Blocking Calls */ blockingCallMax ergänzt

2018-01-24T16:52:58Z

Anzeige der laufenden Blocking Calls: blockingCallMax ergänzt

← Nächstältere Version		Version vom 24. Januar 2018, 18:52 Uhr
Zeile 182:		Zeile 182:

	Mit dem FHEM-Befehl <code>blockinginfo</code> lassen sich die laufenden [[Blocking Call\|Blocking Calls]] anzeigen.		Mit dem FHEM-Befehl <code>blockinginfo</code> lassen sich die laufenden [[Blocking Call\|Blocking Calls]] anzeigen.

			= Begrenzen des Blocking Calls =

			Mit dem globalen [[Attribute\|Attribut]] <code>blockingCallMax</code> können die gleichzeitig laufenden [[Blocking Call\|Blocking Calls]] begrenzt werden.

	= Module, die Blocking.pm verwenden =		= Module, die Blocking.pm verwenden =

Trelle: /* Module, die Blocking.pm verwenden */ blockinginfo ergänzt

2018-01-24T16:45:07Z

Module, die Blocking.pm verwenden: blockinginfo ergänzt

← Nächstältere Version		Version vom 24. Januar 2018, 18:45 Uhr
Zeile 178:		Zeile 178:
	return undef;		return undef;
	}		}

			= Anzeige der laufenden Blocking Calls =

			Mit dem FHEM-Befehl <code>blockinginfo</code> lassen sich die laufenden [[Blocking Call\|Blocking Calls]] anzeigen.

	= Module, die Blocking.pm verwenden =		= Module, die Blocking.pm verwenden =

AndreasMohr: Typos/Spelling

2017-12-28T15:48:53Z

Typos/Spelling

Andies: /* Allgemein */

2017-09-30T16:56:25Z

Allgemein

← Nächstältere Version		Version vom 30. September 2017, 18:56 Uhr
Zeile 3:		Zeile 3:
	= Allgemein =		= Allgemein =

	Das Modul Blocking.pm wurde von Rudolf König entwickelt um in FHEM Funktionsaufrufe zu ermöglichen die relativ viel Zeit in Anspruch nehmen und normalerweise FHEM damit zum Stillstand für die Dauer der Ausführung ~~einer solchen~~ Funktion bringen würde.		Das Modul Blocking.pm wurde von Rudolf König entwickelt, um in FHEM Funktionsaufrufe zu ermöglichen, die relativ viel Zeit in Anspruch nehmen und normalerweise FHEM damit zum Stillstand (für die Dauer der Ausführung der Funktion) bringen würde.

	Um so etwas zu verhindern kann man mit Hilfe von Blocking.pm eine Funktion über einen Fork des Hauptprozesses unabhängig davon abarbeiten und das ~~Ergebniss~~ dieser Funktion optional an den Hauptprozess übergeben.		Um so etwas zu verhindern, kann man mit Hilfe von Blocking.pm eine Funktion über einen Fork des Hauptprozesses unabhängig davon abarbeiten und das Ergebnis dieser Funktion optional an den Hauptprozess übergeben.

	= Benutzung =		= Benutzung =

← Nächstältere Version		Version vom 28. Dezember 2017, 17:48 Uhr
Zeile 51:		Zeile 51:

	* Veränderungen an internen Variablen von FHEM (Device Hashes, Timers, usw.) werden innerhalb eines BlockingCalls durchgeführt und sind dort auch sichtbar, haben aber keinerlei Einfluss auf den eigentlichen FHEM Hauptprozess und alle Definitionen. Solche Veränderungen müssen an die finishFn delegiert werden (z.B. durch zusätzliche Rückgabewerte), da es sich um einen Fork-Prozess handelt, der sich nach Abschluss des BlockingCall selbst zerstört.		* Veränderungen an internen Variablen von FHEM (Device Hashes, Timers, usw.) werden innerhalb eines BlockingCalls durchgeführt und sind dort auch sichtbar, haben aber keinerlei Einfluss auf den eigentlichen FHEM Hauptprozess und alle Definitionen. Solche Veränderungen müssen an die finishFn delegiert werden (z.B. durch zusätzliche Rückgabewerte), da es sich um einen Fork-Prozess handelt, der sich nach Abschluss des BlockingCall selbst zerstört.
	* Wenn viele Definitionen aktiv sind, welche BlockingCalls parallel starten kann es zu einem relativ hohen Memory-Footprint kommen aufgrund mehrfach laufenden Fork-Prozessen. Dies kann auf schwachbrüstiger Hardware zu Speicherengpässen führen. Ab FHEM Revision 11917 lassen sich die maximal ~~parrallel~~ laufenden BlockingCalls durch das globale Attribut <code>blockingCallMax</code> begrenzen (Standardwert: ''unbegrenzt''). Sofern die maximale parallele Anzahl an BlockingCalls erreicht ist, werden weitere Calls in eine Warteschlange eingereiht und ausgeführt, sobald laufende Calls beendet werden.		* Wenn viele Definitionen aktiv sind, welche BlockingCalls parallel starten kann es zu einem relativ hohen Memory-Footprint kommen aufgrund mehrfach laufenden Fork-Prozessen. Dies kann auf schwachbrüstiger Hardware zu Speicherengpässen führen. Ab FHEM Revision 11917 lassen sich die maximal parallel laufenden BlockingCalls durch das globale Attribut <code>blockingCallMax</code> begrenzen (Standardwert: ''unbegrenzt''). Sofern die maximale parallele Anzahl an BlockingCalls erreicht ist, werden weitere Calls in eine Warteschlange eingereiht und ausgeführt, sobald laufende Calls beendet werden.

	= Blocking.pm für Modulentwickler =		= Blocking.pm für Modulentwickler =

	Blocking.pm ist aktuell sowohl für Enduser, als auch für Modulentwickler gedacht. Die Benutzung in einem Modul birgt allerdings einige Stolperfallen auf die hier näher eingegangen wird.		Blocking.pm ist aktuell sowohl für Enduser, als auch für Modulentwickler gedacht. Die Benutzung in einem Modul birgt allerdings einige Stolperfallen, auf die hier näher eingegangen wird.

	== return-Wert von BlockingCall immer in $hash abspeichern ==		== return-Wert von BlockingCall immer in $hash abspeichern ==
Zeile 69:		Zeile 69:
	== Sicherstellen, dass immer nur ein BlockingCall gleichzeitig läuft ==		== Sicherstellen, dass immer nur ein BlockingCall gleichzeitig läuft ==

	Sobald ein BlockingCall läuft könnte man ~~reintheoretisch~~ direkt einen weiteren BlockingCall starten usw. Dadurch würden mehrer parallele Durchläufe nebenher laufen und könnten den FHEM-Server dadurch unnötig belasten oder sogar auch überlasten. Daher sollte man immer beim Start eines BlockingCall prüfen, ob bereits ein weiterer BlockingCall läuft oder bei mehreren parallelen Blocking Calls eine entsprechende Prüfung einführen um die maximale Anzahl an gleichzeitigen BlockingCalls innerhalb einer Definition zu begrenzen.		Sobald ein BlockingCall läuft könnte man rein theoretisch direkt einen weiteren BlockingCall starten usw. Dadurch würden mehrer parallele Durchläufe nebenher laufen und könnten den FHEM-Server dadurch unnötig belasten oder sogar auch überlasten. Daher sollte man immer beim Start eines BlockingCall prüfen, ob bereits ein weiterer BlockingCall läuft oder bei mehreren parallelen Blocking Calls eine entsprechende Prüfung einführen um die maximale Anzahl an gleichzeitigen BlockingCalls innerhalb einer Definition zu begrenzen.

	<font color="grey">$hash->{helper}{RUNNING_PID} = BlockingCall(…)</font> unless(exists($hash->{helper}{RUNNING_PID}));		<font color="grey">$hash->{helper}{RUNNING_PID} = BlockingCall(…)</font> unless(exists($hash->{helper}{RUNNING_PID}));
	Dies funktioniert nur dann, wenn man in der finishFn (und später auch abortFn) $hash->{helper}{RUNNING_PID} wieder löscht. Somit ist immer sichergestellt, ~~das~~ nur ein BlockingCall zur gleichen Zeit läuft. Wenn gerade ein BlockingCall aktiv ist aufgrund eines Set-Befehls, könnte man eine Meldung ausgeben.		Dies funktioniert nur dann, wenn man in der finishFn (und später auch abortFn) $hash->{helper}{RUNNING_PID} wieder löscht. Somit ist immer sichergestellt, dass nur ein BlockingCall zur gleichen Zeit läuft. Wenn gerade ein BlockingCall aktiv ist aufgrund eines Set-Befehls, könnte man eine Meldung ausgeben.

	<u>Beispiel:</u>		<u>Beispiel:</u>
Zeile 149:		Zeile 149:
	So kann man z.B. den Rückgabestring "Wert1\|Wert2\|Wert3" verwenden und diesen anschließend mit split() wieder in ein Array verwandeln und dann via Index gezielt darauf zugreifen.		So kann man z.B. den Rückgabestring "Wert1\|Wert2\|Wert3" verwenden und diesen anschließend mit split() wieder in ein Array verwandeln und dann via Index gezielt darauf zugreifen.

	Eine weitere Möglichkeit auch kompliziertere Datenstrukturen ~~zurück zu geben~~ ist <code>encode_json</code> zum serialisieren und <code>decode_json</code> zum deserialisieren zu verwenden.		Eine weitere Möglichkeit auch kompliziertere Datenstrukturen zurückzugeben ist <code>encode_json</code> zum serialisieren und <code>decode_json</code> zum deserialisieren zu verwenden.

	== Rückgabewert muss unbedingt den Namen des Devices enthalten, von dem der Call gestartet wurde ==		== Rückgabewert muss unbedingt den Namen des Devices enthalten, von dem der Call gestartet wurde ==