ch.dermitza.securenio.socket.timeout.worker

Class TimeoutWorker

java.lang.Object

ch.dermitza.securenio.socket.timeout.worker.TimeoutWorker

All Implemented Interfaces:

java.lang.Runnable

public class TimeoutWorker
extends java.lang.Object
implements java.lang.Runnable

A threaded implementation of a worker processing Timeouts required by the AbstractSelector.

The worker processes timeouts in an expiration-based FIFO fashion. Every existing Timeout is being waited upon until either cancelled or expired. If a timeout expires, the Timeout.expired() method is called on that timeout.

Every insertion or removal of Timeouts causes the TimeoutWorker to wake up from waiting, recalculate the shortest timeout to wait for, and go back to sleep. The TimeoutWorker is otherwise waiting for incoming tasks via the insert(Timeout) method.

Since:

0.18

Constructor Summary

Constructors

Constructor and Description
TimeoutWorker()

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel(Timeout timeout) Cancel an already waited-on Timeout.
void	insert(Timeout timeout) Insert a Timeout that needs to be waited upon.
boolean	isRunning() Check whether the TimeoutWorker is running.
void	run() The run() method of the TimeoutWorker.
void	setRunning(boolean running) Set the running status of the TimeoutWorker.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeoutWorker

public TimeoutWorker()

Method Detail

insert

public void insert(Timeout timeout)

Insert a Timeout that needs to be waited upon. Every Timeout insertion causes the TimeoutWorker to wake up from waiting, recalculate the shortest timeout to wait for, and go back to sleep.

This implementation is thread-safe.

Parameters:

timeout - The Timeout to be waited upon.

cancel

public void cancel(Timeout timeout)

Cancel an already waited-on Timeout. Every Timeout removal causes the TimeoutWorker to wake up from waiting, recalculate the shortest timeout to wait for, and go back to sleep.

This implementation is thread-safe.

Parameters:

timeout - The timeout to cancel

isRunning

public boolean isRunning()

Check whether the TimeoutWorker is running.

This implementation is thread-safe.

Returns:

true if it is running, false otherwise

setRunning

public void setRunning(boolean running)

Set the running status of the TimeoutWorker. If the running status of the worker is set to false, the TimeoutWorker is interrupted (if waiting for a task) in order to cleanly shutdown.

This implementation is thread-safe.

Parameters:

running - Whether the TaskWorker should run

run

public void run()

The run() method of the TimeoutWorker. Here, every existing Timeout is being waited upon until either cancelled or expired. If a timeout expires, the Timeout.expired() method is called on that timeout.

Every insertion or removal of Timeouts causes the TimeoutWorker to wake up from waiting, recalculate the shortest timeout to wait for, and go back to sleep.

Specified by:

run in interface java.lang.Runnable