Skip to content
pCon.configurator onlineDocumentation
Esc
↑↓navigate↵open⌘Jpreview
On this page

keepAlive

Synopsis

boolean keepAlive(SessionId sessionId) throws SessionServiceFault;

See also: SessionId, SessionServiceFault

In order to avoid a session being closed due to an expired session timeout the client may periodically invoke the keepAlive operation. If the sessionId argument identifies an open session then the session’s time-out timer is reset to it’s initial value (§Timeout for Sessions) and the operation returns true. Otherwise, the operation returns false.

The keepAlive operation can’t be used with a session context ID as their first argument.

A SessionServiceFault is returned if any of the following conditions occurs:

  • The sessionId parameter is not a valid string representation of an UUID.