io.vertx.core.TimeoutStream Maven / Gradle / Ivy
/*
* Copyright (c) 2011-2013 The original author or authors
* ------------------------------------------------------
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* and Apache License v2.0 which accompanies this distribution.
*
* The Eclipse Public License is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* The Apache License v2.0 is available at
* http://www.opensource.org/licenses/apache2.0.php
*
* You may elect to redistribute this code under either of these licenses.
*/
package io.vertx.core;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.streams.ReadStream;
/**
* A timeout stream is triggered by a timer, the {@link io.vertx.core.Handler} will be call when the timer is fired,
* it can be once or several times depending on the nature of the timer related to this stream. The
* {@link ReadStream#endHandler(Handler)} will be called after the timer handler has been called.
*
* Pausing the timer inhibits the timer shots until the stream is resumed. Setting a null handler callback cancels
* the timer.
*
* @author Julien Viet
*/
@VertxGen
public interface TimeoutStream extends ReadStream {
@Override
TimeoutStream exceptionHandler(Handler handler);
@Override
TimeoutStream handler(Handler handler);
@Override
TimeoutStream pause();
@Override
TimeoutStream resume();
@Override
TimeoutStream endHandler(Handler endHandler);
/**
* Cancels the timeout. Note this has the same effect as calling {@link #handler(Handler)} with a null
* argument.
*/
void cancel();
}