TCP Client

R2026b

Configure TCP client

expand all in page
  • TCP Client block

Libraries:
Simulink Real-Time / IP

Description

The TCP Client block configures a TCP client.

The parameters Client IP address and Client port are optional. The Client IP address applies when the block executes in a real-time application on a Speedgoat® target computer or in a model simulation on a MATLAB® development computer. If your model is running in Simulink® on the development computer, you can use this block to transmit data to a remote device. In this case, the Windows® operating system determines the network connection.

If the TCP Client in the real-time application cannot establish the connection immediately, the connection is established asynchronously and becomes available in the next time step.

Examples

Target to Development Computer Communication by Using TCP

Target to Development Computer Communication by Using TCP

Use TCP blocks to send data from the target computer to MATLAB running on the development computer.

Ports

Input

expand all

If Enable is greater than zero, the block connects to the Ethernet device. Otherwise, the block does not connect to the Ethernet device.

Output

expand all

The status value is one of:

  • 0 — Not connected

  • 1 — Connected

As a best practice, connect the Status output of a TCP configure block to the Enable input of the associated TCP Send and TCP Receive blocks.

Parameters

expand all

Dependency

When you select this parameter, it deactivates the Client IP address parameter and excludes the ports 1 through 1023 and 5500 through 5560 from use by TCP.

Programmatic Use

Block Parameter: useHostTargetConn

Enter the IP address of the server to which you want to connect the client.

Programmatic Use

Block Parameter: remoteAddress

Enter the port number of the server to which you want to connect the client.

Ports 1 through 1023 and 5500 through 5560 are reserved for Simulink Real-Time communications.

Programmatic Use

Block Parameter: remotePort

Enables Nagle's algorithm to improve the efficiency of the TCP/IP network. Nagle's algorithm reduces the number of packet that are sent over the network. The tradeoff for this improved efficiency is that Nagle's algorithm introduces a delay before a packet is sent over the network. You can reduce network latency by disabling Nagle's algorithm for this block.

Programmatic Use

Block Parameter: useNaglesAlgorithm

Advanced Parameters

If you are using a dedicated Ethernet card, this value must match the Local IP Address parameter in the IP Config block for the network interface. The default value for the Client IP address field is no value. This empty field means that the operating system chooses the Client IP address for TCP transmission.

Programmatic Use

Block Parameter: clientAddress

The combination of Client IP address and Client local port must be unique.

Ports 1 through 1023 and 5500 through 5560 are reserved for Simulink Real-Time communications. Values '-1', '0', or 'empty' mean that the block transmits data by using any available port.

Programmatic Use

Block Parameter: clientPort

Programmatic Use: Add Block

To add the block programmatically, use the add_block function with one of these library block paths as the source.

"slrealtimeiplib/TCP Client"

Example: add_block("slrealtimeiplib/TCP Client","myModel/myBlock",MakeNameUnique="on")

Extended Capabilities

expand all

C/C++ Code Generation
Generate C and C++ code using Simulink® Coder™.

Version History

Introduced in R2020b

expand all

See Also

External Websites