org.wicketstuff.push.timer

Class TimerPushService

java.lang.Object

org.wicketstuff.push.AbstractPushService

org.wicketstuff.push.timer.TimerPushService

All Implemented Interfaces:

IPushService

public class TimerPushService
extends AbstractPushService

AJAX timer based implementation of IPushService.

Author:

Sebastian Thomschke

Field Summary

Fields inherited from class org.wicketstuff.push.AbstractPushService

disconnectListeners, nodesByChannels

Method Summary

Methods

Modifier and Type	Method and Description
static TimerPushService	get()
static TimerPushService	get(org.apache.wicket.Application application)
org.apache.wicket.util.time.Duration	getDefaultPollingInterval()
org.apache.wicket.util.time.Duration	getMaxTimeLag()
static IPushServiceRef<TimerPushService>	getRef()
<EventType> TimerPushNode<EventType>	installNode(org.apache.wicket.Component component, IPushEventHandler<EventType> handler)
<EventType> TimerPushNode<EventType>	installNode(org.apache.wicket.Component component, IPushEventHandler<EventType> handler, org.apache.wicket.util.time.Duration pollingInterval)
boolean	isConnected(IPushNode<?> node) Determines if the node (client) is still connected, otherwise clears all queued events.
<EventType> void	publish(IPushChannel<EventType> channel, EventType event)
<EventType> void	publish(IPushNode<EventType> node, EventType event) Queues the given event for later processing by the associated IPushEventHandler.
void	setCleanupInterval(org.apache.wicket.util.time.Duration interval) Sets the interval in which the clean up task will be executed that removes information about disconnected push nodes.
void	setDefaultPollingInterval(org.apache.wicket.util.time.Duration defaultPollingInterval)
void	setMaxTimeLag(org.apache.wicket.util.time.Duration maxTimeLag)
void	uninstallNode(org.apache.wicket.Component component, IPushNode<?> node)

Methods inherited from class org.wicketstuff.push.AbstractPushService

addNodeDisconnectedListener, connectToChannel, createChannel, disconnectFromAllChannels, disconnectFromChannel, removeChannel, removeNodeDisconnectedListener

Methods inherited from class java.lang.Object

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

Method Detail

get

public static TimerPushService get()

get

public static TimerPushService get(org.apache.wicket.Application application)

getRef

public static IPushServiceRef<TimerPushService> getRef()

Returns:

a serializable service reference

getDefaultPollingInterval

public org.apache.wicket.util.time.Duration getDefaultPollingInterval()

getMaxTimeLag

public org.apache.wicket.util.time.Duration getMaxTimeLag()

installNode

public <EventType> TimerPushNode<EventType> installNode(org.apache.wicket.Component component,
                                               IPushEventHandler<EventType> handler)

installNode

public <EventType> TimerPushNode<EventType> installNode(org.apache.wicket.Component component,
                                               IPushEventHandler<EventType> handler,
                                               org.apache.wicket.util.time.Duration pollingInterval)

isConnected

public boolean isConnected(IPushNode<?> node)

Determines if the node (client) is still connected, otherwise clears all queued events.

publish

public <EventType> void publish(IPushChannel<EventType> channel,
                       EventType event)

publish

public <EventType> void publish(IPushNode<EventType> node,
                       EventType event)

Queues the given event for later processing by the associated IPushEventHandler. The method does nothing in case the node is no longer connected.

setCleanupInterval

public void setCleanupInterval(org.apache.wicket.util.time.Duration interval)

Sets the interval in which the clean up task will be executed that removes information about disconnected push nodes. Default is 60 seconds.

setDefaultPollingInterval

public void setDefaultPollingInterval(org.apache.wicket.util.time.Duration defaultPollingInterval)

setMaxTimeLag

public void setMaxTimeLag(org.apache.wicket.util.time.Duration maxTimeLag)

uninstallNode

public void uninstallNode(org.apache.wicket.Component component,
                 IPushNode<?> node)