org.jboss.remoting.util
Interface StoppableTimerTask

All Known Implementing Classes:

ConnectionValidator

public interface StoppableTimerTask

When a StoppableTimerTask is passed to TimerUtil.schedule(), TimerUtil will keep track of it so that it can call StoppableTimerTask.stop() during TimerUtil.destroy(). Note that when a StoppableTimerTask is done, it should call TimerTask.unschedule(this) so that the reference to it is removed. Note that there is a danger of an infinite loop because if StoppableTimerTask.stop() calls TimerTask.unschedule(this), the TimerTask.unschedule(this) will call this.StoppableTimerTask(). It follows that StoppableTimerTask.stop() should guard against this danger.

Version:

$Revision: 1977 $

Copyright Jan 18, 2007

Author:

Ron Sigal

Method Summary

void	stop() stop() will be called when TimerUtil.unschedule() or when TimerUtil.destroy() are called.

Method Detail

stop

void stop()
          throws java.lang.Exception

stop() will be called when TimerUtil.unschedule() or when TimerUtil.destroy() are called.

Throws:

java.lang.Exception