org.wicketstuff.chat.channel

Class TimerChannelBehavior

java.lang.Object

org.apache.wicket.behavior.Behavior

org.apache.wicket.behavior.AbstractAjaxBehavior

org.apache.wicket.ajax.AbstractDefaultAjaxBehavior

org.apache.wicket.ajax.AbstractAjaxTimerBehavior

org.wicketstuff.chat.channel.TimerChannelBehavior

All Implemented Interfaces:

Serializable, org.apache.wicket.behavior.IBehaviorListener, org.apache.wicket.IComponentAwareEventSink, org.apache.wicket.IRequestListener, org.apache.wicket.markup.html.IComponentAwareHeaderContributor, org.apache.wicket.util.io.IClusterable

public class TimerChannelBehavior
extends org.apache.wicket.ajax.AbstractAjaxTimerBehavior
implements Serializable

Behavior used to enqueue triggers and send them to the client using timer based polling.

The polling interval is configured in the constructor. The more frequent is the polling, the more quickly your client will be updated, but also the more you will load your server and your network.

A timeout can also be configured to indicate when the behavior should consider the page has been disconnected. This is important to clean appropriately the resources associated with the page.

Author:

Xavier Hanin

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TimerChannelBehavior.TimerPushTarget An IPushTarget implementation which enqueue DelayedMethodCallList, also called triggers, for a TimerChannelBehavior identified by its id.

Field Summary

Fields inherited from class org.apache.wicket.ajax.AbstractDefaultAjaxBehavior

INDICATOR

Fields inherited from interface org.apache.wicket.behavior.IBehaviorListener

INTERFACE

Constructor Summary

Constructors

Constructor and Description
TimerChannelBehavior(org.apache.wicket.util.time.Duration updateInterval) Construct a TimerChannelBehavior which actually refreshes the clients by polling the server for changes at the given duration.
TimerChannelBehavior(org.apache.wicket.util.time.Duration updateInterval, org.apache.wicket.util.time.Duration timeout) Construct a TimerChannelBehavior which actually refreshes the clients by polling the server for changes at the given duration.

Method Summary

Modifier and Type	Method and Description
String	getId()
static boolean	isConnected(org.apache.wicket.Application application, String id, org.apache.wicket.util.time.Duration timeout)
org.wicketstuff.chat.channel.api.IPushTarget	newPushTarget() Creates a new push target to which triggers can be sent
protected void	onBind()
protected void	onTimer(org.apache.wicket.ajax.AjaxRequestTarget target)
void	renderHead(org.apache.wicket.Component component, org.apache.wicket.markup.head.IHeaderResponse response)
String	toString()

Methods inherited from class org.apache.wicket.ajax.AbstractAjaxTimerBehavior

getJsTimeoutCall, getUpdateInterval, isStopped, onRemove, onRestart, onUnbind, respond, restart, setUpdateInterval, shouldTrigger, stop

Methods inherited from class org.apache.wicket.ajax.AbstractDefaultAjaxBehavior

findIndicatorId, getAttributes, getCallbackFunction, getCallbackFunctionBody, getCallbackScript, getCallbackScript, getChannel, getFailureScript, getPreconditionScript, getSuccessScript, onRequest, postprocessConfiguration, renderAjaxAttributes, renderAjaxAttributes, updateAjaxAttributes

Methods inherited from class org.apache.wicket.behavior.AbstractAjaxBehavior

afterRender, bind, getCallbackUrl, getComponent, onComponentRendered, onComponentTag, onComponentTag, unbind

Methods inherited from class org.apache.wicket.behavior.Behavior

beforeRender, canCallListenerInterface, detach, getStatelessHint, isEnabled, isTemporary, onConfigure, onEvent, onException

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TimerChannelBehavior

public TimerChannelBehavior(org.apache.wicket.util.time.Duration updateInterval)

Construct a TimerChannelBehavior which actually refreshes the clients by polling the server for changes at the given duration.

Parameters:

updateInterval - the interval at which the server should be polled for changes

TimerChannelBehavior

public TimerChannelBehavior(org.apache.wicket.util.time.Duration updateInterval,
                            org.apache.wicket.util.time.Duration timeout)

Construct a TimerChannelBehavior which actually refreshes the clients by polling the server for changes at the given duration.

Parameters:

updateInterval - the interval at which the server should be polled for changes

timeout - The timeout to set

Method Detail

isConnected

public static boolean isConnected(org.apache.wicket.Application application,
                                  String id,
                                  org.apache.wicket.util.time.Duration timeout)

getId

public String getId()

newPushTarget

public org.wicketstuff.chat.channel.api.IPushTarget newPushTarget()

Creates a new push target to which triggers can be sent

Returns:

an IPushTarget to which triggers can be sent in any thread.

onBind

protected void onBind()

Overrides:

onBind in class org.apache.wicket.ajax.AbstractDefaultAjaxBehavior

onTimer

protected void onTimer(org.apache.wicket.ajax.AjaxRequestTarget target)

Specified by:

onTimer in class org.apache.wicket.ajax.AbstractAjaxTimerBehavior

See Also:

AbstractAjaxTimerBehavior.onTimer(AjaxRequestTarget)

renderHead

public void renderHead(org.apache.wicket.Component component,
                       org.apache.wicket.markup.head.IHeaderResponse response)

Specified by:

renderHead in interface org.apache.wicket.markup.html.IComponentAwareHeaderContributor

Overrides:

renderHead in class org.apache.wicket.ajax.AbstractAjaxTimerBehavior

toString

public String toString()

Overrides:

toString in class Object