Called when the listener has been registered at the server and is now active.
a function to call that will deregister and close this handler. The function will resolve when the handler has been deregistered.
Called when the listener is deregistered, or the session is closed.
Notification of a contextual error related to this handler. This is analogous to an unchecked exception being raised. Situations in which onError is called include the session being closed before the handler is registered, a communication timeout, or a problem with the provided parameters. No further calls will be made to this handler.
the error
Notification that a client session has closed.
This will be called for every client that closes whilst the listener is registered, regardless of requested session properties.
the session identifier
the map of requested property values
the reason why the session was closed
Notification of a session event that can result in a change of properties.
the session identifier
the type of event
the map of requested property values
a map of previous values for keys that have changed. This will only contain changed values and not the whole required property set.
Notification that a new client session has been opened.
When the listener is registered, this will be called for all existing sessions. It will then be called for every client session that opens whilst the listener is registered.
This will be called for client session regardless of requested session properties.
the session identifier
the map of requested session property values.
The Session Properties Listener interface for receiving session property events. This interface must be implemented by the user, to be registered via ClientControl.setSessionPropertiesListener.
A session properties listener has a lifecycle that reflects the registration state on the server. This is expressed through the callback methods. Once onClose has been called, no further interactions will occur.
since 6.11
Use the new ClientControl.addSessionEventListener, which provides greater functionality and reports sessions at all cluster members. This interface will be removed in a future release.