org.realityforge.gwt.webpoller.server

Class TimerBasedWebPoller

java.lang.Object

org.realityforge.gwt.webpoller.client.WebPoller

org.realityforge.gwt.webpoller.server.TimerBasedWebPoller

public class TimerBasedWebPoller
extends WebPoller

A web-poller that used the standard Timer class to schedule requests.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TimerBasedWebPoller.Factory

Field Summary

Fields inherited from class org.realityforge.gwt.webpoller.client.WebPoller

DEFAULT_ERROR_COUNT_THRESHOLD, DEFAULT_INTER_ERROR_DURATION, DEFAULT_INTER_REQUEST_DURATION

Constructor Summary

Constructors

Constructor and Description
TimerBasedWebPoller(java.util.concurrent.ScheduledExecutorService timer)

Method Summary

Modifier and Type	Method and Description
protected void	incErrorCount()
boolean	inError()
boolean	isActive()
protected boolean	isInPoll()
boolean	isPaused()
protected boolean	isTimerActive() Return true if the timer or the error timer is active.
void	pause() Pause the active poller.
protected void	poll() Orchestrate the polling.
protected void	pollReturned() This should be invoked when the poll has completed.
protected void	resetErrorState() Invoked after a successful poll, regardless of whether data was received or not.
void	resume() Resume an already paused poller.
void	start() Start polling.
protected void	startErrorTimer()
protected void	startTimer() Start the timer that triggers the polling.
void	stop() Stop polling.
protected void	stopErrorTimer()
protected void	stopTimer() Stop the timer that is triggering the polling if any exists.

Methods inherited from class org.realityforge.gwt.webpoller.client.WebPoller

deregister, doPoll, doStart, doStop, getErrorCountThreshold, getInterErrorDuration, getInterRequestDuration, getLogLevel, getRequestContext, getRequestFactory, newWebPoller, onEmptyPollResult, onError, onMessage, onStart, onStop, register, setErrorCountThreshold, setInterErrorDuration, setInterRequestDuration, setListener, setLogLevel, setRequestFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

TimerBasedWebPoller

public TimerBasedWebPoller(@Nonnull
                           java.util.concurrent.ScheduledExecutorService timer)

Method Detail

startTimer

protected void startTimer()

Description copied from class: WebPoller

Start the timer that triggers the polling.

Specified by:

startTimer in class WebPoller

isTimerActive

protected boolean isTimerActive()

Description copied from class: WebPoller

Return true if the timer or the error timer is active.

Specified by:

isTimerActive in class WebPoller

stopTimer

protected void stopTimer()

Description copied from class: WebPoller

Stop the timer that is triggering the polling if any exists.

Specified by:

stopTimer in class WebPoller

startErrorTimer

protected void startErrorTimer()

Specified by:

startErrorTimer in class WebPoller

stopErrorTimer

protected void stopErrorTimer()

Specified by:

stopErrorTimer in class WebPoller

start

public void start()

Description copied from class: WebPoller

Start polling.

Overrides:

start in class WebPoller

stop

public void stop()

Description copied from class: WebPoller

Stop polling.

Overrides:

stop in class WebPoller

pause

public void pause()

Description copied from class: WebPoller

Pause the active poller. The poller will cease actually polling until resume is called.

Overrides:

pause in class WebPoller

resume

public void resume()

Description copied from class: WebPoller

Resume an already paused poller. The poller will resume polling.

Overrides:

resume in class WebPoller

isPaused

public boolean isPaused()

Overrides:

isPaused in class WebPoller

Returns:

true if poller is paused.

isActive

public boolean isActive()

Overrides:

isActive in class WebPoller

Returns:

true if the poller is active.

inError

public boolean inError()

Overrides:

inError in class WebPoller

Returns:

true if active and the last poll resulted in error, false otherwise.

resetErrorState

protected void resetErrorState()

Description copied from class: WebPoller

Invoked after a successful poll, regardless of whether data was received or not.

Overrides:

resetErrorState in class WebPoller

incErrorCount

protected void incErrorCount()

Overrides:

incErrorCount in class WebPoller

isInPoll

protected boolean isInPoll()

Overrides:

isInPoll in class WebPoller

Returns:

true if a poll request is outstanding.

pollReturned

protected void pollReturned()

Description copied from class: WebPoller

This should be invoked when the poll has completed. It may be overriden by sub-classes to perform other cleanup.

Overrides:

pollReturned in class WebPoller

poll

protected void poll()

Description copied from class: WebPoller

Orchestrate the polling.

Overrides:

poll in class WebPoller