Socket configuration

After a Socket data source has been added, the configuration is displayed on the Runtime Configuration page of the Agent Editor. The Socket configuration section contains the following property:

Table 28. Socket configuration property
Name Valid values Required Description
Port number 0 or any positive integer

The default value is 0

Yes The port that the agent will use to listen on for data from socket clients. A value of 0 indicates an ephemeral port is to be used.

The agent writes the value of the port being used to a file. Socket clients running on the agent computer can later read this file to know which port to connect to. The file that the port is written to is named <kxx>_<instanceName>_cps.properties where: kxx is the 3 character product code of the agent and instanceName is the agent instance name for a multiple instance agent. If the agent is not a multiple instance agent, this part of the name is not included so the filename is simply kxx_cp.properties.

On Windows, the file is written to the %CANDLE_HOME%\TMAITM6 directory for 32-bit installations or %CANDLE_HOME%\TMAITM6_x64 for 64-bit installations. On UNIX, the file is written to /tmp.