File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 20.04.2021, 16:10:18 companyName string 3S-Smart Software Solutions GmbH libraryFile SysSocket2_Itfs.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile SysSocket2_Itfs.clean.json version version 2.0.0.0 ProjectInformation IsInterfaceLibrary bool True Released True SourceLibrary False LastModificationDateTime date 20.04.2021, 16:10:18 LibraryCategories library-category-list System|SysLibs Author string CODESYS Development GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 Patch 2 DefaultNamespace Description See: Description DocFormat reStructuredText Project SysSocket2_Itfs Title SysSocket2 Interfaces Version version 3.5.17.0
SysSockAsyncFB.SysSockInetAddrAsync (METH) ¶ METHOD SysSockInetAddrAsync : RTS_IEC_HANDLE For details, see node “Documentation” InOut: Scope Name Type Comment Return SysSockInetAddrAsync RTS_IEC_HANDLE Input pParam POINTER TO tSysSockInetAddr pudState POINTER TO UDINT pResult POINTER TO RTS_IEC_RESULT Result of Jobadd
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. SysTypes2 Interfaces ¶ Library Identification ¶ Name: SysTypes2 Interfaces Version: newest Company: System Namespace: SysTypes Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTypes2 Interfaces, * (System)
SysSockAsyncFB.SysSockInetNtoaAsync (METH) ¶ METHOD SysSockInetNtoaAsync : RTS_IEC_HANDLE For details, see node “Documentation” InOut: Scope Name Type Comment Return SysSockInetNtoaAsync RTS_IEC_HANDLE Input pParam POINTER TO tSysSockInetNtoa pudState POINTER TO UDINT pResult POINTER TO RTS_IEC_RESULT Result of Jobadd
SysSockAsyncFB.SysSockListenAsync (METH) ¶ METHOD SysSockListenAsync : RTS_IEC_HANDLE For details, see node “Documentation” InOut: Scope Name Type Comment Return SysSockListenAsync RTS_IEC_HANDLE Input pParam POINTER TO tSysSockListen pudState POINTER TO UDINT pResult POINTER TO RTS_IEC_RESULT Result of Jobadd
SysSockAsyncFB.SysSockIoctlAsync (METH) ¶ METHOD SysSockIoctlAsync : RTS_IEC_HANDLE For details, see node “Documentation” InOut: Scope Name Type Comment Return SysSockIoctlAsync RTS_IEC_HANDLE Input pParam POINTER TO tSysSockIoctl pudState POINTER TO UDINT pResult POINTER TO RTS_IEC_RESULT Result of Jobadd
SOCK_ADAPTER_INFORMATION2 (STRUCT) ¶ TYPE SOCK_ADAPTER_INFORMATION2 : STRUCT Structure to describe a network adapter on SysSocket level, including name server and DHCP server information InOut: Name Type Comment udiStructSize UDINT Size of the structure SOCK_ADAPTER_INFORMATION returned from external implementation udiVersion UDINT Version number of the structure udiIndex UDINT Index number of this adapter. Value is constant until shutdown udiReserved UDINT Reserved for internal use wsName WSTRING(ADAPTER_INFO_NAME_LEN) Name of the network interface wsDescription WSTRING(ADAPTER_INFO_DESC_LEN) Description text for the network interface; may be empty abyMac ARRAY [0..(ADAPTER_INFO_MAC_ADDR_LENGTH - 1)] OF BYTE MAC ID (hardware address) wType WORD Adapter type, see “Adapter types” contants SOCK_AIT_xxx in GVL dwFlags DWORD Flags to characterize the adapter, see “Adapter information flags” constants SOCK_AIF_xxx in GVL IpAddr INADDR IP address in network byte order NetMask INADDR Subnet mask in network byte order DefaultGateway INADDR IP address of default gateway in network byte order; only valid if SOCK_AIF_GATEWAY_INFO_VALID is set in dwFlags in GVL PrimaryNameServer INADDR Primary Name Server. Value of 0.0.0.0 indicates no name server has been configured. SecondaryNameServer INADDR Secondary Name Server. Value of 0.0.0.0 indicates no secondary name server has been configured. wsDNSSuffix WSTRING(ADAPTER_INFO_DNSSUFFIX_LEN) Default domain name. DHCPServer INADDR IP address of DHCP server; only valid if SOCK_AIF_DHCP_INFO_VALID is set in dwFlags in GVL
SOCK_ADAPTER_INFORMATION3 (STRUCT) ¶ TYPE SOCK_ADAPTER_INFORMATION3 : STRUCT Structure to describe a network adapter on SysSocket level, including OS index of adapter InOut: Name Type Comment udiStructSize UDINT Size of the structure SOCK_ADAPTER_INFORMATION returned from external implementation udiVersion UDINT Version number of the structure udiIndex UDINT Index number of this adapter. Value is constant until shutdown udiReserved UDINT Reserved for internal use wsName WSTRING(ADAPTER_INFO_NAME_LEN) Name of the network interface wsDescription WSTRING(ADAPTER_INFO_DESC_LEN) Description text for the network interface; may be empty abyMac ARRAY [0..(ADAPTER_INFO_MAC_ADDR_LENGTH - 1)] OF BYTE MAC ID (hardware address) wType WORD Adapter type, see “Adapter types” constants SOCK_AIT_xxx in GVL dwFlags DWORD Flags to characterize the adapter, see “Adapter information flags” constants SOCK_AIF_xxx in GVL IpAddr INADDR IP address in network byte order NetMask INADDR Subnet mask in network byte order DefaultGateway INADDR IP address of default gateway in network byte order; only valid if SOCK_AIF_GATEWAY_INFO_VALID is set in dwFlags in GVL PrimaryNameServer INADDR Primary Name Server. Value of 0.0.0.0 indicates no name server has been configured. SecondaryNameServer INADDR Secondary Name Server. Value of 0.0.0.0 indicates no secondary name server has been configured. wsDNSSuffix WSTRING(ADAPTER_INFO_DNSSUFFIX_LEN) Default domain name. DHCPServer INADDR IP address of DHCP server; only valid if SOCK_AIF_DHCP_INFO_VALID is set in dwFlags in GVL udiOSIndex UDINT Operating system 1-based index number of this adapter. Value is constant until shutdown. Value is 0 if not supported by OS.
SOCK_HOSTENT (STRUCT) ¶ TYPE SOCK_HOSTENT : STRUCT This structure contains information on the host. InOut: Name Type Comment szHostname REFERENCE TO STRING Official name of host (network name) pAliasList POINTER TO POINTER TO STRING Pointer to list of aliases iHostAddrType INT Address type of host iLengthAddr INT Size of host address pAddrList POINTER TO POINTER TO STRING Pointer to address list
SOCK_RECVMSG_MSG (STRUCT) ¶ TYPE SOCK_RECVMSG_MSG : STRUCT The SysSockRecvMsg() call uses a SOCK_RECVMSG_MSG structure to minimize the number of directly supplied arguments. InOut: Name Type Comment pBuffer POINTER TO BYTE OUT: Points to a buffer where the message should be stored. length __XWORD IN: Specifies the length in bytes of the buffer pointed to by the pBuffer argument. address SOCKADDRESS OUT: Sending address (AKA source address). msgFlags DWORD OUT: A 32-bit value to store the flags of the incoming message. msgFlagsSupported DWORD OUT: A 32-bit value to store which message flags for the pMsgFlags argument are supported by the implementation of the runtime system. See category “Message flags”.