The UICallback is RAP's mechanism to push UI-changes to the client. It's based on the so-called Comet approach (specifically "XMLHttpRequest long polling"), i.e. it uses a long-standing request that is answered only in case of server-side updates.
There are two different types of requests involved:
- UI requests: normal Ajax requests that synchronize client and server.
- Callback requests: long-standing Ajax requests for server notifications to the client.
The UICallback is activated and deactivated on the server. When the activation state changes, the property uiCallbackActive is updated on the client.
When the property uiCallbackActive is true, the client ensures that there is an active connection to the server.
After processing the response to a ui request, the client sends a new callback request if the uiCallbackActive property is true and there is no current callback request standing.
When a callback request fails, the client sends a new callback request to re-establish the broken callback connection. To avoid unnecessary load on the client, retry requests are sent with a suitable delay.
In the response to a callback request, the server can advise the client to send a ui request if needed. Because every ui request must synchronize client and server, this ui request must contain any pending changes on the client. This request does not differ from requests that are sent as a result of a user interaction.
The diagram below illustrates the interaction between client and server
API Calls that affect the UI Callback
The following actions cause a standing callback request to be responded to.
UICallBack#activate() / deactivate()
UICallBack#activate() enables the UICallback system. This method must be called inside of a ui request.
UICallBack#deactivate() causes a standing callback request to return if no other instance requires the UICallback system.
When the activation status changes, the next returning request (either a ui or a callback request) will update the uiCallBackActive property.
The runnable that is passed to (a)syncExec() is put in a queue and executed in the next call to Display#readAndDispatch().
If Display#(a)syncExec() is called outside of a ui request, it causes a standing callback request to return and trigger a new ui request. If a ui request is currently running, the (a)sync runnable is being processed by this ui request. In this case, the callback request is not released.
If Display#wake() is called outside of a ui request, it causes a standing callback request to return and trigger a new ui request. If this method is called while a ui request is processed, it does nothing.
Some servlet engines do not let sessions terminate while there is a request running. This would cause sessions to never expire while the UICallback is active. To prevent this, callback requests are released when they are standing longer than the session timeout interval.
Regardless of how the servlet engine behaves are all active UI callbacks released when the session terminates.
Since version 1.5 M4, calling timerExec() causes the UI callback to be activated. Once the runnable given to timerExec() is executed, the callback is deactivated.