XenoGuard Documentation

TCP Client Start

Actions » Windows » Network » TCP » TCP Client Start 

The action TCP Client Start initiates a TCP client in XenoGuard.


[-] Hide
  1. Open the Windows node in the Workspace Explorer.
  2. Open the Network node.
  3. In the TCP node, select the TCP Client Start action.

Parameters:

The action has the following input parameters:


name Description
Name
The name of the client.

Allowed Context Scopes [Fixed, Local, Global]
Allowed Context Types [Variable, Parameter, Enum]
Password
The password used to login into the server.

Allowed Context Scopes
[Fixed, Local, Global]
Allowed Context Types [Variable, Parameter, Enum]
Address
The IP address of the server where the client will connect.

Allowed Context Scopes [Fixed, Local, Global]
Allowed Context Types [Variable, Parameter, Enum]
Port
The designated port number to be used.

Default port number: 80

Allowed Context Scopes [Fixed, Local, Global]
Allowed Context Types [Variable, Parameter, Enum]
Timeout [ms]
The connection timeout in milliseconds.

Default value: 10000

Allowed Context Scopes [Fixed, Local, Global]
Allowed Context Types [Variable, Parameter, Enum]
Buffer Size [KB]
The amount of data that can be sent and received at a time.

Default value: 16384

Allowed Context Scopes [Fixed, Local, Global]
Allowed Context Types [Variable, Parameter, Enum]

Example 1 (Connect a TCP client to the TCP server):

This example creates two local variables, ServerIP and ServerPassword, with Text as data type and used as parameter values for the Address and Password, respectively. The action in the "Then" branch is executed if the TCP client has successfully started and is then output via Message Box. Otherwise, the action in the "Else" branch is executed.


See other TCP operations: