ZK Developer's Reference/Server Push/Synchronous Tasks

Server push is a technology to actively push data to the client. For ZK, the data is usually the UI updates or its variants. Thus, for sake of understanding, we could consider the task is about updating UI in parallel with regular Ajax requests (poll-type request). For example, in a chat application, once a message is entered by a participant, the server has to push it to all clients that involve in the conversation.

If the task of updating UI takes place in a working thread, it is generally more convenient to execute it synchronously as described later. On the other hand, if the task can be encapsulated as an event listener (EventListener), you could execute it asynchronously -- please refer to the Asynchronous Tasks section for more information.

Enable Server Push

By default, the server push is disabled (for better performance). Before pushing data for a given desktop, you have to enable the server push for it.

It can be done by use of Desktop.enableServerPush(boolean):

desktop.enableServerPush(true);

After the server push of a given desktop is enabled, you could use any number of working thread to update the desktop concurrently as described in the following section.

---

Update UI in a Working Thread

To updating the UI synchronously in a working thread, we have to do as follows.

1. Invoke Executions.activate(Desktop). It has two purposes:
   1. It grants the right to access the UI of the given desktop to the caller's thread.
   2. It establishes a connection with the client (the browser window displaying the desktop), such that the update will be sent to the client after finished
2. Update UI any way you want, just like any regular event listener.
3. Invoke Executions.deactivate(Desktop) to return the control, such that other thread could have a chance to update UI.

Here is the pseudo code that illustrates the flow:

public class WorkingThread extends Thread {
    public void run() {
        try {
            while (anyDataToShow()) { //whatever you like
                //Step 1. Prepare the data that will be updated to UI
                collectData(); //whatever you like

                //Step 2. Activate to grant the access of the give desktop
                Executions.activate(desktop);
                try {
                     //Step 3. Update UI
                     updateUI(); //whatever you like
                } finally {
                    //Step 4. Deactivate to return the control of UI back
                     Executions.deactivate(_desktop);
                }
            }
        } catch (InterruptedException ex) {
            //Interrupted. You might want to handle it
        }
    }
}

Notice that the task between Executions.activate(Desktop) and Executions.deactivate(Desktop) has to be efficient, since it blocks others, including the user (of the desktop), from access the UI. It is suggested to prepare the data before Executions.activate(Desktop), such that it can be done in parallel with other threads.

---

Version History

Version	Date	Content