TCPServer (1.1c)

Summary

TCPServer (1.1c)
_Class_TCPServer	Object that simplifiy the creation of Encrypted, multi-clients TCP Server.
Properties
ip	IP Address to listen
port	Port number to listen
max_recv_len	max # of characters to receive (TCPRecv)
Timeout	Receiving timeout (in ms).
Callback_NewClient	Function called when a new client connects to the server.
Callback_LostClient	Function called when a client disconnects from the server.
Callback_Recv	Function that is called when data (Binary/String) is received from a client
Callback_Receiving	Function that is called when being receiving data from a client
Callback_Timedout	Function that is called when a client is timed out
Functions
_Class_TCPServer	Class constructor
Startup	Starts the server.
Shutdown	Disconnect all clients, and shutdown the server
Process	Function that calls all the server callbacks when events occures (New client, Receiving...)
Send	Send data (Binary/String) to a client
Broadcast	Send data to all connected clients
Disconnect	Disconnect a specified client
DisconnectAll	Disconnect all connected clients.
NbrClients	Return the total number of connected clients.
SocketIDList	Return a 1-based array of all currently connected client’s socket ID
SocketID2IP	Return the IP of a given client’s socket
IP2SocketID	Return the socket ID of a given client’s IP
SocketID2hSocket	Return the Socket Handle of a client’s Socket ID
ClientPropertySet	Set an extended property of a client to a specified value
ClientPropertyGet	Get the value of a client’s extended property
ClientGetBufferLen	Return the current buffer lenght of a client

_Class_TCPServer

Object that simplifiy the creation of Encrypted, multi-clients TCP Server.

There can be only ONE server per script.

Summary

Properties
ip	IP Address to listen
port	Port number to listen
max_recv_len	max # of characters to receive (TCPRecv)
Timeout	Receiving timeout (in ms).
Callback_NewClient	Function called when a new client connects to the server.
Callback_LostClient	Function called when a client disconnects from the server.
Callback_Recv	Function that is called when data (Binary/String) is received from a client
Callback_Receiving	Function that is called when being receiving data from a client
Callback_Timedout	Function that is called when a client is timed out
Functions
_Class_TCPServer	Class constructor
Startup	Starts the server.
Shutdown	Disconnect all clients, and shutdown the server
Process	Function that calls all the server callbacks when events occures (New client, Receiving...)
Send	Send data (Binary/String) to a client
Broadcast	Send data to all connected clients
Disconnect	Disconnect a specified client
DisconnectAll	Disconnect all connected clients.
NbrClients	Return the total number of connected clients.
SocketIDList	Return a 1-based array of all currently connected client’s socket ID
SocketID2IP	Return the IP of a given client’s socket
IP2SocketID	Return the socket ID of a given client’s IP
SocketID2hSocket	Return the Socket Handle of a client’s Socket ID
ClientPropertySet	Set an extended property of a client to a specified value
ClientPropertyGet	Get the value of a client’s extended property
ClientGetBufferLen	Return the current buffer lenght of a client

Properties

ip

IP Address to listen

port

Port number to listen

max_recv_len

max # of characters to receive (TCPRecv)

Timeout

Receiving timeout (in ms).

When this timeout is reached, the buffer is fluched, and the data that was being transfered is lost.

See Callback_Timedout

Callback_NewClient

Function called when a new client connects to the server.

The function must be as this prototype

_Func($iSocket, $sIP)

$iSocket	Socket ID of the client
$sIP	IP Adress of the client

Callback_LostClient

Function called when a client disconnects from the server.

The function must be as this prototype

_Func($iSocket, $sIP)

$iSocket	Socket ID of the client
$sIP	IP Adress of the client

Callback_Recv

Function that is called when data (Binary/String) is received from a client

The function must be as this prototype

_Func($iSocket, $sIP, $s_bData)

$iSocket	Socket ID of the client
$sIP	IP Adress of the client
$s_bData	Received data (Binary/String)

Callback_Receiving

Function that is called when being receiving data from a client

The function must be as this prototype

_Func($iSocket, $sIP, $BufferLenght)

$iSocket	Socket ID of the client
$sIP	IP Adress of the client
$BufferLenght	Lenght of the client’s receiving buffer (Not equal to the final lenght/size of the received data, it’s just an indication)

