org.wicketstuff.push.timer

Class TimerPushService

java.lang.Object

org.wicketstuff.push.AbstractPushService

org.wicketstuff.push.timer.TimerPushService

All Implemented Interfaces:

org.wicketstuff.push.IPushService

public class TimerPushService
extends org.wicketstuff.push.AbstractPushService

AJAX timer based implementation of IPushService.

Author:

Sebastian Thomschke

Field Summary

Fields inherited from class org.wicketstuff.push.AbstractPushService

disconnectListeners, nodesByChannels

Method Summary

Modifier and Type	Method and Description
static TimerPushService	get()
static TimerPushService	get(Application application)
Duration	getDefaultPollingInterval()
Duration	getMaxTimeLag()
static org.wicketstuff.push.IPushServiceRef<TimerPushService>	getRef()
<EventType> TimerPushNode<EventType>	installNode(Component component, org.wicketstuff.push.IPushEventHandler<EventType> handler)
<EventType> TimerPushNode<EventType>	installNode(Component component, org.wicketstuff.push.IPushEventHandler<EventType> handler, Duration pollingInterval)
boolean	isConnected(org.wicketstuff.push.IPushNode<?> node)
<EventType> void	publish(org.wicketstuff.push.IPushChannel<EventType> channel, EventType event)
<EventType> void	publish(org.wicketstuff.push.IPushNode<EventType> node, EventType event)
void	setCleanupInterval(Duration interval) Sets the interval in which the clean up task will be executed that removes information about disconnected push nodes.
void	setDefaultPollingInterval(Duration defaultPollingInterval)
void	setMaxTimeLag(Duration maxTimeLag)
void	uninstallNode(Component component, org.wicketstuff.push.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(Application application)

getRef

public static org.wicketstuff.push.IPushServiceRef<TimerPushService> getRef()

Returns:

a serializable service reference

getDefaultPollingInterval

public Duration getDefaultPollingInterval()

getMaxTimeLag

public Duration getMaxTimeLag()

installNode

public <EventType> TimerPushNode<EventType> installNode(Component component,
                                                        org.wicketstuff.push.IPushEventHandler<EventType> handler)

installNode

public <EventType> TimerPushNode<EventType> installNode(Component component,
                                                        org.wicketstuff.push.IPushEventHandler<EventType> handler,
                                                        Duration pollingInterval)

isConnected

public boolean isConnected(org.wicketstuff.push.IPushNode<?> node)

publish

public <EventType> void publish(org.wicketstuff.push.IPushChannel<EventType> channel,
                                EventType event)

publish

public <EventType> void publish(org.wicketstuff.push.IPushNode<EventType> node,
                                EventType event)

setCleanupInterval

public void setCleanupInterval(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(Duration defaultPollingInterval)

setMaxTimeLag

public void setMaxTimeLag(Duration maxTimeLag)

uninstallNode

public void uninstallNode(Component component,
                          org.wicketstuff.push.IPushNode<?> node)