Tutorial
Netzwerkprogrammierung mit TSNE_V3
"API" bedeutet übersetzt "Application Programming Interface" bzw. auf Deutsch: "Programm-Programmierungs-Schnittstelle". Darunter versteht man eine Sammlung von Funktionen oder Sub-Routinen, die bestimmte Aufgaben vereinfacht ermöglichen.
TSNE nutzt eine sehr einfache und strukturierte API. Bezeichnungen der Funktionen und Parameter sind teilweise codiert und ermöglichen so schon beim Betrachten der API-Funktion herauszufinden, was für Informationen an welcher Stelle benötigt werden oder welche Werte zurückgeliefert werden.
Zuerst einmal ist zu erwähnen, dass jede Art von Funktion oder Sub-Routine von TSNE grundsätzlich mit dem Präfix "TSNE_" beginnt.
Funktionsparameter sind ebenfalls teilweise codiert, also einer bestimmten Nomenklatur unterworfen. So findet sich vor jedem Parameter entweder ein "R_", ein "V_" oder ein "RV_".
- R_ steht für Return und bedeutet soviel wie, dass hier ein Wert von TSNE in die angegebene Variable geschrieben wird.
- V_ steht für Value und bedeutet entsprechend, dass TSNE hier einen Wert benötigt, um die Funktion durchführen zu können.
- RV_ steht für Return und Value zugleich. Hier muss ein Parameter übergeben werden, um die Funktion ausführen zu können. TSNE kann jedoch diesen Wert auch abändern und in die Variable zurückspeichern.
Kurz zusammengefasst: Die meisten Parameter sind "didaktisch" so gewählt, dass deren Bezeichnung das angibt, was benötigt bzw. was zurückübermittelt werden wird.
Beispiele:
So gibt z.B. "V_TSNEID" an, dass hier eine TSNEID an die Funktion übergeben werden muss.
"R_TSNEID" signalisiert, dass die Funktion eine neu erzeugte TSNEID in die angegebene Variable speichern wird.
"V_IPA" bzw. "R_IPA" verlangt bzw. übermittelt die IP-Adresse.
"V_Port" einen Port von 1 bis 65535.
usw.
Genauer wird auf die Parameter in der aktuellen API-Beschreibung von TSNE eingegangen. Diese Datei findet sich auf der Projektseite von TSNE (ganz unten). In dieser Datei werden auch jene Funktionen beschrieben, die derzeit verfügbar sind.
Solltet ihr die Funktionen im TSNE-Modul selbst betrachten, dann werdet ihr auf Bezeichnungen stoßen, die mit "TSNE_INT_" beginnen. Diese internen Variablen und Funktionen sind NICHT für den Programmierer selbst gedacht, sondern sind ausschließlich für die Verwaltung durch TSNE nötig. Diese Funktionen und Variablen sollten keinesfalls "manuell" ausgeführt bzw. verändert werden, da dies zu schwerwiegenden Problemen bei der Verwaltung der erzeugten Sockets führen oder gar das Programm zum Absturz bringen könnte.
Wie schon erwähnt, sind alle Funktionsnamen so gewählt, dass sie aussagen, was die jeweilige Funktion bewirkt.
Beispiele:
"TSNE_Create_xxx" sagt folglich aus, dass das TSNE-Modul ein Socket erzeugt.
"TSNE_Create_Server" gibt an, dass TSNE ein Server-Socket erzeugt.
"TSNE_Create_Client" zeigt, dass TSNE ein Client-Socket erzeugt.
Zusätzliche Informationen und Funktionen |
- Das Tutorial wurde am 19.07.2009 von ThePuppetMaster angelegt.
- Die aktuellste Version wurde am 15.10.2018 von grindstone gespeichert.
|
|