Callback_Timedout

Function that is called when a client is timed out

The function must be as this prototype

_Func($iSocket, $sIP, $BufferLenght_LostData)

$iSocket	Socket ID of the client
$sIP	IP Adress of the client
$BufferLenght_LostData	Lenght of the buffer when timed out, corresponds to the amount of lost data (because buffer is flushed when time out occures)

Functions

_Class_TCPServer

Class constructor

Parameters

$ip	Value to assign to ip
$port	Value to assign to port
$max_clients	Maximum number of clients at the same time
$Ext_Info_Nbr	Number of extended data that can be associated with each client (see ClientPropertySet & ClientPropertyGet)
$encrypt_pwd	Data encryption password. Must be the same as in the clients.

Startup

Starts the server.

Parameters

$cb_NewClient	Value to assign to Callback_NewClient
$cb_LostClient	Value to assign to Callback_LostClient
$cb_Recv	Value to assign to Callback_Recv
$cb_Receiving	Value to assign to Callback_Receiving
$cb_Timedout	Value to assign to Callback_Timedout

Return value

Success	Returns main socket identifier.
Failure	Returns 0 and set @error to:

1 IPAddr is incorrect.
2 port is incorrect.

windows API WSAGetError return value (see MSDN).

Shutdown

Disconnect all clients, and shutdown the server

Return value

Success	Returns 1.
Failure	Returns 0 and set @error = windows API WSAGetError return value (see MSDN).

Process

Function that calls all the server callbacks when events occures (New client, Receiving...)

Remark

This function must be called in loop, or in AdlibRegister

Send

Send data (Binary/String) to a client

Parameters

$iSocket	Socket ID of the client
$s_bData	The data to be sent (Binary/String)

Return value

Success	Returns number of bytes sent to the server.
Failure	Returns 0 and set @error = windows API WSAGetError return value (see MSDN).

Broadcast

Send data to all connected clients

Parameters

$s_bData

Data to be sent (Binary/String)

Return value

Success	Number of clients that data was sent to them successfully, @extended = Percentage of succes (Return value / Total number of clients)
Failure	0 and

@error = 1 -> Server not started @error = 2 -> No any client received data

Disconnect

Disconnect a specified client

Parameters

$iSocket

Socket ID of the client to disconnect

DisconnectAll

Disconnect all connected clients.

Return

Success	1
Failure	0 (The server is not started)

NbrClients

Return the total number of connected clients.

SocketIDList

Return a 1-based array of all currently connected client’s socket ID

Return value

1-based array of connected sockets ID, $elem[0] = Number of sockets

SocketID2IP

Return the IP of a given client’s socket

Parameters

$iSocket

Socket ID of a client

Return value

Succes	The IP Address
Failed	0 And

@error = 1 -> Invalide SocketID @error = 2 -> No such SocketID connected

IP2SocketID

Return the socket ID of a given client’s IP

Parameters

$sIP	IP of a client

Return value

Succes	SocketID of the corresponding IP Address
Failed	0 And set @error = 1

SocketID2hSocket

Return the Socket Handle of a client’s Socket ID

Parameters

$iSocket

Socket ID of a client

Return value

Succes	Socket Handle (usable by native TCP functions) of the corresponding SocketID
Failed	-1 And

@error = 1 -> Invalide SocketID @error = 2 -> No such SocketID connected

ClientPropertySet

Set an extended property of a client to a specified value

Parameters

$hSocket	Socket ID of the client
$iIndex	Index of the property we want to modifie (0-based)
$Data	Data to assign to the property

Return value

Succes	1
Failed	0 If invalid SocketID or Extended property ID

ClientPropertyGet

Get the value of a client’s extended property

Parameters

$hSocket	Socket ID of the client
$iIndex	Index of the property we want to get (0-based)

Return value

Succes	The value of the Extended Property
Failed	0 If invalid SocketID or Extended property ID

ClientGetBufferLen

Return the current buffer lenght of a client

Parameters

$iSocket

SocketID of a client

Return value

Succes	Binary Lenght of the client’s buffer
Failed	-1 If invalid SocketID