TCPClient (1.1b)

Summary

TCPClient (1.1b)
_Class_TCPClient	Object that simplifiy the creation of Encrypted TCP Client
Properties
server_ip	IP Adress of the server
server_port	Port number of the server
max_recv_len	max # of characters to receive (TCPRecv)
Timeout	Receiving timeout (in ms).
Callback_Recv	Function that is called when data (Binary/String) is received from the server
Callback_Receiving	Function that is called when being receiving data from the server
Callback_LostConnection	Function that is called when the connection with the server is lost.
Callback_Timedout	Function that is called when a client is timed out
Functions
_Class_TCPClient	Class constructor
Connect	Try to connect to the server specified by server_ip and server_port
Disconnect	Disconnect from the server
IsConnected	Check if the client is connected to a server
Send	Send data (Binary/String) to the server
Process	Function that calls all the client’s callbacks when events occures (Receiving, Lost connection...)

_Class_TCPClient

Object that simplifiy the creation of Encrypted TCP Client

Summary

Properties
server_ip	IP Adress of the server
server_port	Port number of the server
max_recv_len	max # of characters to receive (TCPRecv)
Timeout	Receiving timeout (in ms).
Callback_Recv	Function that is called when data (Binary/String) is received from the server
Callback_Receiving	Function that is called when being receiving data from the server
Callback_LostConnection	Function that is called when the connection with the server is lost.
Callback_Timedout	Function that is called when a client is timed out
Functions
_Class_TCPClient	Class constructor
Connect	Try to connect to the server specified by server_ip and server_port
Disconnect	Disconnect from the server
IsConnected	Check if the client is connected to a server
Send	Send data (Binary/String) to the server
Process	Function that calls all the client’s callbacks when events occures (Receiving, Lost connection...)

Properties

server_ip

IP Adress of the server

server_port

Port number of the server

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.

Callback_Recv

Function that is called when data (Binary/String) is received from the server

The function must be as this prototype

_Func($s_bData)

$s_bData

Received data (Binary/String)

Callback_Receiving

Function that is called when being receiving data from the server

The function must be as this prototype

_Func($BufferLenght)

$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_LostConnection

Function that is called when the connection with the server is lost.

Has no parameters

Callback_Timedout

Function that is called when a client is timed out

The function must be as this prototype

_Func($BufferLenght_LostData)

$BufferLenght_LostData

Lenght of the buffer when timed out, corresponds to the amount of lost data (because buffer is flushed when time out occures)

See Timeout

Functions

_Class_TCPClient

Class constructor

Parameters

$ip	Value to assign to server_ip
$port	Value to assign to server_port
$encrypt_pwd	Data encryption password. Must be the same as in the server.

Connect

Try to connect to the server specified by server_ip and server_port

Parameters

$cb_Recv	Value to assign to Callback_Recv
$cb_Receiving	Value to assign to Callback_Receiving
$cb_LostConnection	Value to assign to Callback_LostConnection
$cb_TimedOut	Value to assign to Callback_Timedout

Return value

Success	Returns 1. @extended = Main socket identifier.
Failure	Returns 0 and set @error to:

1 IPAddr is incorrect.
2 port is incorrect.

@extended = windows API WSAGetError return value (see MSDN).

Disconnect

Disconnect from the server

Return value

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

IsConnected

Check if the client is connected to a server

Return value

Succes

1 If connect, 0 If not connected

Send

Send data (Binary/String) to the server

Parameters

$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).

Remark

If you want to send the ‘ char, you must send ‘’

Process

Function that calls all the client’s callbacks when events occures (Receiving, Lost connection...)

Remark

This method must be called in loop.