SimpleTimer2.TimedEvent (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.util.SimpleTimer2.TimedEvent

All Implemented Interfaces:
Runnable
Direct Known Subclasses:
ACKTimer, BandwidthHistory, CoalesceStatsEvent, Connection.AckDupEvent, Connection.ConEvent, Connection.ResendPacketEvent, Connection.RetransmitEvent, DeadlockDetector, IdleChecker, IdleTunnelMonitor, LoadClientAppsJob.DelayedRunClient, MarkLiveliness, NewsTimerTask, PeerTestEvent, Republish, SessionIdleTimer, SocketTimeout, TempDirScanner, Tuner, TunnelGateway.DelayedFlush
Enclosing class:
SimpleTimer2
```
public abstract static class SimpleTimer2.TimedEvent
extends Object
implements Runnable
```
Base class for timer events. Extend this and use schedule()/cancel() directly instead of going through SimpleTimer2. Synchronization is on this to avoid queue duplicates. schedule() is idempotent if already scheduled. reschedule() and forceReschedule() replace the existing timer.

Field Summary
Fields
Modifier and Type Field and Description
protected net.i2p.util.SimpleTimer2.TimedEventState _state
state of the current event.
protected static int DEFAULT_FUZZ
default fuzz threshold in milliseconds

Fields
Modifier and Type	Field and Description
`protected net.i2p.util.SimpleTimer2.TimedEventState`	`_state` state of the current event.
`protected static int`	`DEFAULT_FUZZ` default fuzz threshold in milliseconds

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`TimedEvent()` Create a new timed event without scheduling.
	`TimedEvent(SimpleTimer2 pool)` Create a new timed event.
	`TimedEvent(SimpleTimer2 pool, long timeoutMs)` Create a new timed event and automatically schedules it.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`cancel()` Cancel the timed event.
`void`	`forceReschedule(long timeoutMs)` Always use the new time - ignores fuzz
`void`	`reschedule(long timeoutMs)` Use the earliest of the new time and the old time May be called from within timeReached(), but schedule() is better there.
`void`	`reschedule(long timeoutMs, boolean useEarliestTime)` May be called from within timeReached(), but schedule() is better there.
`void`	`run()`
`void`	`schedule(long timeoutMs)` Schedule this event.
`void`	`setFuzz(int fuzz)` Set reschedule threshold in ms.
`void`	`setPool(SimpleTimer2 pool)` Set the timer pool.
`abstract void`	`timeReached()` Called when this event's scheduled time arrives.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - _state
```
protected net.i2p.util.SimpleTimer2.TimedEventState _state
```
    state of the current event. All access should be under lock.
  - DEFAULT_FUZZ
```
protected static final int DEFAULT_FUZZ
```
    default fuzz threshold in milliseconds
    See Also:
    Constant Field Values
- Constructor Detail
  - TimedEvent
```
protected TimedEvent()
```
    Create a new timed event without scheduling. Pool is set later via setPool() or addEvent().
  - TimedEvent
```
public TimedEvent(SimpleTimer2 pool)
```
    Create a new timed event. Must call schedule() later.
    Parameters:
    pool - the timer pool
  - TimedEvent
```
public TimedEvent(SimpleTimer2 pool,
                  long timeoutMs)
```
    Create a new timed event and automatically schedules it.
    Parameters:
    pool - the timer pool
    timeoutMs - timeout in milliseconds
- Method Detail
  - cancel
```
public boolean cancel()
```
    Cancel the timed event. If the event is currently running, cancellation is deferred until timeReached() completes (sets _cancelAfterRun flag).
    Returns:
    true if the event will not execute, false if already idle/cancelled
  - forceReschedule
```
public void forceReschedule(long timeoutMs)
```
    Always use the new time - ignores fuzz
    Parameters:
    timeoutMs - timeout in milliseconds
  - reschedule
```
public void reschedule(long timeoutMs)
```
    Use the earliest of the new time and the old time May be called from within timeReached(), but schedule() is better there.
    Parameters:
    timeoutMs - timeout in milliseconds
  - reschedule
```
public void reschedule(long timeoutMs,
                       boolean useEarliestTime)
```
    May be called from within timeReached(), but schedule() is better there.
    Parameters:
    timeoutMs - timeout in milliseconds
    useEarliestTime - if true and already scheduled, use the earlier timeout; if false and already scheduled, use the later
  - run
```
public void run()
```
    Specified by:
    run in interface Runnable
  - schedule
```
public void schedule(long timeoutMs)
```
    Schedule this event. Does nothing if already scheduled. For self-rescheduling periodic events, call from timeReached().
    Parameters:
    timeoutMs - delay in ms
  - setFuzz
```
public void setFuzz(int fuzz)
```
    Set reschedule threshold in ms. Rescheduling is skipped if the existing and new timeouts differ by less than this value. Default 100ms.
    Parameters:
    fuzz - the fuzz threshold in ms
  - setPool
```
public void setPool(SimpleTimer2 pool)
```
    Set the timer pool. Must be called before schedule() for events created via the no-arg constructor. Called automatically by addEvent()/addPeriodicEvent(). Not thread-safe to call concurrently with schedule() or cancel().
    Parameters:
    pool - the timer pool
  - timeReached
```
public abstract void timeReached()
```
    Called when this event's scheduled time arrives. Must NOT block. For periodic events, call schedule(period) at the end to self-reschedule.
  - toString
```
public String toString()
```
    Overrides:
    toString in class Object
    Returns:
    the simple class name for log messages

Class SimpleTimer2.TimedEvent

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_state

DEFAULT_FUZZ

Constructor Detail

TimedEvent

TimedEvent

TimedEvent

Method Detail

cancel

forceReschedule

reschedule

reschedule

run

schedule

setFuzz

setPool

timeReached

toString