SCSPROFILE

Connection recovery settings

WTSupported in traditional Synergy on Windows
WNSupported in Synergy .NET on Windows

 

 

The SCSPROFILE environment variable enables the client to specify a set of predefined time values for xfServer connection recovery.

Value

One of the following values:

DEFAULT = Use the default profile.

MOBILE = Use the mobile profile.

MOBILE2 = Use the mobile2 profile.

Discussion

When connection recovery is enabled on the server (in either slave or master mode), setting SCSPROFILE on the client to one of the predefined profiles will override all of the connection recovery time values set on the server machine for that client. Using SCSPROFILE is simply a convenient way to override all the settings at once, rather than overriding them individually with SCSKEEPALIVE, SCSKEEPCONTEXT, and SCSKEEPLOCKS. Using SCSPROFILE is the only way to override the server’s setting for retry time.

When connection recovery is enabled in slave mode, setting SCSPROFILE on the client enables the feature for that client, even if SCSKEEPCONNECT is not set. (If SCSKEEPCONNECT is explicitly set to OFF or if KeepConnect on the server is off, setting SCSPROFILE will not enable the feature, and a warning will be logged in the Windows event log on the server.)

The profiles are defined as follows (times are in seconds):

Setting

Default profile

Mobile profile

Mobile2 profile

KeepContext

300

7200

7200

KeepAlive

150

60

60

KeepLocks

300

300

300

RetryTime

60

60

20

The Default profile represents the built‑in connection recovery defaults.

The Mobile profile is suitable for use with an application that has no special handling for socket failures. It provides a reasonable time to re‑establish a failed connection.

The Mobile2 profile is suitable for use with an application that has a built‑in awareness of socket failures that enables the application to control what action to take after a failure. This awareness may be in the form of an IOHooks reconect_hook method or it could be code that reissues the I/O upon trapping a “Server connection retry failure” ($ERR_SRVCONTRY) error.

Setting location

On the xfServer client in the environment or in the [dbr] section of synergy.ini. To use the SETLOG routine to set SCSPROFILE, call it prior to the first OPEN statement to the server.

Used by

xfServer

See also

Examples

SCSPROFILE=mobile