XenoGuard 4.0 Documentation

TCP Server Statistic

ActionStep Reference » Windows » Network » TCP » TCP Server Statistic 

The TCP Server Statistics ActionStep retrieves a list of clients currently connected to the TCP server, displaying each client's ID, Address, Port, Message Count, and a Boolean value indicating whether the client is Blocked or Closed.


[-] Hide
  1. Open the Windows node in the Workspace Explorer.
  2. Open the Network node.
  3. In the TCP node, select the TCP Server Statistic ActionStep.

Parameters:

The ActionStep has the following input parameters:


name Description
Name
The name of the TCP server.

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

Results:

The ActionStep returns the following results:


name
description
Client Count
The number of clients on the list.

Allowed Context Scope [Fixed]
Allowed Context Types [Variable, Parameter]
Client
The information about the client in the server's list.

Parameter for the "Client" sub-branch:

  • Id - the unique id of the client
  • Address - the IP address of the client
  • Port - the port number used by the client
  • Message Count - the number of received messages from the client
  • Blocked - the state of the client connection being blocked
  • Closed - the state of client connection being closed
Allowed Context Scopes [Fixed, Local, Global]
Allowed Context Types [Variable, Parameter]

Example 1 (Number of connected clients to the TCP server):

This example runs a TCP server and waits for 5 seconds to allow TCP clients to connect. The number of clients that are able to send messages to the TCP server is retrieved. The result is then displayed via Message Box.


See other TCP operations: