======= WebSocket =======

WebSocket ist ein Protokoll für bidirektionale Kommunikation zwischen einer Webanwendung und einem Server über eine TCP-Verbindung.\\
Der Netzer nutzt WebSocket als ein Kanal für die [[commandinterface|Kommandoschnittstelle]].


====== Warum WebSocket? ======

Bei klassisches HTTP sendet ein Client (z.B. der Browser) eine Anfrage (Request) die dann vom Server (z.B. einem Netzer) beantwortet wird (Response). Der Server kann nicht von sich aus Daten an den Client senden.
Dies ist zum Beispiel dann von Nachteil, wenn Daten in unregelmäßigen Abständen aufgefrischt werden müssen. In solchen Fällen muss der Client auf gut Glück Anfragen stellen, die der Server jedesmal beantworten muss. Dies erzeugt viel unnötigen Datenverkehr.

WebSocket ist eine Möglichkeit für bidirektionale Kommunikation zwischen Server und Client. D.h. sowohl Client, als auch Server können jederzeit Daten an das Gegenüber senden. Beim Auffrischen von Daten reicht es dann aus, wenn der Server neue Daten sendet, sobald diese verfügbar sind. Der Client muss nicht ständig Anfragen stellen.

<note important>
Der Netzer unterstützt Websocket ab Version 1.5 !
</note>

====== Einschränkungen ======

Da eine aktive WebSocket-Verbindung stets eine aktive TCP-Verbindung zum Webserver des Netzers benötigt, blockiert sie den Zugriff auf Webseiten. 
Des Weiteren kann zu jeder Zeit maximal eine WebSocket-Verbindung aufgebaut werden.


===== Unterstützte Befehle =====

Es werden alle Befehle der [[commandinterface|Kommandoschnittstelle]] unterstützt.
Darüberhinaus gibt es keine für WebSocket spezifischen Befehle. 


====== WebSocket-URI ======

Im Allgemeinen beginnen unverschlüsselte WebSocket-URI mit ''%%ws://%%'' und verschlüsselte mit ''%%wss://%%''. Der Netzer unterstützt zur Zeit nur unverschlüsselte WebSocket-Verbindungen. 

Die WebSocket-URI eines Netzers folgt dem Schema ''%%ws://NETZER/ws%%'', wobei ''NETZER'' entweder die IP oder der [[networksettings#netzwerkname|mDNS-Name]] des Netzers ist.
Die WebSocket-Funktion eines Netzers mit der IP ''192.168.0.2'' und dem mDNS-Namen ''meinNetzer.local'' ist unter ''%%ws://192.168.0.2/ws%%'' und ''%%ws://meinNetzer.local/ws%%'' erreichbar. 


====== WebSocket in JavaScript ======

===== Verbindung öffnen =====


Eine neue WebSocket-Verbindung wird geöffnet indem ein neues Websocket-Objekt erzeugt wird.

<code>var meinWebSocket = new WebSocket(meineWebSocketURI);</code>

