TCP Adapter
Properties Configuration Settings
The TCP Adapter can be used to send data over TCP.
Remarks
The TCP Adapter can be used to send data over TCP.
TCP Send Adapter
The TCP Send Adapter provides a light-weight TCP client. To begin Server and Port must be specified.
Specify the data to be sent in DataToSend. Upon execution the adapter will connect to the server and send DataToSend. The adapter will then wait for the server to signal the end of the response by looking for ExpectedResponse in the returned value. When detected the execution will complete and the response will be available in the Response property.
Additional scripting properties BeforeSend and AfterSend provide additional flexibility allowing any number of commands and operations to be performed.
Please refer to the section on adapter configuration for a description of how to configure receive locations and send ports for this adapter.
Sender Property List
The following is the full list of the properties of the sender adapter with short descriptions. Click on the links for further details.
AfterSend | A set of commands to be executed after DataToSend is sent. |
BeforeSend | A set of Tcp commands to be executed before DataToSend is sent. |
ConnectionLifetime | Instructs the adapter whether or not to leave the connection to the server open. |
DataToSend | The data to be sent to the server. |
ErrorOnTimeout | If enabled, reaching the timeout will not throw an error. |
ExpectedResponse | The expected response. |
ExpectedResponseExpression | A regular expression to match the response returned by the server. |
Firewall | A set of properties related to firewall access. |
MaxPersistentConnections | The maximum number of simultaneous persistent connections when sending. |
MaxThreads | The maximum number of threads that the adapter may consume. |
MaxTransmissionBatchSize | The maximum number of messages that can be sent in a single batch. |
Other | Defines a set of configuration settings to be used by the adapter. |
Port | The remote port for the Server (default is 23). |
Response | The response from server. |
RuntimeLicense | Specifies the adapter runtime license key. |
Server | The address of the Server. |
SSLAcceptServerCert | Instructs the adapter to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | The certificate to use for client authentication during the SSL handshake. |
SSLStartMode | Determines how the adapter starts the SSL negotiation. |
Timeout | A timeout for the adapter. |
TransmitBatchMode | How the transmitter processes batches. |
TransportLog | Tells the adapter where and how to report information about its operations. |
URI | The Uniform Resource Identifier (URI) of the send port or receive location. |
Configuration Settings
The following is a list of configuration settings for the adapter with short descriptions. Click on the links for further details.
ReturnScriptResponse | Whether to include script output in response data. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseManagedSecurityAPI | Tells the adapter whether or not to use the system security libraries or a managed implementation. |
PersistedConnectionTimeout | How long to leave a persisted connection alive. |