SysSocketAsync Library Documentation ¶ Company System Title SysSocketAsync Version 3.5.17.0 Categories System|SysLibs Author 3S - Smart Software Solutions GmbH Placeholder SysSocketAsync Description 1 ¶ Asynchronous socket access Contents: ¶ DUT tSysSockAccept (Struct) tSysSockBind (Struct) tSysSockClose (Struct) tSysSockCloseUdp (Struct) tSysSockConnect (Struct) tSysSockCreate (Struct) tSysSockCreateUdp (Struct) tSysSockGetHostByName (Struct) tSysSockGetHostname (Struct) tSysSockGetOption (Struct) tSysSockGetOsHandle (Struct) tSysSockGetRecvSizeUdp (Struct) tSysSockGetSubnetMask (Struct) tSysSockHtonl (Struct) tSysSockHtons (Struct) tSysSockInetAddr (Struct) tSysSockInetNtoa (Struct) tSysSockIoctl (Struct) tSysSockListen (Struct) tSysSockNtohl (Struct) tSysSockNtohs (Struct) tSysSockPing (Struct) tSysSockRecv (Struct) tSysSockRecvFrom (Struct) tSysSockRecvFromUdp (Struct) tSysSockSelect (Struct) tSysSockSend (Struct) tSysSockSendTo (Struct) tSysSockSendToUdp (Struct) tSysSockSetIpAddress (Struct) tSysSockSetOption (Struct) tSysSockSetSubnetMask (Struct) tSysSockShutdown (Struct) SysSockAsyncFB (FunctionBlock) SysSockAcceptAsync (Method) SysSockBindAsync (Method) SysSockCloseAsync (Method) SysSockCloseUdpAsync (Method) SysSockConnectAsync (Method) SysSockCreateAsync (Method) SysSockCreateUdpAsync (Method) SysSockGetHostByNameAsync (Method) SysSockGetHostnameAsync (Method) SysSockGetOptionAsync (Method) SysSockGetOsHandleAsync (Method) SysSockGetRecvSizeUdpAsync (Method) SysSockGetSubnetMaskAsync (Method) SysSockHtonlAsync (Method) SysSockHtonsAsync (Method) SysSockInetAddrAsync (Method) SysSockInetNtoaAsync (Method) SysSockIoctlAsync (Method) SysSockListenAsync (Method) SysSockNtohlAsync (Method) SysSockNtohsAsync (Method) SysSockPingAsync (Method) SysSockRecvAsync (Method) SysSockRecvFromAsync (Method) SysSockRecvFromUdpAsync (Method) SysSockSelectAsync (Method) SysSockSendAsync (Method) SysSockSendToAsync (Method) SysSockSendToUdpAsync (Method) SysSockSetIpAddressAsync (Method) SysSockSetOptionAsync (Method) SysSockSetSubnetMaskAsync (Method) SysSockShutdownAsync (Method) Wrapper Indices and tables ¶ 1 Based on SysSocketAsync.library, last modified 20.04.2021, 16:10:39. LibDoc 4.4.0.0-b.27 The content file SysSocketAsync.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 20.04.2021, 16:10:39.
tSysSockPing (STRUCT) ¶ TYPE tSysSockPing : STRUCT InOut: Name Type Comment pszIpAddress STRING ulTimeout UDINT pulReplyTime POINTER TO UDINT pulOut POINTER TO RTS_IEC_RESULT Result
tSysSockRecv (STRUCT) ¶ TYPE tSysSockRecv : STRUCT InOut: Name Type Comment pbyBuffer POINTER TO BYTE diBufferSize __XINT diFlags DINT pResult POINTER TO RTS_IEC_RESULT pdiOut POINTER TO __XINT Received
tSysSockRecvFrom (STRUCT) ¶ TYPE tSysSockRecvFrom : STRUCT InOut: Name Type Comment pbyBuffer POINTER TO BYTE diBufferSize __XINT diFlags DINT pSockAddr POINTER TO SOCKADDRESS diSockAddrSize DINT pResult POINTER TO RTS_IEC_RESULT pdiOut POINTER TO __XINT Received
tSysSockRecvFromUdp (STRUCT) ¶ TYPE tSysSockRecvFromUdp : STRUCT InOut: Name Type Comment pbyData POINTER TO BYTE diDataSize __XINT pReply POINTER TO UDP_REPLY pResult POINTER TO RTS_IEC_RESULT pdiOut POINTER TO __XINT Received
tSysSockSelect (STRUCT) ¶ TYPE tSysSockSelect : STRUCT InOut: Name Type Comment diWidth DINT pFDRead POINTER TO SOCKET_FD_SET pFDWrite POINTER TO SOCKET_FD_SET pFDExcept POINTER TO SOCKET_FD_SET ptvTimeout POINTER TO SOCKET_TIMEVAL pdiReady POINTER TO DINT pulOut POINTER TO RTS_IEC_RESULT Result
tSysSockSend (STRUCT) ¶ TYPE tSysSockSend : STRUCT InOut: Name Type Comment pbyBuffer POINTER TO BYTE diBufferSize __XINT diFlags DINT pResult POINTER TO RTS_IEC_RESULT pdiOut POINTER TO __XINT Send
SysSockHtonl (FUN) ¶ FUNCTION SysSockHtonl : UDINT Converts a value of type UDINT from host byte order to the order of the TCP/IP network. InOut: Scope Name Type Comment Return SysSockHtonl UDINT Converted UDINT value Input ulHost UDINT Host value
SysSockRecvFrom (FUN) ¶ FUNCTION SysSockRecvFrom : __XINT Receive a message from a connectionless socket (UDP). NOTE: With some IP stacks (LwIP for example, which is used with the CODESYS Control RTE), it is necessary to set the SOCKET_SO_BROADCAST socket option (SOCKET_SOL level) in order to be able to receive broadcast UDP messages with the SysSockRecvMsg() and SysSockRecvFrom() functions. InOut: Scope Name Type Comment Return SysSockRecvFrom __XINT Number of bytes received Input hSocket RTS_IEC_HANDLE Handle to the socket pbyBuffer POINTER TO BYTE Buffer to read data from the socket diBufferSize __XINT Maximum length of the buffer diFlags DINT The flags parameter can be used to influence the behavior of the function beyond the options specified for the associated socket. The semantics of this function are determined by the socket options and the flags parameter. The latter is constructed by using the bitwise OR operator with any of the SOCKET_MSG values. pSockAddr POINTER TO SOCKADDRESS Socket address and port to receive data from diSockAddrSize DINT Size of socket address structure pResult POINTER TO RTS_IEC_RESULT Pointer to runtime system error code (see CmpErrors.library)
SysSockRecvFromUdp2 (FUN) ¶ FUNCTION SysSockRecvFromUdp2 : __XINT Receive a paket from a UDP socket. InOut: Scope Name Type Comment Return SysSockRecvFromUdp2 __XINT Number of bytes received Input hSocketUdp RTS_IEC_HANDLE Handle to the UDP socket pbyData POINTER TO BYTE Pointer to data to receive diDataSize __XINT Size of data to receive pReply POINTER TO UDP_REPLY2 Description of the client that has sent this paket pResult POINTER TO RTS_IEC_RESULT Pointer to runtime system error code (see CmpErrors.library)
