Set a time-out for xfServerPlus

WTSupported in traditional Synergy on Windows


USupported on UNIX
VSupported on OpenVMS
xcall SET_XFPL_TIMEOUT(minutes[, seconds])


The number of minutes to wait before shutting down xfServerPlus. (n)


(optional) The number of seconds to wait before shutting down xfServerPlus. (n)

SET_XFPL_TIMEOUT sets a time-out value for the remote execution server in xfServerPlus. The time-out period starts over after each call – confirm cycle.

This routine can be used to handle cases where the client exits or shuts down abnormally and xfServerPlus does not receive a shutdown message. For example, when you are developing or testing, it may be helpful to set a small time-out value so that open ELBs are closed promptly and can be updated. (The ELBs and shared images that have been opened by xfServerPlus are closed when it shuts down.)

We do not recommend using SET_XFPL_TIMEOUT if you are using pooling because it can cause connections in the pool to time out. We recommend using the client-side time-out options instead (see the bulleted list below).

Ideally, your client should always send a shutdown message to xfServerPlus. However, if no shutdown message is sent, and no time-out is specified with SET_XFPL_TIMEOUT, xfServerPlus may continue running until the machine on which it resides is shut down or the keepalive timer value is reached and the daemon shuts down the connection. On Windows and UNIX, because the default keepalive time is usually about two hours, we set it to ten minutes each time a socket is open. This setting temporarily overrides the system keepalive setting. (For more information on the keepalive timer, see Rsynd: shutting down and timing out or your operating system documentation.) As long as xfServerPlus continues running, one of your xfServerPlus sessions is in use, tying up a license.

If SET_XFPL_TIMEOUT is called and XFPL_SESS_INFO is set to “all” in the xfpl.ini file, an entry is made in the xfServerPlus log file (xfpl.log), recording the time-out value (assuming logging is turned on, of course). If xfServerPlus times out, that fact will be recorded in the log. The error you will see in your program depends on the state of the client application when it attempts to access the timed-out connection. Your client application should be prepared to handle this.

You can also set time-out values for several operations in the xfNetLink clients: