TCP Server Adapter

The TCP Server Adapter receives connections from one or more TCP clients. These clients send data streams to the adapter. The adapter passes the data stream to a parser. The parser parses the data stream into data tokens, which the mapping function converts into events.

Note

You cannot use Telnet as a means for communicating with the TCP Server Adapter. The TCP Server Adapter does not recognize incoming Telnet commands as meaningful binary control codes. Instead, the adapter interprets Telnet information as raw data.

The following table describes the TCP Client Adapter parameters.

TCP Server Adapter configuration parameters

ParameterDescription
instanceName

Name of the adapter instance The instance name is the first entry in the adapter configuration and must be enclosed in square brackets. 

Required

Note

To run more than one instance of the adapter, specify a unique name and configuration for each adapter instance.

EngineType of adapter in use 

Required 

Valid value: MA::Adapter::TcpServer
LocalHost

Local IP address on a computer with multiple network interfaces to which the TCP Server adapter binds 

Specify a value for this parameter only when the adapter is on a computer that has multiple network interfaces. By default, the adapter will bind to the default interface. 

Valid values: Host name or IP address

Note

Do not specify localhost127.0.0.1, orINADDR_ANY as a value for this parameter.

LocalPortLocal port number on which the TCP Server Adapter listens for connections 

Default:1999
MapfileName of the MAP file used to generate events from the tokenized data 

Required
MaxClientsMaximum number of clients allowed to connect simultaneously to the TCP Server Adapter 

Default:10
Parser

Parser instance that must be used to parse and tokenize the client input stream 

You must code the name of another section in themcxa.conf file that defines a parser with a unique name. It is not valid to code the name of a parser type as it would be used in the Engine parameter.

Example

Parser = ParseSyslog where ParseSyslog is the unique name for a parser definition, such as the following: 
[ParseSyslog] 
Engine = MA::Parser::FixedWidth 
In the adapter definition, do not code as follows:Parser = MA::Parser::FixedWidth

RestartIntervalInterval, in seconds, at which the TCP Server Adapter reattempts to bind to the local port if that port is busy when the adapter makes its first bind attempt 

Default:30

The following figure shows a sample TCP Server Adapter configuration, as it would appear in the mcxa.conf file. 


Sample TCP Server Adapter Configuration

[MyTcpServer]
Engine = MA::Adapter::TcpServer
MaxClients = 10
RestartInterval = 30
MapFile = mctcpsrv.map
LocalHost = 127.0.0.5
LocalPort = 1999
Parser = MyFixedWidthParser

Diagnostics

All adapter errors are logged as events. Optionally, you can enable tracing by setting the tracing parameters in the global section of the mcxa.conf file. For more information, see About the mcxa.conf file.

The TCP Server Adapter can generate an ERR_RECV error, which indicates that a problem occurred when receiving data from the server. For more information, see the event that is created for this error.

Was this page helpful? Yes No Submitting... Thank you

Comments