HttpUtils - Versionsgeschichte

Ph1959de: (Ober)Kategorie entfernt

2026-01-12T19:16:19Z

(Ober)Kategorie entfernt

← Nächstältere Version		Version vom 12. Januar 2026, 21:16 Uhr
Zeile 586:		Zeile 586:

	== Referenzen ==		== Referenzen ==

	<references />		<references />

	~~[[Kategorie:Development]]~~

Ph1959de: Link zu Forenbeitrag über Vorlage

2025-11-24T09:34:48Z

Link zu Forenbeitrag über Vorlage

← Nächstältere Version		Version vom 24. November 2025, 11:34 Uhr
Zeile 501:		Zeile 501:
	return;;\		return;;\
	}		}
	</syntaxhighlight>Zugehöriger Forumspost: ~~[https://forum.fhem.de/index.php?topic~~=143117~~.msg1352221#msg1352221 📂~~ Datei herunterladen, Downloader, HttpUtils_NonblockingGet]		</syntaxhighlight>
			Zugehöriger Forumspost: {{Link2Forum\|Topic=143117\|LinkText=Datei herunterladen, Downloader, HttpUtils_NonblockingGet}}

	=== HttpUtils_Close ===		=== HttpUtils_Close ===

	Für den Abbruch von offenen Verbindungen und noch laufenden NonBockingGet-Aufrufen gibt es die Funktion HttpUtils_Close. Diese kann z.B. beim Löschen eines Devices oder Herunterfahren des Servers aufgerufen werden, um bestehende Verbindungen zu schliessen.		Für den Abbruch von offenen Verbindungen und noch laufenden NonBockingGet-Aufrufen gibt es die Funktion HttpUtils_Close. Diese kann z.B. beim Löschen eines Devices oder Herunterfahren des Servers aufgerufen werden, um bestehende Verbindungen zu schliessen.

Torxgewinde: /* Beispiel #2 eines Snippets um eine Datei herunterzuladen und lokal zu speichern */

2025-11-22T15:45:17Z

Beispiel #2 eines Snippets um eine Datei herunterzuladen und lokal zu speichern

← Nächstältere Version		Version vom 22. November 2025, 17:45 Uhr
Zeile 457:		Zeile 457:
	defmod MyDownloader dummy		defmod MyDownloader dummy
	attr MyDownloader userattr FilePath		attr MyDownloader userattr FilePath
	~~attr MyDownloader FilePath /opt/fhem/www/webhook/tasmota.bin.gz~~
	attr MyDownloader comment '\		attr MyDownloader comment '\
	~~set MyDownloader job Filepath="/opt/fhem/fhemicon.png"https://fhem.de/www/images/default/fhemicon.png\~~		Beispiel:\
	~~set MyDownloader job https://fhem.de/www/images/default/fhemicon.png\~~		set MyDownloader job Filepath="/opt/fhem/www/Dateiname.bin" https://example.com/datei.bin\
	\
	~~set MyDownloader job Filepath="/opt/fhem/www/webhook/tasmota.bin" https://ota.tasmota.com/tasmota/release/tasmota.bin\~~
	~~set MyDownloader job Filepath="/opt/fhem/www/webhook/tasmota.bin.gz" https://ota.tasmota.com/tasmota/release/tasmota.bin.gz\~~
	~~set MyDownloader job Filepath="/opt/fhem/www/webhook/tasmota-minimal.bin.gz" https://ota.tasmota.com/tasmota/release/tasmota-minimal.bin.gz\~~
	~~set MyDownloader job Filepath="/opt/fhem/www/webhook/tasmota32-zbbrdgpro.bin" https~~:~~//ota.tasmota.com/tasmota32/release/tasmota32-zbbrdgpro.bin~~\
	\
	~~set MyDownloader job Filepath="/opt/fhem/www/webhook/tasmota.bin" https://ota.tasmota.com/tasmota/release/tasmota.bin;; sleep 5;;~~ set MyDownloader job Filepath="/opt/fhem/www/~~webhook/tasmota~~.bin~~.gz~~" https://~~ota.tasmota~~.com/tasmota/release/tasmota.bin.gz;; sleep 5;; set MyDownloader job Filepath="/opt/fhem/www/webhook/tasmota-minimal.bin.gz" https://ota.tasmota.com/tasmota/release/tasmota-minimal.bin.gz;; sleep 5;; set MyDownloader job Filepath="/opt/fhem/www/webhook/tasmota32-zbbrdgpro.bin" https://ota.tasmota.com/tasmota32/release/tasmota32-zbbrdgpro.bin\
	'		'
	attr MyDownloader readingList job		attr MyDownloader readingList job

Torxgewinde: Weiteres Beispiel hinugefügt

2025-11-22T15:42:12Z

Weiteres Beispiel hinugefügt

@@ Zeile 408: / Zeile 408: @@
 Die Callback-Funktion kann nun die Daten aus der HTTP-Antwort verarbeiten oder bei Fehlern entsprechende Log-Meldungen ausgeben.
-==== Beispiel für HttpUtils_NonblockingGet() für Modulprogrammierer ====
+==== Beispiel #1 für HttpUtils_NonblockingGet() für Modulprogrammierer ====
 Das folgende Beispiel soll eine Hilfestellung für eigene Anwendungen geben
@@ Zeile 452: / Zeile 452: @@
      # Evtl. einen InternalTimer neu schedulen
 }</syntaxhighlight>
 === HttpUtils_Close ===

