Event Threads

From Documentation
[Since ZK 7.0.0 deprecated to enable the event thread according to Java Servlet Specification that may prohibit the creation of new threads]

By default, ZK processes an event in the same Servlet thread that receives the HTTP request. It is the suggested approach because the performance is better and it is easy to integrate with other frameworks[1].

However, it also implies the developer cannot suspend the execution. Otherwise, the end user won't see any updates from the server. To solve it, ZK provides an alternative approach: processes the event in an independent thread called the event processing thread. Therefore, the developer can suspend and resume the execution at any time, without blocking the Servlet thread from sending back the responses to the browser. To turn it on[2], you have to specify the following in WEB-INF/zk.xml (ZK Configuration Guide: disable-event-thread).


In short, it is recommended to disable the event thread. Enable the event thread only if the project does not need to integrate other frameworks (such as Spring), depends on Messagebox and modal windows a lot, and does not have a lot of concurrent users.

Here is the advantages and limitations about using the Servlet thread to process events. In the following sections we will talk more about the limitations and workarounds when using the Servlet thread.

Using Servlet Thread
Using Event Processing Thread
Integration Less integration issues.

Many containers assume the HTTP request is handled in the Servlet thread, and many frameworks store per-request information in the thread local storage.

You may have to implement EventThreadInit and/or EventThreadCleanup to solve the integration issue, such as copying the per-request information from the Servlet thread to the event processing thread.

Threre are several implementations to solve the integration issue, such as HibernateSessionContextListener (they can be found under the org.zkoss.zkplus package).

SuspendResume No way to suspend the execution of the event listener.

For example, you cannot create a modal window.

No limitation at all.
Performance No extra cost It executes a bit slower to switch from one thread to another, and it might consume a lot more memory if there are a lot of suspended event processing threads.

  1. Many frameworks store per-request information in the thread-local storage, so we have to copy them from Servlet thread to the Event Processing Thread.
  2. For ZK 1.x, 2.x and 3.x, the event processing thread is enabled by default.

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.