In manchen Firefox-Versionen (bis Version 11) heißt das WebSocket-Objekt "MozWebSocket". Alle anderen Bezeichnungen sind gleich (sofern sie implementiert wurden). Entsprechende Informationen, welche Browser derzeit Websocket unterstützen findet man hier (englisch): [[wp>WebSocket#Browser_support]].

<code>var meinWebSocket = new MozWebSocket(meineWebSocketURI);</code>


===== Daten senden =====


WebSocket unterstützt grundsätzlich zwei Übertragungsarten: Text (UTF-8) und binär. Daten werden mit Hilfe von ''send(meineDaten)'' gesendet, wobei die Übertragungsart durch den Datentyp von ''meineDaten'' bestimmt wird.

Da der Netzer nur Text-Übertragungen benutzt, wird an dieser Stelle auch nur diese weiter besprochen.

Die Übertragungsart Text wird nur dann verwendet, wenn die an ''send'' übergebene Variable ein String ist.

<code>var meineDaten = "Mein Text steht hier.";
meinWebSocket.send(meineDaten);</code>


===== Daten empfangen =====


Das Empfangen von Daten geschieht über den Event-Handler ''onmessage''. Die empfangen Daten sind in ''event.data'' hinterlegt.

<code>meinWebSocket.onmessage = function(event) {alert("Empfangene Daten: "+event.data);};</code>


===== Verbindung schließen =====

Um die WebSocket-Verbindung zu schließen, wird die Funktion ''close()'' aufgerufen. Optional kann noch ein Close-Code und eine Begründung (Reason) angegeben werden. Allerdings werden beide vom Netzer nicht weiter ausgewertet.

<code>meinWebSocket.close();</code>


===== Weitere Event-Handler =====


==== onopen ====


''onopen'' wird ausgelöst, wenn eine WebSocket-Verbindung geöffnet wird.


==== onclose ====


''onclose'' wird ausgelöst, wenn eine WebSocket-Verbindung geschlossen wird. Den Close-Code und die Begründung, die der Server angegeben hat, können mit ''close'' bzw. ''reason'' abgefragt werden.

<code>meinWebSocket.onclose = function(event) {alert("Verbindung geschlossen. Code: "+event.code+" Begründung: "+event.reason);};</code>


==== onerror ====


''onerror'' wird ausgelöst, wenn ein Fehler auftritt.


===== Ein einfaches Beispiel =====

Anzeigen des aktuellen Wertes von IO-0.
<WRAP center round download 60%>
[[@/examples/websocket_de.html|websocket.htm]]
</WRAP>

<code>
<html>
	<head>
		<meta http-equiv="content-type" content="text/html; charset=UTF-8">
		<script type="text/javascript">
			var meinWebSocket,
			// verbinden
			verbinden = function() {
				// bisherige Verbindung bereinigen
				if(meinWebSocket)
				{
					meinWebSocket.close();
				}
				
				// URL extrahieren
				url = document.getElementById("netzer_url").value;
				
				// neue Verbindung erstellen
				if("WebSocket" in window)
				{
					meinWebSocket = new WebSocket(url);
				}
				else if("MozWebSocket" in window)
				{
					meinWebSocket = new MozWebSocket(url);
				}
				else
				{
					alert("Keine Unterstützung für WebSockets vorhanden.");
					return;
				}
				
				// Handler für eingehende Nachrichten setzen
				meinWebSocket.onmessage = nachrichtEmpfangen;
				
				// wenn die Verbindung offen ist, wird ein Kommando gesendet, das den Trigger setzt
				meinWebSocket.onopen = function() {meinWebSocket.send("tuv0=3");};
			},
			// Nachricht empfangen
			nachrichtEmpfangen = function(event) {
				nachrichtJSON = JSON.parse(event.data);
				
				// Ist es ein Update des Wertes?
				if(nachrichtJSON && nachrichtJSON.u && nachrichtJSON.u.v && nachrichtJSON.u.v["0"])
				{
					document.getElementById("io_wert").innerHTML = nachrichtJSON.u.v["0"];
				}
				// andere Nachrichten werden ignoriert
			},
			// Funktion für die initiale Konfiguration der Seite
			seiteEinrichten = function() {
				// Hinweis löschen
				document.getElementById("js_hinweis").innerHTML = '';
				// Event-Handler setzen
				document.getElementById("anwenden_button").onclick = verbinden;
			};
		</script>
	</head>
	<body onload=seiteEinrichten()>
		<div id="js_hinweis">Bitte aktivieren Sie JavaScript!</div>
		<input value="ws://test.local/ws" id="netzer_url" type="url">
		<input id="anwenden_button" value="Anwenden" type="button">
		<p><div style="float:left; padding-right:5px">Wert von IO0:</div><div id="io_wert">N/A</div></p>
		<div style="clear:both;">
	</body>
</html>
</code>