fb:porticula NoPaste
TSNE-API-DOKU
Uploader: | ThePuppetMaster |
Datum/Zeit: | 26.12.2007 03:16:11 |
##############################################################################################################
API-DOKU --- TSNE Version 2
##############################################################################################################
##############################################################################################################
2007 By.: /_\ DeltaLab's - Deutschland
Autor: Martin Wiemann
26.12.2006
##############################################################################################################
##############################################################################################################
Declare Function TSNE_Stats (ByVal V_TSNEID as UInteger, ByRef B_RX as ULongInt, ByRef B_TX as ULongInt) as Long
##############################################################################################################
Gibt Status Informationen zu einer bestehenden Verbindung aus.
--------------------------------------------------------------------------------------------------------------
Rückgabe = Die Rückgabe enthält eine GURU-ID
V_TSNEID = Eine gültige Verbindungs-Nummer übergeben
B_RX = Enthält nach dem Aufruf der Funktion die Anzahl von Bytes welche empfangen wurden
B_TX = Enthält nach dem Aufruf der Funktion die Anzahl von Bytes welche gesendet wurden
##############################################################################################################
Declare Function TSNE_Disconnect (ByVal V_TSNEID as UInteger) as Long
##############################################################################################################
Beendet eine bestehende Verbindung (Ob Server oder Client)
--------------------------------------------------------------------------------------------------------------
Rückgabe = Die Rückgabe enthält eine GURU-ID
V_TSNEID = Eine gültige Verbindungs-Nummer übergeben
##############################################################################################################
Declare Function TSNE_Create_Server (ByRef B_TSNEID as UInteger, ByRef V_Port as USHORT, ByRef MaxSimultanConnectionRequests as Long = 10, ByVal V_EventNewConPTR as any PTR) as Long
##############################################################################################################
Erstellt eine neue Server Verbindung.
--------------------------------------------------------------------------------------------------------------
Rückgabe = Die Rückgabe enthält eine GURU-ID
B_TSNEID = Enthält nach dem Aufruf die Verbindungs-Nummer der neuen Verbindung
V_Port = Gibt die Port-Nummer der neuen Verbindung an. (Mögliche Werte: 0 bis 65535)
MaxSimultanConnectionRequests = Gibt die Anzahl der Maximal gleichzeitigen Verbindungsanfragen an
V_EventNewConPTR = Ein Pointer auf die "NewConnection" Empfänger Sub Routine
##############################################################################################################
Declare Function TSNE_Create_Client (ByRef B_TSNEID as UInteger, ByVal V_IPA as String, ByVal V_Port as USHORT, ByVal V_EventDisconPTR as any PTR, ByVal V_EventConPTR as any PTR, ByVal V_EventNewDataPTR as any PTR) as Long
##############################################################################################################
Stellt eine Verbindung zu einem Server her.
--------------------------------------------------------------------------------------------------------------
Rückgabe = Die Rückgabe enthält eine GURU-ID
B_TSNEID = Enthält nach dem Aufruf die Verbindungs-Nummer der neuen Verbindung
V_IPA = Gibt die IP-Adresse des Servers an, mit dem die Verbindung hergestellt werden soll
V_Port = Gibt die Port-Nummer an mit der die Verbindung aufgebaut werden soll. (Mögliche Werte: 0 bis 65535)
V_EventDisconPTR = Ein Pointer auf die "Disconnect" Empfänger Sub Routine
V_EventConPTR = Ein Pointer auf die "Connect" Empfänger Sub Routine
V_EventNewDataPTR = Ein Pointer auf die "NewData" Empfänger Sub Routine
##############################################################################################################
Declare Function TSNE_Create_Accept (ByVal V_RequestID as Socket, ByRef B_TSNEID as UInteger, ByRef B_IPA as String, ByVal V_EventDisconPTR as any PTR, ByVal V_EventConPTR as any PTR, ByVal V_EventNewDataPTR as any PTR) as Long
##############################################################################################################
Akzeptiert eine neue Verbindung welche vom Server signalisiert wird.
--------------------------------------------------------------------------------------------------------------
Rückgabe = Die Rückgabe enthält eine GURU-ID
V_RequestID = Gibt die Socket-Nummer an welche vom Server signalisiert wurde
B_TSNEID = Enthält nach dem Aufruf die Verbindungs-Nummer der neuen Verbindung
B_IPA = Gibt die IP-Adresse der neuen Verbindung zurück
V_EventDisconPTR = Ein Pointer auf die "Disconnect" Empfänger Sub Routine
V_EventConPTR = Ein Pointer auf die "Connect" Empfänger Sub Routine
V_EventNewDataPTR = Ein Pointer auf die "NewData" Empfänger Sub Routine
##############################################################################################################
Declare Function TSNE_Data_Send (ByVal V_TSNEID as UInteger, ByRef V_Data as String) as Long
##############################################################################################################
Senden Daten an eine Verbindung
--------------------------------------------------------------------------------------------------------------
Rückgabe = Die Rückgabe enthält eine GURU-ID
= Ein Wert grösser 0 gibt die gesendeten Bytes an.
V_TSNEID = Eine gültige Verbindungs-Nummer übergeben
V_Data = Daten die an die Verbindung gesendet werden sollen
##############################################################################################################
Declare Sub TSNE_WaitClose (ByRef V_TSNEID as UInteger)
##############################################################################################################
Beendet diese Routine erst, wenn die angegebene Verbindung beendet wurde
--------------------------------------------------------------------------------------------------------------
V_TSNEID = Eine gültige Verbindungs-Nummer übergeben
##############################################################################################################
Declare Function TSNE_IsClosed (ByRef V_TSNEID as UInteger) as Long
##############################################################################################################
Prüft ob die angegebene Verbindung beendet wurde
--------------------------------------------------------------------------------------------------------------
Rückgabe = Die Rückgabe enthält eine GURU-ID
V_TSNEID = Eine gültige Verbindungs-Nummer übergeben
##############################################################################################################
Function TSNE_GetGURUCode(ByRef V_GURUID as Long) as String
##############################################################################################################
Gibt den Statustext zu einer GURU-ID zurück
--------------------------------------------------------------------------------------------------------------
0 = No error
-1 = Unknow error in function
-2 = Unknow EVENT-ID
-3 = No Socket found in V_SOCKET
-4 = Can't create socket
-5 = Can't bind port on socket
-6 = Can't set socket into listening-mode
-7 = Socket is already initalized
-8 = MaxSimultanConnectionRequests out of valid range
-9 = Port out of valid range
-10 = Can't resolve IP from Host
-11 = Can't connect to remote computer
-12 = TSNE-ID not found
Ansonsten = Unknow GURU-Code