DelMar: tippfehler incrementalTimout ausgebessert

2021-04-08T06:38:32Z

tippfehler incrementalTimout ausgebessert

← Nächstältere Version		Version vom 8. April 2021, 08:38 Uhr
Zeile 356:		Zeile 356:
	* <code>$param->{callback} = sub(){ … }</code> — ''(direkte Funktionsdefinition)''		* <code>$param->{callback} = sub(){ … }</code> — ''(direkte Funktionsdefinition)''
	\|-		\|-
	\| style="vertical-align:top;white-space:nowrap;" \| '''<code>$param->{~~incrementalTimout~~}</code>'''		\| style="vertical-align:top;white-space:nowrap;" \| '''<code>$param->{incrementalTimeout}</code>'''

	''optional''		''optional''

ChristophMorrison: Nutzlose Prototypen entfernt

2020-05-22T12:04:54Z

Nutzlose Prototypen entfernt

Änderungen zeigen

Markusbloch: /* HttpUtils_NonblockingGet */ Kleinere Korrekturen an $param->{incrementalTimeout}

2018-03-24T08:39:31Z

HttpUtils_NonblockingGet: Kleinere Korrekturen an $param->{incrementalTimeout}

← Nächstältere Version		Version vom 24. März 2018, 10:39 Uhr
Zeile 356:		Zeile 356:
	* <code>$param->{callback} = sub($$$){ … }</code> — ''(direkte Funktionsdefinition)''		* <code>$param->{callback} = sub($$$){ … }</code> — ''(direkte Funktionsdefinition)''
	\|-		\|-
	\| style="vertical-align:top" \| '''<code>$param->{incrementalTimout}</code>'''		\| style="vertical-align:top;white-space:nowrap;" \| '''<code>$param->{incrementalTimout}</code>'''

	''optional''		''optional''
	\|\|~~Wenn true~~: ~~Der~~ Timeout ~~wird~~ nach jedem Empfang von Teil-Daten zurückgesetzt. So können größere Datenmengen von langsamen Sendern empfangen werden, ohne den <code>timeout</code> ~~parameter~~ zu erhöhen und dadurch tatsächliche Verbindungsprobleme erst spät zu erkennen.		\|\| Sofern gesetzt (Wert: <code>1</code>), wird der Timeout nach jedem Empfang von Teil-Daten wieder zurückgesetzt. So können größere Datenmengen von langsamen Sendern empfangen werden, ohne den Parameter <code>timeout</code> zu erhöhen und dadurch tatsächliche Verbindungsprobleme erst spät zu erkennen.

	~~Beispiel~~:~~<code>$param->{incrementalTimout} = 1</code>~~		Standardwert: 0
	\|-		\|-
	\| style="vertical-align:top" \| ''Benutzerdefinierte Parameter''		\| style="vertical-align:top" \| ''Benutzerdefinierte Parameter''
	\|\| Es können im Hash weitere benutzerdefinierte Parameter gesetzt werden, welche evtl. in der Callback-Funktion benötigt werden, um die Antwort korrekt zu verarbeiten.		\|\| Es können im Hash weitere benutzerdefinierte Parameter gesetzt werden, welche evtl. in der Callback-Funktion benötigt werden, um die Antwort korrekt zu verarbeiten.

	Zum Beispiel ~~bei~~ der Modul-Programmierung ~~währe~~ das $hash ~~des~~ aktuellen ~~Devices~~. Alle gesetzten Parameter sind in der Callback-Funktion direkt abrufbar und können ausgewertet werden.		Zum Beispiel im Rahmen der Modul-Programmierung wäre das <code>$hash</code> der aktuellen Definition. Alle gesetzten Parameter sind in der Callback-Funktion wieder über <code>$param</code> direkt abrufbar und können ausgewertet werden.

	Beispiel:		Beispiel:

Justme: /* HttpUtils_NonblockingGet */ incrementalTimout

2018-03-06T21:17:52Z

HttpUtils_NonblockingGet: incrementalTimout

← Nächstältere Version		Version vom 6. März 2018, 23:17 Uhr
Zeile 355:		Zeile 355:
	* <code>$param->{callback} = \&MyCallbackFn</code> — ''(Referenzzeiger auf Funktionsname)''		* <code>$param->{callback} = \&MyCallbackFn</code> — ''(Referenzzeiger auf Funktionsname)''
	* <code>$param->{callback} = sub($$$){ … }</code> — ''(direkte Funktionsdefinition)''		* <code>$param->{callback} = sub($$$){ … }</code> — ''(direkte Funktionsdefinition)''
			\|-
			\| style="vertical-align:top" \| '''<code>$param->{incrementalTimout}</code>'''

			''optional''
			\|\|Wenn true: Der Timeout wird nach jedem Empfang von Teil-Daten zurückgesetzt. So können größere Datenmengen von langsamen Sendern empfangen werden, ohne den <code>timeout</code> parameter zu erhöhen und dadurch tatsächliche Verbindungsprobleme erst spät zu erkennen.

			Beispiel:<code>$param->{incrementalTimout} = 1</code>
	\|-		\|-
	\| style="vertical-align:top" \| ''Benutzerdefinierte Parameter''		\| style="vertical-align:top" \| ''Benutzerdefinierte Parameter''

HomeAuto User: /* Beispiel für HttpUtils_NonblockingGet() für Modulprogrammierer */

2018-02-13T19:12:23Z

Beispiel für HttpUtils_NonblockingGet() für Modulprogrammierer

Markusbloch: /* Beispiel für HttpUtils_NonblockingGet() für Modulprogrammierer */

2018-02-13T14:02:44Z

Beispiel für HttpUtils_NonblockingGet() für Modulprogrammierer

