diff --git a/doc/feindesign/netzwerk-protokoll.fodt b/doc/feindesign/netzwerk-protokoll.fodt index fd2a2f7..27a6e75 100644 --- a/doc/feindesign/netzwerk-protokoll.fodt +++ b/doc/feindesign/netzwerk-protokoll.fodt @@ -1,28 +1,28 @@ - 2019-03-22T18:11:56.7688408422019-04-15T16:56:42.500511105PT4H7M8S172LibreOffice/6.2.2.2$Linux_X86_64 LibreOffice_project/20$Build-2Netzwerkprotokoll1.1.0 + 2019-03-22T18:11:56.7688408422019-04-19T16:47:23.627172921PT4H11M31S178LibreOffice/6.2.2.2$Linux_X86_64 LibreOffice_project/20$Build-2Netzwerkprotokoll1.2.0 - 252767 + 204451 0 - 43041 - 18597 + 50802 + 26562 true false view2 - 18307 - 260620 + 16898 + 224674 0 - 252767 - 43039 - 271362 + 204451 + 50800 + 231011 0 1 false - 120 + 80 false false @@ -114,7 +114,7 @@ true false true - 3832186 + 3838056 true false false @@ -177501,6 +177501,73 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -177556,71 +177623,10 @@ - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -177678,355 +177684,361 @@ - - + + - - - + + - - + + - + - + + + + + + + + + + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + + + + + + + + + + - + - + - + - + + + + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + + + + - + - + - + - + - + - + - + - + - + - - - - - - - - - - - - - - - - - - + + - + + + + + + + + + + - + - - - - - - - - - - - - - + - + - + - + - + - + - + + + + + + + + + + + + + - - + + - - + + + - - + + + - - - - - - - - - - + - + - + - + - + - + - + - + - - - - + - + - + - + + + + - + - + - - - - - - - + + @@ -178094,6 +178106,9 @@ + + + @@ -178515,58 +178530,6 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -178606,7 +178569,7 @@ - TextureSync Netzwerkprotokoll ⸬ Version 1.1.0Seite 11/11 + TextureSync Netzwerkprotokoll ⸬ Version 1.2.0Seite 11/11 @@ -178627,9 +178590,9 @@ - - - Netzwerk-Protokoll + + + Netzwerk-Protokoll TextureSync @@ -178646,41 +178609,41 @@ - Version + Version - 1.1.0 + 1.2.0 - Datum + Datum - 03.04.2019 + 19.04.2019 - Autor + Autor - Robin Willmann + Robin Willmann - Projektmitglieder + Projektmitglieder - Hendrik Schutter, - Lukas Fürderer, - Robin Willmann, - Jannik Seiler + Hendrik Schutter, + Lukas Fürderer, + Robin Willmann, + Jannik Seiler - + Inhaltsverzeichnis @@ -178767,34 +178730,34 @@ - Inhaltsverzeichnis + Inhaltsverzeichnis - 1 Grundsätzliches3 - 1.1 Ports3 - 1.2 Paketformat3 - 2 Befehle4 - 2.1 Definitionen4 - 2.2 Ping6 - 2.3 Query6 - 2.4 Get Texture7 - 2.5 Get Texture File7 - 2.6 Get Texture Preview8 - 2.7 Replace Texture9 - 3 Fehlerhandhabung10 - 4 Changelog11 - 5 Anmerkungen11 + 1 Grundsätzliches3 + 1.1 Ports3 + 1.2 Paketformat3 + 2 Befehle4 + 2.1 Definitionen4 + 2.2 Ping6 + 2.3 Query6 + 2.4 Get Texture7 + 2.5 Get Texture File7 + 2.6 Get Texture Preview8 + 2.7 Replace Texture9 + 3 Fehlerhandhabung10 + 4 Changelog11 + 5 Anmerkungen11 - - Grundsätzliches + + Grundsätzliches Es wird eine Client-Server-Architektur verwendet. Um das Netzwerkprotokoll möglichst einfach und debuggbar zu halten, bietet sich JSON über TCP an. Dieses wird in eine eigene Paketstruktur verpackt, um so auch große Binär-Daten (z.B. Texturen) über die selbe Verbindung zu übertragen. Eine Verbindung wird immer vom Client initiiert. Nach jeder Anfrage kann der Client die Verbindung für weitere Anfragen offen halten oder diese zur Beendigung schließen. Der Server schließt Verbindungen bei Verletzungen des Protokolls oder wenn mindestens 10 Minuten lang kein Datenaustausch mehr stattgefunden hat. Ports Der Server verwendet TCP-Port 10796 für eingehende Verbindungen. Es wird sowohl IPv6 als auch IPv4 akzeptiert. - Paketformat + Paketformat Daten werden über TCP gesendet. Da TCP stream-based ist, wird folgende Struktur verwendet, um Pakete zu emulieren. - <Payload-Typ : 1 byte><Reseviert : 3 bytes><Payload-Länge : 4 bytes><Payload : Payload-Länge bytes> + <Payload-Typ : 1 byte><Reseviert : 3 bytes><Payload-Länge : 4 bytes><Payload : Payload-Länge bytes> Alle Zahlenwerte werden als Big-Endian übertragen. Mögliche Payload-Typen sind: @@ -178810,232 +178773,233 @@ - 0 = Error + 0 = Error - 1024 Bytes. (Siehe unten, Fehlerhandhabung für Details.) + 1024 Bytes. (Siehe unten, Fehlerhandhabung für Details.) - 1 = JSON + 1 = JSON - 16 MiB + 16 MiB - 2 = Binary + 2 = Binary - 512 MiB + 512 MiB Wird das maximale Payload überschritten, wird die Verbindung sofort geschlossen. Dies dient dazu, zu verhindern, dass ein Teilnehmer mehr Daten entgegen nimmt, als dieser im RAM behalten kann. - Befehle - Definitionen + Befehle + Definitionen Im Folgenden sind sind Datentypen für JSON definiert, welche in dem Protokoll wiederverwendet werden: Für String, Number, Array von <..> siehe JSON-Standart. UUID ::= <String> UUID nach Version 4 Beispiele - + - "a78c59fc-4198-421a-8ba4-db232ad7b91e" + "a78c59fc-4198-421a-8ba4-db232ad7b91e" - "1f010407-130f-432c-8463-6c61fdfb8c14" + "1f010407-130f-432c-8463-6c61fdfb8c14" - "ecb109bb-d9d6-494d-9d5e-b1e44734e20d" + "ecb109bb-d9d6-494d-9d5e-b1e44734e20d" - + Format ::= "png" | "jpeg" - Dateiformat - Beispiele - + Dateiformat + Beispiele + - "png" + "png" - "jpeg" + "jpeg" Resolution ::= [<Number>, <Number>] Die erste Nummer stellt die Weite in Pixeln dar, die Höhe in Pixeln wird durch die zweite Nummer repräsentiert. - Beispiele - + Beispiele + - [1024, 1024] + [1024, 1024] - [2048, 512] + [2048, 512] - [13, 400] + [13, 400] Tag ::= <String> Stellt ein Tag dar. Kann Groß- und Kleinbuchstaben beinhalten. Hinweis: Vergleiche von Tags sind nicht Case-Sensitiv. Die Darstellung in der UI jedoch unter Umständen schon. Beispiele - + - "Holz" + "Holz" - "mEtALL" + "mEtALL" - "Chesse Cake" + "Chesse Cake" Date ::= <String> - im Format "yyyy-MM-dd", siehe Javadoc unter java.text.SimpleDateFormat für mehr Informationen. + im Format "yyyy-MM-dd", siehe Javadoc unter java.text.SimpleDateFormat für mehr Informationen. Beispiele - + - "2019-03-04" + "2019-03-04" - "2017-12-21" + "2017-12-21" Hash ::= <String> - Sha256-Hash von z.B. Texturdaten oder anderen Binärdaten, in Hexadezimal-Darstellung. Kann Groß- oder Kleinbuchstaben enthalten. Dies wird genutzt, um auf diese zu verweisen. - Beispiele - + Sha256-Hash von z.B. Texturdaten oder anderen Binärdaten, in Hexadezimal-Darstellung. Kann Groß- oder Kleinbuchstaben enthalten. Dies wird genutzt, um auf diese zu verweisen. + Beispiele + - "a98f43a976e5b501961635b981022ebaf98321b97055ead4d8d4de55114015e7" + "a98f43a976e5b501961635b981022ebaf98321b97055ead4d8d4de55114015e7" - "02a08f7d697a93937cc5ace273a534c2eb021ae76b7c15ba146d279d57898893" + "02a08f7d697a93937cc5ace273a534c2eb021ae76b7c15ba146d279d57898893" - "A6A04ADC2E6D580B8E37CE8F4784652BE6D668EC1FB340B971DD8E8A582CE6BC" + "A6A04ADC2E6D580B8E37CE8F4784652BE6D668EC1FB340B971DD8E8A582CE6BC" - "7bdc65d8550b0A4FBC899550bbda87DAA2E780D618A66a1F7813967ECF6C0831" + "7bdc65d8550b0A4FBC899550bbda87DAA2E780D618A66a1F7813967ECF6C0831" Texture ::= {id: <UUID>,name: <String>,tags: <Array von <Tag>>,format : <Format>,resolution: <Resolution>,added_on: <Date>,texture_hash: <Hash>} Stellt einen Textur-Eintrag mit Metadaten dar. - - Ping + + Ping Dieser Befehl dient zum Überprüfen der Verbindung. Client sendet nach Schema: - type = JSON - { - "ping": {} - } + type = JSON + { + "ping": {} + } Server antwortet nach Schema: - type = JSON - { - "pong": {} - } - Query + type = JSON + { + "pong": {} + } + Query Client sendet nach Schema: Zusammenhänge Eingaben werden als <String> in einem Array übertragen. - type = JSON - { - "query": { - "query" : <Array of <String>> - } - } + type = JSON + { + "query": { + "query" : <Array of <String>> + } + } Server antwortet nach Schema: - type = JSON - <Array of <Texture>> - - Get Texture + type = JSON + <Array of <Texture>> + + Get Texture Client sendet nach Schema: - type = JSON - { - "get_texture": { - "id" : <UUID> | null, - "name" : <String> | null, - } - } - Hierbei muss entweder das Feld "id" oder das Feld "name" gesetzt werden. Andernfalls wird Fehler 400 Bad Request gesendet, + type = JSON + { + "get_texture": { + "id" : <UUID> | null, + "name" : <String> | null, + } + } + Hierbei muss entweder das Feld "id" oder das Feld "name" gesetzt werden. Andernfalls wird Fehler 400 Bad Request gesendet, Der Server antwortet nach Schema [Textur gefunden]: - type = JSON - <Texture> + type = JSON + <Texture> Der Server antwortet nach Schema [Textur unbekannt]: - type = JSONnull + type = JSONnull Get Texture File Client sendet nach Schema: - type = JSON - { - "get_texture_file": { - "texture_hash" : <Hash>, - } - } + type = JSON + { + "get_texture_file": { + "texture_hash" : <Hash>, + } + } Der Server antwortet nach Schema [Textur-Datei gefunden]: - type = Binary - Textur-Datei + type = Binary + Textur-Datei Der Server antwortet nach Schema [Textur-Datei unbekannt] - type = Error404 File Not Found. - - Get Texture Preview + type = Error404 File Not Found. + + Get Texture Preview Client sendet nach Schema: - type = JSON - { - "get_texture_preview": { - "texture_hash" : <Hash>, - } - } + type = JSON + { + "get_texture_preview": { + "texture_hash" : <Hash>, "desired_format" : <Format> + } + } + Das Feld "desired_format" gibt an, in welchem Dateiformat das Antwort-Previewbild sein wird. Der Server antwortet nach Schema [Textur-Datei gefunden]: - type = Binary - Textur-Preview + type = Binary + Textur-Preview Der Server antwortet nach Schema [Textur-Datei unbekannt]: - type = Error404 File Not Found. - - Replace Texture + type = Error404 File Not Found. + + Replace Texture Client sendet nach Schema: - type = JSON - { - "replace_texture": { - "old": <Texture> | null, - "new": <Texture> | null, - } + type = JSON + { + "replace_texture": { + "old": <Texture> | null, + "new": <Texture> | null, + } } Diese Anfrage dient dazu alte Texturen zu löschen und neue hinzufügen. Ein Löschen und gleichzeitiges Hinzufügen, ergibt ein Update der Textur. - Falls "old" != null, wird die hier angegebene Textur gelöscht. Wird diese nicht exakt gleich vorgefunden, schlägt diese Anfrage fehl (Fehler: 409 Conflict). In diesem Fall wird "new" nicht berücksichtigt. - Falls "new" != null, wird die hier angegebene Textur zum System hinzugefügt. Sollte die angegebene "new.id" oder der angegebene "new.name" schon vorhanden sein, schlägt diese Anfrage fehl (Fehler: 409 Conflict). + Falls "old" != null, wird die hier angegebene Textur gelöscht. Wird diese nicht exakt gleich vorgefunden, schlägt diese Anfrage fehl (Fehler: 409 Conflict). In diesem Fall wird "new" nicht berücksichtigt. + Falls "new" != null, wird die hier angegebene Textur zum System hinzugefügt. Sollte die angegebene "new.id" oder der angegebene "new.name" schon vorhanden sein, schlägt diese Anfrage fehl (Fehler: 409 Conflict). Diese Semantik wurde gewählt, damit ein Update atomar ist und doppelte Anfragen zu Fehlern führen. - Hinweis: Um zu überprüfen, ob ein Name bereits vergeben ist, sollte Get Texture verwendet werden. (IDs werden sowieso zufällig generiert.) + Hinweis: Um zu überprüfen, ob ein Name bereits vergeben ist, sollte Get Texture verwendet werden. (IDs werden sowieso zufällig generiert.) Der Server antwortet nach Schema ["texture_hash" bekannt]: - type = JSON - true + type = JSON + true Die Anfrage wird damit beendet. Der Server antwortet nach Schema ["texture_hash" unbekannt]: - type = JSON - { - "get_texture_file": { - texture_hash : <Hash>, - } - } + type = JSON + { + "get_texture_file": { + texture_hash : <Hash>, + } + } Woraufhin der Client die Textur-Datei sendet: - type = Binary - Textur-Datei + type = Binary + Textur-Datei Der Server bestätigt dies dann mit: - type = JSON - true - Fehlerhandhabung - Fehlerbeschreibungen sind nach folgendem Schema aufgebaut: - <Fehlercode in Dezimal, Ascii><Leerzeichen><Fehlertext> - Bsp: - + type = JSON + true + Fehlerhandhabung + Fehlerbeschreibungen sind nach folgendem Schema aufgebaut: + <Fehlercode in Dezimal, Ascii><Leerzeichen><Fehlertext> + Bsp: + - 500 Internal Server Error + 500 Internal Server Error - + Die Fehlercodes sind an HTTP-Statuscodes angelehnt. - Das Folgende ist eine Aufstellung möglicher Fehlernachrichten, auf die in teilen oben verwiesen wurde. Der Fehlertext kann von dieser Aufstellung abweichen, um genauere Informationen wiederzugeben. Ein Vergleich muss daher immer anhand der Fehlernummer durchgeführt werden. + Das Folgende ist eine Aufstellung möglicher Fehlernachrichten, auf die in teilen oben verwiesen wurde. Der Fehlertext kann von dieser Aufstellung abweichen, um genauere Informationen wiederzugeben. Ein Vergleich muss daher immer anhand der Fehlernummer durchgeführt werden. @@ -179053,71 +179017,71 @@ - 400 + 400 - Bad Request. + Bad Request. - Anfrage hat ungültiges Format. Hierzu zählen: - + Anfrage hat ungültiges Format. Hierzu zählen: + - Fehlerhalte Semantik. + Fehlerhalte Semantik. - Falsches Encoding. + Falsches Encoding. - 404 + 404 - File Not Found. + File Not Found. - Unbekannte Textur-Datei angefordert. + Unbekannte Textur-Datei angefordert. - 409 + 409 - Conflict. + Conflict. - Name oder Id bereits vorhanden. - Oder Löschversuch fehlgeschlagen, wegen möglicher Inkonsistenz. + Name oder Id bereits vorhanden. + Oder Löschversuch fehlgeschlagen, wegen möglicher Inkonsistenz. - 500 + 500 - Internal Server Error. + Internal Server Error. - Unerwartbare seltene Sonstige Fehler. Z.b. Festplatte nicht lesbar etc. + Unerwartbare seltene Sonstige Fehler. Z.b. Festplatte nicht lesbar etc. - 501 + 501 - Not Implemented. + Not Implemented. - Funktionalität wurde noch nicht implementiert. Dieser Fehlercode wird nur in der Entwicklungsphase verwendet. + Funktionalität wurde noch nicht implementiert. Dieser Fehlercode wird nur in der Entwicklungsphase verwendet. - - Changelog + + Changelog @@ -179131,50 +179095,58 @@ - 0.9.0 + 0.9.0 - - - 0.9.1 + + 0.9.1 - - Formulierung und Rechtschreibung + + Formulierung und Rechtschreibung - 0.10.0 + 0.10.0 - Füge Ping-Befehl hinzu. + Füge Ping-Befehl hinzu. - - 0.11.0 + + 0.11.0 - - Server darf Verbindungen schließen, Fehlerbeschreibungen festgelegt + + Server darf Verbindungen schließen, Fehlerbeschreibungen festgelegt - - 1.0.0 + + 1.0.0 - - Review fertig. + + Review fertig. - - 1.1.0 + + 1.1.0 - - + Fehlerhandhabung: Genauere Aufstellung in extra Abschnitt. + + + Fehlerhandhabung: Genauere Aufstellung in extra Abschnitt. + + + + + 1.2.0 + + + Füge "desired_format" zu Get Texture Preview hinzu. diff --git a/doc/feindesign/netzwerk-protokoll.pdf b/doc/feindesign/netzwerk-protokoll.pdf index f904127..006e0a9 100644 Binary files a/doc/feindesign/netzwerk-protokoll.pdf and b/doc/feindesign/netzwerk-protokoll.pdf differ