|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.zkoss.zkmax.ui.comet.CometServerPush
public class CometServerPush
A server-push implementation that is based on comet.
Available in ZK EE
Constructor Summary | |
---|---|
CometServerPush()
|
Method Summary | |
---|---|
boolean |
activate(long timeout)
Activate the current thread (which must be a server-push thread). |
boolean |
deactivate(boolean stop)
Deactvates the current thread (which must be a server-push thread). |
Desktop |
getDesktop()
Returns the desktop that this server push belongs to (never null). |
protected java.lang.String |
getStartScript()
Returns the JavaScript codes to enable (aka., start) the server push. |
protected java.lang.String |
getStopScript()
Returns the JavaScript codes to disable (aka., stop) the server push. |
boolean |
isActive()
Returns if the working thread of the server push is active. |
void |
onPiggyback()
Called when Events.ON_PIGGYBACK
is received. |
void |
setDelay(int min,
int max,
int factor)
Deprecated. |
void |
start(Desktop desktop)
Starts the server push. |
protected void |
startClientPush()
Sends an AU response to the client to start the server push. |
void |
stop()
Stops the server push. |
protected void |
stopClientPush()
Sends an AU response the client to stop the server push. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CometServerPush()
Method Detail |
---|
protected void startClientPush()
start(org.zkoss.zk.ui.Desktop)
.
The derived class usually overrides this method to support different devices, such as ZK Mobile.
The default implementation is to send AuScript
containing
the script returned by getStartScript()
.
Devices that don't support scripts could override this method
to send a custom AU response (AuResponse
).
protected void stopClientPush()
The derived class usually overrides this method to support different devices, such as ZK Mobile.
The default implementation is to send AuScript
containing
the script returned by getStopScript()
.
Devices that don't support scripts could override this method
to send a custom AU response (AuResponse
).
protected java.lang.String getStartScript()
startClientPush()
to prepare the script
of AuScript
that will be sent to the client.
protected java.lang.String getStopScript()
stopClientPush()
to prepare the script
of AuScript
that will be sent to the client.
public Desktop getDesktop()
public boolean isActive()
ServerPush
Executions.activate(org.zkoss.zk.ui.Desktop)
and
Executions.deactivate(org.zkoss.zk.ui.Desktop)
.
isActive
in interface ServerPush
public void start(Desktop desktop)
The derived class rarely need to override this method.
Rather, override startClientPush()
.
start
in interface ServerPush
public void stop()
The derived class rarely need to override this method.
Rather, override stopClientPush()
.
stop
in interface ServerPush
public void setDelay(int min, int max, int factor)
setDelay
in interface ServerPush
public void onPiggyback()
ServerPush
Events.ON_PIGGYBACK
is received. The invocation is passive (i.e., triggered by
other events, rather than spontaneous).
This method is called in
the context of an event listener. In other words, the execution
is activated and you can retrieve it by
Executions.getCurrent()
.
onPiggyback
in interface ServerPush
public boolean activate(long timeout) throws java.lang.InterruptedException, DesktopUnavailableException
ServerPush
The invoker of this method must invoke ServerPush.deactivate(boolean)
in this finally clause.
Note: the activation is applied to the desktop that was
assigned by ServerPush.start(org.zkoss.zk.ui.Desktop)
.
Unlike ServerPush.onPiggyback()
,
this method is NOT called in the context of an event listener.
Rather, it is called in the thread of a server-push thread.
activate
in interface ServerPush
timeout
- the maximum time to wait in milliseconds.
Ingored (i.e., never timeout) if non-positive.
java.lang.InterruptedException
- if it is interrupted by other thread
DesktopUnavailableException
- if the desktop is removed
(when activating).public boolean deactivate(boolean stop)
ServerPush
deactivate
in interface ServerPush
stop
- whether to stop after deactivate
ServerPush.activate(long)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |