org.jboss.util.timeout
Interface Timeout

public interface Timeout

The public interface of timeouts.

Version:

$Revision: 1.2 $

Author:

Ole Husgaard

Method Summary

void	cancel() Cancel this timeout.

Method Detail

cancel

public void cancel()

Cancel this timeout. It is guaranteed that on return from this method this timer is no longer active. This means that either it has been cancelled and the timeout will not happen, or (in case of late cancel) the timeout has happened and the timeout callback function has returned. On return from this method this instance should no longer be used. The reason for this is that an implementation may reuse cancelled timeouts, and at return the instance may already be in use for another timeout.