TCP_Send block

Short summary

Name

TCP_Send

→POU type

→function

Category

more system blocks, network blocks, block with internal error diagnostic

→Namespace

logicals.system.network.tcp

Graphical interface

images/download/attachments/429720003/TCP_Send-version-2-modificationdate-1562752153001-api-v2.png

Available since

version 3.2.2 (for library Standard )
images/s/b2ic8e/9012/1ca6q62/_/images/icons/emoticons/warning.svg This block is supported for these target systems or platforms:

  • Raspberry Pi, Revolution Pi

  • platform WindowsX86 (incl. the built-in PLC under Windows)

  • platform LinuxX86

Functionality

The block sends a →TCP packet.

Inputs, outputs, return value


Identifier

→Data type

Description

Inputs:

lengthOfDataToSend

UDINT

length of the data to send


clientHandle

TCP_ClientHandle

TCP h andle


flags

UDINT

additional flags for sending

In-outs
(VAR_IN_OUT):

data

REAL, LREAL, USINT, UINT, UDINT, ULINT, SINT, INT, DINT, LINT, TIME, BOOL, BYTE, WORD, DWORD, LWORD, STRING, CHAR, DATE_AND_TIME, DATE, TIME_OF_DAY or a →user-defined data type
Restriction: In case of →array data types, only one-dimensional arrays are allowed.

content of the sent TCP packet

Return value:

(= rc )

TCP_ErrorCode

returns the status of the TCP operation:

  • succeeded: The operation is successful.

  • invalidFlags: The flags are invalid .

  • invalidHandle: T he handle is invalid .

  • cannotSendData: The data cannot be sent.

  • invalidDataSize: The length of the data is invalid.

Input EN and output ENO are available when →calling the block. See "Execution control: EN, ENO" for information on input EN and output ENO.

See:

Internal error diagnostic for block

The block checks the following error cases:

  • The flags are invalid .

  • T he handle is invalid .

  • The data cannot be sent.

  • The length of the data is invalid.

In such an error case, the output ENO of the block is set to value FALSE (or an equivalent). Moreover, the block returns the appropriate code (see the above table).

Example for usage within ST-editor

See " TCP_ServerOpen block ".

When creating your application within the ST-editor, enter a call of a block by typing the text as requested by the syntax or use Content Assist.