TCP ¶ Enums ERROR (Enum) STREAM_STATE (Enum) Function Blocks Connector (FunctionBlock) Connect (Method) Disconnect (Method) IPAddress (Property) Port (Property) Reset (Method) ResolveHostName (Method) Listener (FunctionBlock) Accept (Method) IPAddress (Property) Listen (Method) Port (Property) Socket (Property) Start (Method) Stop (Method) Select (FunctionBlock) Check (Method) CheckError (Method) CheckReceive (Method) CheckSend (Method) Stream (FunctionBlock) CheckConnectivity (Method) CheckReceive (Method) CheckSend (Method) Close (Method) Create (Method) FdIsSet (Method) FdSet (Method) GetOption (Method) IoControl (Method) Properties IPAddress (Property) Socket (Property) State (Property) Receive (Method) Reset (Method) Send (Method) SetOption (Method) Functions UDINT_TO_IPSTRING (Function) GlobalConstants Constants (GVL) Structs SockAddr (Struct)
ERROR (ENUM) ¶ TYPE ERROR : Attributes: qualified_only InOut: Name Comment NO_ERROR No Error: Everything worked fine. TIME_OUT Call timed out PENDING Still pending INVALID_HANDLE Detected an invalid handle/null pointer INVALID_IPADDRESS The given address is not valid CONNECT_FAILED Failed to connect to Listener HOST_NOT_FOUND Listener could not be found TCP_OPEN_ERROR Could not open tcp connection NO_STREAMS_TO_LISTEN There are no streams to listen to ADDR_NOT_AVAILABLE Address not available on this plc CONNECTION_LOST Connection lost. Check cables STREAM_STATE_ERROR Stream already created GET_OPTION_FAILED Could not get option. Maybe it is not supported by OS SET_OPTION_FAILED Could not set option. Maybe it is not supported by OS IOCTL_FAILED IO-Control failed RECEIVE_ERROR Error receiving a stream SEND_ERROR Error sending a stream FD_SET_INIT_FAILED Could not init fd set
STREAM_STATE (ENUM) ¶ TYPE STREAM_STATE : InOut: Name Initial Comment CLOSED 0 Stream is closed CONNECTING Stream is connecting LISTENING Stream is listening OPEN Stream is open. Ready to send/receive data FAILED Opening the stream failed.
Function Blocks ¶ Connector (FunctionBlock) Connect (Method) Disconnect (Method) IPAddress (Property) Port (Property) Reset (Method) ResolveHostName (Method) Listener (FunctionBlock) Accept (Method) IPAddress (Property) Listen (Method) Port (Property) Socket (Property) Start (Method) Stop (Method) Select (FunctionBlock) Check (Method) CheckError (Method) CheckReceive (Method) CheckSend (Method) Stream (FunctionBlock) CheckConnectivity (Method) CheckReceive (Method) CheckSend (Method) Close (Method) Create (Method) FdIsSet (Method) FdSet (Method) GetOption (Method) IoControl (Method) Properties IPAddress (Property) Socket (Property) State (Property) Receive (Method) Reset (Method) Send (Method) SetOption (Method)
Connector (FB) ¶ FUNCTION_BLOCK Connector Connector fb opens a tcp socket to a tcp server and initializes the given tcp stream. Represents a TCP Client. Properties: IPAddress Port Methods: Connect Disconnect Reset ResolveHostName Structure: Connect (Method) Disconnect (Method) IPAddress (Property) Port (Property) Reset (Method) ResolveHostName (Method)
Connector.Connect (METH) ¶ METHOD Connect : ERROR Connects to a server and returns a tcp stream; Call this function until an Error <> PENDING OR Error <> NO_ERROR is returned or pStream is set InOut: Scope Name Type Comment Input sIPAddress STRING IP address of the server uiPort UINT Port on which the server is listening Return Connect ERROR Output pStream POINTER TO Stream If the connection is established, pStream is != 0
Connector.Disconnect (METH) ¶ METHOD Disconnect : ERROR Disconnects the stream from the server InOut: Scope Name Type Return Disconnect ERROR
Connector.IPAddress (PROP) ¶ PROPERTY IPAddress : STRING IP Address of a listener the connector shall connect to
Connector.Port (PROP) ¶ PROPERTY Port : UINT // Port of a listener the connector shall connect to
Connector.Reset (METH) ¶ METHOD PUBLIC Reset