org.directwebremoting.impl
Class ShutdownAlarm

java.lang.Object
  org.directwebremoting.impl.BasicAlarm
      org.directwebremoting.impl.ShutdownAlarm

All Implemented Interfaces:

Alarm

public class ShutdownAlarm
extends BasicAlarm
implements Alarm

An Alarm that allows the system to close all connections when it is shutting down.

WARNING: This code has a non-obvious side effect - The server load monitor (which hands out shutdown messages) also monitors usage by looking at the number of connected alarms.

Author:

Joe Walker [joe at getahead dot ltd dot uk]

Constructor Summary

ShutdownAlarm(ServerLoadMonitor serverLoadMonitor)
Register ourselves with the ServerLoadMonitor so we can raise an Alarm if we get shutdown

Method Summary

void	cancel() Prevent further calls to Sleeper.wakeUp().
void	setAlarmAction(Sleeper sleeper) Alarms need something to do when they go off.

Methods inherited from class org.directwebremoting.impl.BasicAlarm

raiseAlarm

Methods inherited from class java.lang.Object

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

Constructor Detail

ShutdownAlarm

public ShutdownAlarm(ServerLoadMonitor serverLoadMonitor)

Register ourselves with the ServerLoadMonitor so we can raise an Alarm if we get shutdown

Parameters:

serverLoadMonitor -

Method Detail

setAlarmAction

public void setAlarmAction(Sleeper sleeper)

Description copied from interface: Alarm

Alarms need something to do when they go off. After this method has been called the Alarm may 'go off', once only, by calling Sleeper.wakeUp().

Specified by:

setAlarmAction in interface Alarm

Overrides:

setAlarmAction in class BasicAlarm

Parameters:

sleeper - The action to awake when the alarm goes off

cancel

public void cancel()

Description copied from interface: Alarm

Prevent further calls to Sleeper.wakeUp(). See the note about late calls above.

Specified by:

cancel in interface Alarm

Overrides:

cancel in class BasicAlarm