TCP Sender
This destination connector opens a new TCP client connection and sends messages over it. You can decide whether to keep a connection open, and if so for how long. Configurable transmission modes allow you to decide how to send outbound messages and receive responses.
Supported property groups:
| Item | Name | Default Value | Description |
|---|---|---|---|
| A | Transmission Mode | MLLP | The transmission mode determines how to send message data out on the socket byte stream, and how to receive responses. For additional information, see TCP Listener |
| B | Sample Frame | <VT> <Message Data> <FS><CR> | This is dependent on the Transmission Mode and displays an example of how an outgoing message frame is expected to look. |
| C | Mode | Client |
|
| D | Remote Address | 127.0.0.1 | The domain name or IP address on which to connect. Select the Test Connection button to verify whether the server is able to open a TCP connection as the specified IP/port. Only applicable when Client mode is used above. |
| E | Remote Port | 6660 | The port on which to connect. Only applicable when Client mode is used above. |
| F | Override Local Binding | No | Select Yes to override the local address and port that the client socket will be bound to. Select No to use the default values of 0.0.0.0:0. A local port of zero (0) indicates that the OS should assign an ephemeral port automatically. Note that if a specific (non-zero) local port is chosen, then after a socket is closed it is up to the underlying OS to release the port before the next socket creation, otherwise the bind attempt will fail. Only applicable when Client mode is used above. |
| G | Local Address | 0.0.0.0 | The local address that the client socket will be bound to, if Override Local Binding is enabled. If Server mode is used above, this will determine what interfaces to listen on for incoming connections. |
| H | Local Port | 0 | The local port that the client socket will be bound to, if Override Local Binding is enabled. Note that if a specific (non-zero) local port is chosen, then after a socket is closed it is up to the underlying OS to release the port before the next socket creation, otherwise the bind attempt will fail. If Server mode is used above, this will determine what port to listen on for incoming connections. |
| I | Max Connections | 10 | The maximum number of client connections to accept at once. After this number has been reached, subsequent socket requests will result in a rejection. Only applicable when the Server mode is used above |
| J | Keep Connection Open | No | Select Yes to keep the connection to the host open across multiple messages. Select No to immediately close the connection to the host after sending each message. Only applicable when Client mode is used above. |
| K | Check Remote Host | No | Select Yes to check if the remote host has closed the connection before each message. Select No to assume the remote host has not closed the connection. Checking the remote host will decrease throughput but will prevent the message from erroring if the remote side closed the connection and queuing is disabled. Only applicable when Client mode is used above. |
| L | Send Timeout (ms) | 5000 | The number of milliseconds to keep the connection to the host open, if Keep Connection Open is enabled. If zero, the connection will be kept open indefinitely. Only applicable when Client mode is used above. |
| M | Buffer Size (bytes) | 65536 | The size, in bytes, of the buffer to hold messages waiting to be sent. Generally, the default value is fine. |
| N | Response Timeout (ms) | 5000 | The number of milliseconds the connector should wait whenever attempting to create a new connection or attempting to read from the remote socket. If Ignore Response is checked, the connector will not wait for a response at all after sending a message. |
| O | Queue on Response Timeout | Yes | If enabled, the message is queued when a timeout occurs while waiting for a response. Otherwise, the message is set to ERROR when a timeout occurs. This setting has no effect unless queuing is enabled for the connector. |
| P | Data Type | Text | Select Binary if the outbound message is a Base64 string (will be decoded before it is sent out). Select Text if the outbound message is textual (will be encoded with the specified character set encoding). |
| Q | Encoding | Default | Select the character set encoding used by the message sender, or select Default to use the default character set encoding for the JVM Mirth® Connect by NextGen Healthcareis running on. |
| R | Template | ${message.encodedData} | The actual payload to send to the remote server. By default the encoded data of this destination will be used. Velocity Variable Replacement is supported here. |