TcpAccept

PLCopen motion icon

Function Block - Performs the accept operation.

This function block performs the accept operation using default TCP settings.
Use the TcpClose function block to release the socket returned by TcpAccept.

It is possible that the socket becomes invalid if an error occurs in the TCP connection after this function block is called.
Use the TcpIsValid function block after TcpSend.
If the socket is no longer valid, close it using the TcpClose function block.

Inputs

Input	Data Type See Data Types.	Range	Unit	Default	Description
Execute	BOOL	0 to 1	N/A	No default	On the rising edge, accept a new socket connection.
ListenID	UDINT	N/A	N/A	No default	The ID of a server socket returned by the TcpListen function block.

Input

Data Type

See Data Types.

Range

Unit

Default

Description

Execute

BOOL

0 to 1

N/A

No default

On the rising edge, accept a new socket connection.

ListenID

UDINT

N/A

No default

The ID of a server socket returned by the TcpListen function block.

Outputs

Output	Data Type See Data Types.	Description
Done	BOOL	If TRUE, the command completed successfully.
Error	BOOL	If TRUE, an error has occurred.
ErrorID	DINT	Indicates the error if Error output is TRUE. See the table in File, Recipe, and TCP/IP Function Block ErrorIDs.
ID	UDINT	Either: ID of a new client socket accepted. Invalid ID if no new connection.

FBD Language Example

Not available.

FFLD Language Example

Not available.

IL Language Example

Not available.

ST Language Example

(* TcpAccept example *)
CASE StepCounter OF
0:
   Inst_TcpAccept(TRUE, MyListenID);
   StepCounter := StepCounter + 1;
1:
   Inst_TcpAccept(TRUE, MyListenID);
   IF Inst_TcpAccept.Done THEN
      MySocketID := Inst_TcpAccept.ID;
      Inst_TcpAccept(FALSE, 0);
      StepCounter := StepCounter + 1;
   END_IF;
END_CASE;