RTS_SOCKET_SO_VALUE_LINGER (STRUCT) ¶ TYPE RTS_SOCKET_SO_VALUE_LINGER : STRUCT Parameters for the socket option SOCKET_SO_LINGER . InOut: Name Type Comment l_onoff WORD Specifies whether a socket should remain open for a specified amount of time after a closesocket function call to enable queued data to be sent. 0 = Socket will not remain open. 1 = Socket will remain open for the linger time. l_linger WORD The linger time in seconds. This member specifies how long to remain open after a closesocket function call to enable queued data to be sent.
RTS_SOCKET_SO_VALUE_TCP_KEEPALIVE (STRUCT) ¶ TYPE RTS_SOCKET_SO_VALUE_TCP_KEEPALIVE : STRUCT Parameters for the socket option SOCKET_SO_KEEPALIVE . NOTE: If one of the parameters is not supported, the result of SysSockSetOption() is ERR_NOT_SUPPORTED. In this case, the corresponding result of the option contains the error result. InOut: Name Type Comment bOn DINT 1=Enable keepalive, 0=Disable probes UDINT The number of unacknowledged probes to send before considering the connection dead and notifying the application layer. NOTE: Is not supported by every platform! probesResult RTS_IEC_RESULT Error code for the probes parameter. Returns ERR_NOT_SUPPORTED, if option is not available on the target. timeout DINT Specifies the timeout in milliseconds with no activity until the first keep-alive packet is sent. timeoutResult RTS_IEC_RESULT Error code for the timeout parameter. Returns ERR_NOT_SUPPORTED, if option is not available on the target interval DINT Specifies the interval in milliseconds between when successive keep-alive packets are sent if no acknowledgement is received. intervalResult RTS_IEC_RESULT Error code for the interval parameter. Returns ERR_NOT_SUPPORTED, if option is not available on the target.
SOCKADDRESS (STRUCT) ¶ TYPE SOCKADDRESS : STRUCT This structure contains all necessary information for complete addressing of a socket. InOut: Name Type Comment sin_family INT Identification number of address family sin_port UINT Identification number of the port. Must be converted in bus order with SysSockHtons()! sin_addr INADDR IP address sin_zero ARRAY [0..7] OF BYTE Dummy (due to alignment reasons)
SOCKET_FD_SET (STRUCT) ¶ TYPE SOCKET_FD_SET : STRUCT This structure contains number and identification of the sockets established. InOut: Name Type Comment fd_count UDINT Number of sockets established fd_array ARRAY [0..(SOCKET_FD_SETSIZE - 1)] OF RTS_IEC_HANDLE List with handles of established sockets
SOCKET_TIMEVAL (STRUCT) ¶ TYPE SOCKET_TIMEVAL : STRUCT This structure contains a time specification divided in seconds and microseconds. InOut: Name Type Comment tv_sec DINT Seconds tv_usec DINT Microseconds
SOCK_ADAPTER_INFORMATION (STRUCT) ¶ TYPE SOCK_ADAPTER_INFORMATION : STRUCT Structure to describe a network adapter on SysSocket level 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
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_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”.
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