← Nächstältere Version		Version vom 13. Februar 2018, 16:02 Uhr
Zeile 405:		Zeile 405:

	<syntaxhighlight lang="perl">use HttpUtils;		<syntaxhighlight lang="perl">use HttpUtils;
	sub ~~X_GetHttpResponse~~($)		sub X_PerformHttpRequest($)
	{		{
	my ($hash, $def) = @_;		my ($hash, $def) = @_;
	my $name = $hash->{NAME};		my $name = $hash->{NAME};
	my $param = {		my $param = {
	url => "http://www.foo.de",		url => "http://www.foo.de/",
	timeout => 5,		timeout => 5,
	hash => $hash, # Muss gesetzt werden, damit die Callback funktion wieder $hash hat		hash => $hash, # Muss gesetzt werden, damit die Callback funktion wieder $hash hat
	method => "GET", # Lesen von Inhalten		method => "GET", # Lesen von Inhalten
	header => "~~agent: TeleHeater/2.2.3\r\nUser~~-Agent: TeleHeater/2.2.3\r\nAccept: application/json", # Den Header ~~gemäss~~ abzufragender Daten ändern		header => "User-Agent: TeleHeater/2.2.3\r\nAccept: application/json", # Den Header gemäß abzufragender Daten ändern
	callback => \&X_ParseHttpResponse # Diese Funktion soll das Ergebnis dieser HTTP Anfrage bearbeiten		callback => \&X_ParseHttpResponse # Diese Funktion soll das Ergebnis dieser HTTP Anfrage bearbeiten
	};		};

← Nächstältere Version		Version vom 13. Februar 2018, 21:12 Uhr
Zeile 412:		Zeile 412:
	url => "http://www.foo.de/",		url => "http://www.foo.de/",
	timeout => 5,		timeout => 5,
	hash => $hash, # Muss gesetzt werden, damit die Callback funktion wieder $hash hat		hash => $hash, # Muss gesetzt werden, damit die Callback funktion wieder $hash hat
	method => "GET", # Lesen von Inhalten		method => "GET", # Lesen von Inhalten
	header => "User-Agent: TeleHeater/2.2.3\r\nAccept: application/json", # Den Header gemäß abzufragender Daten ändern		header => "User-Agent: TeleHeater/2.2.3\r\nAccept: application/json", # Den Header gemäß abzufragender Daten ändern
	callback => \&X_ParseHttpResponse # Diese Funktion soll das Ergebnis dieser HTTP Anfrage bearbeiten		callback => \&X_ParseHttpResponse # Diese Funktion soll das Ergebnis dieser HTTP Anfrage bearbeiten
	};		};

	HttpUtils_NonblockingGet($param); # Starten der HTTP Abfrage. Es gibt keinen Return-Code.		HttpUtils_NonblockingGet($param); # Starten der HTTP Abfrage. Es gibt keinen Return-Code.
	}		}

Zeile 427:		Zeile 427:
	my $name = $hash->{NAME};		my $name = $hash->{NAME};

	if($err ne "") # wenn ein Fehler bei der HTTP Abfrage aufgetreten ist		if($err ne "") # wenn ein Fehler bei der HTTP Abfrage aufgetreten ist
	{		{
	Log3 $name, 3, "error while requesting ".$param->{url}." - $err"; # Eintrag fürs Log		Log3 $name, 3, "error while requesting ".$param->{url}." - $err"; # Eintrag fürs Log
	readingsSingleUpdate($hash, "fullResponse", "ERROR"); # Readings erzeugen		readingsSingleUpdate($hash, "fullResponse", "ERROR", 0); # Readings erzeugen
	}		}

	elsif($data ne "") # wenn die Abfrage erfolgreich war ($data enthält die Ergebnisdaten des HTTP Aufrufes)		elsif($data ne "") # wenn die Abfrage erfolgreich war ($data enthält die Ergebnisdaten des HTTP Aufrufes)
	{		{
	Log3 $name, 3, "url ".$param->{url}." returned: $data"; # Eintrag fürs Log		Log3 $name, 3, "url ".$param->{url}." returned: $data"; # Eintrag fürs Log

	# An dieser Stelle die Antwort parsen / verarbeiten mit $data		# An dieser Stelle die Antwort parsen / verarbeiten mit $data

	readingsSingleUpdate($hash, "fullResponse", $data); # Readings erzeugen		readingsSingleUpdate($hash, "fullResponse", $data, 0); # Readings erzeugen
	}		}