SockOpt_EnableKeepAliveExtended Method

Overview

Type:	Method
Available as of:	V1.0.4.0

Task

Is used to configure the keep alive for the TCP connection to help detect communication interruption.

Functional Description

Is used to configure the timeout until the first keep alive packet is sent, the interval between the keep alive packets, and the number of unacknowledged keep alive packets to determinate a communication interruption of the TCP connection.

NOTE: This method is not supported on all platforms. Refer to the diagnostic outputs of the method.

Interface

Input	Data type	Valid range	Description
i_udiUnackProbes	UDINT	-	Specifies the number of unacknowledged probes to send before indicate disconnection.
i_diTimeout	DINT	-	Specifies the timeout in seconds with no activity until the first keep-alive packet is sent.
i_diInterval	DINT	-	Specifies the interval in seconds between unacknowledged keep-alive messages.

Output	Data type	Valid range	Description
q_etUnackProbes	ET_Result	-	Indicates the result of i_udiUnackProbes configuration.
q_etTimeout	ET_Result	-	Indicates the result of i_diTimeout configuration.
q_etInterval	ET_Result	-	Indicates the result of i_diInterval configuration.