io.vertx.core

public Interface Timer

Known Direct Implementers

extends Future<Void>io.vertx.core.impl.TimerImpl

Annotations

@VertxGen

Imports

io.vertx.codegen.annotations.VertxGen

A timer task that can be used as a future. The future is completed when the timeout expires, when the task is cancelled the future is failed with a java.util.concurrent.CancellationException.

Author: Julien Viet

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` when the future was cancelled and the timeout didn't fire. cancel() Attempt to cancel the timer task, when the timer is cancelled, the timer is failed with a `java.util.concurrent.CancellationException`.

Method Detail

cancel back to summary

cancel	back to summary
public boolean cancel() Attempt to cancel the timer task, when the timer is cancelled, the timer is failed with a `java.util.concurrent.CancellationException`. Returns:boolean `true` when the future was cancelled and the timeout didn't fire.

public boolean cancel()

Attempt to cancel the timer task, when the timer is cancelled, the timer is failed with a java.util.concurrent.CancellationException.

Returns:boolean: true when the future was cancelled and the timeout didn't fire.