vertx / io.vertx.core / TimeoutStream

# TimeoutStream

`interface TimeoutStream : ReadStream<Long>`

A timeout stream is triggered by a timer, the 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 `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

### Functions

cancel | `abstract fun cancel(): Unit` Cancels the timeout. Note this has the same effect as calling `#handler(Handler)` with a null argument.
endHandler | `abstract fun endHandler(endHandler: Handler<Void>): TimeoutStream`
exceptionHandler | `abstract fun exceptionHandler(handler: Handler<Throwable>): TimeoutStream`
handler | `abstract fun handler(handler: Handler<Long>): TimeoutStream`
pause | `abstract fun pause(): TimeoutStream`
resume | `abstract fun resume(): TimeoutStream`