| Back | Main view
How to set custom session timeout in IMiS/Storage Connector
| Product: | IMiS/Storage Connector .NET, IMiS/Storage Connector JAVA |
| Release: | 9.10.1910 |
| Date: | 06/19/2020 |
Case:
IMiS/Storage Connector provides a means to set custom session timeout in IMiS/Storage Connector. By default, the session timeout is infinite (ie. not set). That means a client application using IMiS/Storage Connector will wait indefinitely for the server to respond. Server on the otherhand will drop stale sessions after its own configurable session timeout. In an unstable network environment where lots of hardware is involved client sessions might be cut without notice and client will find out only after server drops the session. To avoid this, client sessions can be configured to timeout after a reasonable amount of time, say 10s (10000 ms). This will improve user experience and avoid unnecessary waiting for results from server.
Description:
Setting IMiS/ARC Client session timeout in IMiS/Storage Connector Java can be done with the use of the "imis.imisarc.client.socketTimeout" system property that specifies the default socket timeout (SO_TIMEOUT), in milliseconds, which is the timeout for waiting for data. Default value is set to 0, which indicates an infinite time-out period. Setting timeout can be done either programmatically with System.setProperty() method or using the -Dname=value flag when starting the JVM. For example, to set timeout to 10s set property value to 10000:
imis.imisarc.client.socketTimeout=10000
The use of this system property requires restart of IMiS/Storage Connector.
In case of Lotus Domino, the system property can be set through the use of JavaUserOptionsFile key-value entry in the NOTES.INI file. The system property value can be stored in a custom configuration file, for example isc.properties. The JavaUserOptionsFile key-value entry is than set in the following way:
JavaUserOptionsFile=C:\Lotus\Domino\Data\isc.properties
This procedure requires restart of Lotus Domino server.
In case of IMiS/Storage Connector .NET, setting session timeout is done through registry with the use of DWORD registry value "SendTimeout" that specifies the amount of time, in milliseconds, after which a synchronous Send call on the Socket will time out. If the value is set between 1 and 499, the value will be changed to 500. Default value is set to 0, which indicates an infinite time-out period. For example, to set timeout to 10s set property value to 10000:
SendTimeout=10000
Registry value SendTimeout has to be stored in the following registry path
HKEY_CURRENT_USER\SOFTWARE\IS\IMiS\ARC Client
WARNING: Using Registry Editor incorrectly can cause serious problems that may require you to reinstall Windows. Imaging Systems cannot guarantee that problems resulting from the incorrect use of Registry Editor can be solved. Use Registry Editor at your own risk.
IMPORTANT: This article contains information about editing the registry. Before you edit the registry, you should first make a backup copy of the registry files (System.dat and User.dat). Both are hidden files in the Windows folder.
NOTE: For information about how to edit the registry, view the Changing Keys And Values online Help topic in Registry Editor (Regedit.exe). Note that you should make a backup copy of the registry files (System.dat and User.dat) before you edit the registry.
Related Documents:
IMiS/Storage Connector 9.10.1910 JAVA Interface Patch
| Back | Main view