SocketConnect (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Optimizing the connections for an IP address
Timeout

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

SocketConnect (Function)

In french: SocketConnecte

Connects a client computer to a given socket.

Remarks:

UDP sockets: The UDP protocol being a "connectionless" protocol, SocketConnect cannot be used with the UDP protocol. To send or receive data with the UDP protocol, you must create a UDP socket (SocketCreateUDP) then send/receive data with the "special UDP" syntaxes of SocketWrite and SocketRead.
SSL sockets: To send or receive data with the SSL protocol, you must create an SSL socket (SocketCreateSSL) and connect to this socket with SocketConnectSSL.
Communication with robots or with non-WINDEV applications: To simplify the exchanges of data by socket, a transmission mode is initialized by default. For a communication with an external module (non-WINDEV application, robot, ...), this transmission mode can prevent the communications from operating properly. SocketChangeTransmissionMode is used to change this transmission mode (the SocketNoEndTag constant allows you not to modify the frames read and written).
Versions 22 and later
Websockets: The WebSockets are used to communicate from a Web application (Intranet or Internet site run in a browser) to a Web server by using sockets. SocketConnect is used to connect to the WebSocket server. For more details, see Managing WebSockets.
Warning
From version 27, it is recommended to use WebSocketClientConnect and WebSocketClientConnectSSL to connect to the WebSocket server.

New in version 22
Websockets: The WebSockets are used to communicate from a Web application (Intranet or Internet site run in a browser) to a Web server by using sockets. SocketConnect is used to connect to the WebSocket server. For more details, see Managing WebSockets.
Warning
From version 27, it is recommended to use WebSocketClientConnect and WebSocketClientConnectSSL to connect to the WebSocket server.

Websockets: The WebSockets are used to communicate from a Web application (Intranet or Internet site run in a browser) to a Web server by using sockets. SocketConnect is used to connect to the WebSocket server. For more details, see Managing WebSockets.
Warning
From version 27, it is recommended to use WebSocketClientConnect and WebSocketClientConnectSSL to connect to the WebSocket server.

Reminder: A socket is a communication resource used by applications to communicate from one computer to another regardless of the type of network.

Versions 22 and later

This function is now available in browser code.

New in version 22

This function is now available in browser code.

Example

IF SocketConnect("Server", 8000) = False THEN
Error("Connection error" + ErrorInfo(errMessage))
END

Versions 22 and later

SocketConnect("client", "ws[s]://<WebSocketServerAddress>", OnSocketEvent)

INTERNAL PROCEDURE OnSocketEvent(nEvent, sMessage)

SWITCH nEvent

CASE SocketOpening
SocketWrite("client", "Send message from the browser.")

CASE SocketMessage
Info("Server message received: " + sMessage)

CASE SocketClosing
Info("Socket closed", sMessage)

CASE SocketError
Error("Socket error")
END
END

New in version 22

Syntax

Connecting to a socket Hide the details

<Result> = SocketConnect(<Socket name> , <Port number> [, <Address> [, <Maximum timeout>]])

<Result>: Boolean

True if the function was successful,
False otherwise. If an error occurs, you can get more details on the error with ErrorInfo.

<Socket name>: Character string

Name that will be given to the connection opened on the server socket. This name will be used by all socket functions.

<Port number>: Integer

Port number of the socket. If you are using a socket associated with a preset protocol, use the port number associated with the protocol.
If the socket was created by a WINDEV application, this number must be included between 5 000 and 65 000. In this case, the number must be identical to the port number specified in SocketCreate.

<Address>: Optional character string

Server address. If this parameter is not specified, the server is sought on the current computer. This address can be given in the following format:
IP address in XXX.XXX.XXX.XXX format (125.5.110.100 for example).
URL containing the server name (www.windev.com for example). This syntax is recommended.
The address can also correspond to the IP address returned by NetIPAddress.

<Maximum timeout>: Optional integer or optional Duration

Maximum timeout (in milliseconds) for establishing the connection. This timeout will be used if the server refuses the connection (SocketDeny). In this case, the connection will not be locking. This parameter can correspond to:
an integer corresponding to the number of milliseconds,
a Duration variable,
Versions 23 and later
the duration in a readable format (e.g., 1 s or 10 ms).
New in version 23
the duration in a readable format (e.g., 1 s or 10 ms).
the duration in a readable format (e.g., 1 s or 10 ms).
This timeout is set to 5000 milliseconds by default (5 seconds). For more details, see the remarks.
This parameter is ignored.

Versions 22 and later

Warning
From version 27, it is recommended to use WebSocketClientConnect and WebSocketClientConnectSSL to connect to the WebSocket server.

Connecting to a WebSocket Hide the details

SocketConnect(<Socket name> , <Address> , <Browser WLanguage procedure> [, <Protocol(s)>])

<Socket name>: Character string

Name that will be given when connecting to the server. This name will be used by all socket functions. Caution: The socket name is case sensitive.

<Address>: Character string

Address of the WebSocket server that will be used for the connection. This address has the following format: ws[s]://server[:port][/directoryX/.../]. In this case:
the ws prefix indicates that the server is a WebSocket server. wss is used for a secure WebSocket server.
server corresponds to the server address in the following format: server name, server domain name or IP address.
port corresponds to the number of the communication port used to dialog with the server. This number must be identical to the port number specified in SocketCreate if the WebSocket server was created in WLanguage with WINDEV or WEBDEV.
directoryX corresponds to the possible virtual directories of server.

<Browser WLanguage procedure>: Procedure name

Name of the WLanguage procedure ("callback") written in browser code. Name of the procedure called when the connection to the server is established. This procedure can be used to send a message to the server with SocketWrite, for example.
For more details on this procedure, see Parameters of the procedure used by SocketConnect.

<Protocol(s)>: String or array of strings (optional)

Protocol(s) corresponding to the format of the WebSocket response. For example: "JSON", "XML". If this parameter is not specified or is an empty string, no protocol is used.

New in version 22

Warning
From version 27, it is recommended to use WebSocketClientConnect and WebSocketClientConnectSSL to connect to the WebSocket server.

Connecting to a WebSocket Hide the details

SocketConnect(<Socket name> , <Address> , <Browser WLanguage procedure> [, <Protocol(s)>])

<Socket name>: Character string

Name that will be given when connecting to the server. This name will be used by all socket functions. Caution: The socket name is case sensitive.

<Address>: Character string

Address of the WebSocket server that will be used for the connection. This address has the following format: ws[s]://server[:port][/directoryX/.../]. In this case:
the ws prefix indicates that the server is a WebSocket server. wss is used for a secure WebSocket server.
server corresponds to the server address in the following format: server name, server domain name or IP address.
port corresponds to the number of the communication port used to dialog with the server. This number must be identical to the port number specified in SocketCreate if the WebSocket server was created in WLanguage with WINDEV or WEBDEV.
directoryX corresponds to the possible virtual directories of server.

<Browser WLanguage procedure>: Procedure name

Name of the WLanguage procedure ("callback") written in browser code. Name of the procedure called when the connection to the server is established. This procedure can be used to send a message to the server with SocketWrite, for example.
For more details on this procedure, see Parameters of the procedure used by SocketConnect.

<Protocol(s)>: String or array of strings (optional)

Protocol(s) corresponding to the format of the WebSocket response. For example: "JSON", "XML". If this parameter is not specified or is an empty string, no protocol is used.

Warning
From version 27, it is recommended to use WebSocketClientConnect and WebSocketClientConnectSSL to connect to the WebSocket server.

Connecting to a WebSocket Hide the details

SocketConnect(<Socket name> , <Address> , <Browser WLanguage procedure> [, <Protocol(s)>])

<Socket name>: Character string

Name that will be given when connecting to the server. This name will be used by all socket functions. Caution: The socket name is case sensitive.

<Address>: Character string

Address of the WebSocket server that will be used for the connection. This address has the following format: ws[s]://server[:port][/directoryX/.../]. In this case:
the ws prefix indicates that the server is a WebSocket server. wss is used for a secure WebSocket server.
server corresponds to the server address in the following format: server name, server domain name or IP address.
port corresponds to the number of the communication port used to dialog with the server. This number must be identical to the port number specified in SocketCreate if the WebSocket server was created in WLanguage with WINDEV or WEBDEV.
directoryX corresponds to the possible virtual directories of server.

<Browser WLanguage procedure>: Procedure name

Name of the WLanguage procedure ("callback") written in browser code. Name of the procedure called when the connection to the server is established. This procedure can be used to send a message to the server with SocketWrite, for example.
For more details on this procedure, see Parameters of the procedure used by SocketConnect.

<Protocol(s)>: String or array of strings (optional)

Protocol(s) corresponding to the format of the WebSocket response. For example: "JSON", "XML". If this parameter is not specified or is an empty string, no protocol is used.

Remarks

Optimizing the connections for an IP address

When an IP address is passed to SocketConnect, the connection can be optimized by using the following code:

Socket.Option = SocketOptimizeIPConnection

This option is not enabled by default because the connection may fail in some configurations. However, it may be useful in some applications for which the performance is critical.

Remark: To restore the default behavior, simply use the SocketOptionDefault constant:

Socket.Option = SocketOptionDefault

Timeout

The timeout specified by <Maximum timeout> groups the timeout of two steps:

the timeout for address resolution: this timeout cannot be configured and it can be optimized (see below).
the maximum timeout for the connection to be accepted by the server. Several cases may occur:
- the server refuses the connection.
- the server accepts the connection within the timeout.
- the server is not available.
- the specified address is invalid.

To optimize the timeout for address resolution (time required to find the address), we advise you to:

use a DNS on the network. Therefore, this address will be sought toward this server and not for each computer (1 search instead of x searches where x represents the number of computers). Each computer must be registered toward this server.
for an IP address, use the Socket.Option variable as follows:

Socket.Option = SocketOptimizeIPConnection

Component: wd270com.dll