public interface TimeoutStream extends ReadStream<Long>
A timeout stream triggered by a timer, the 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.<p>
Pausing the timer inhibits the timer shots until the stream is resumed. Setting a null handler callback cancels the timer.
| Modifier and Type | Method and Description |
|---|---|
void |
cancel()
Cancels the timeout.
|
TimeoutStream |
endHandler(Handler<Void> endHandler)
Set an end handler.
|
TimeoutStream |
exceptionHandler(Handler<Throwable> handler)
Set an exception handler.
|
TimeoutStream |
handler(Handler<Long> handler)
Set a data handler.
|
TimeoutStream |
pause()
Pause the
ReadSupport. |
TimeoutStream |
resume()
Resume reading.
|
TimeoutStream exceptionHandler(Handler<Throwable> handler)
StreamBaseSet an exception handler.
exceptionHandler in interface ReadStream<Long>exceptionHandler in interface StreamBaseTimeoutStream handler(Handler<Long> handler)
ReadStreamSet a data handler. As data is read, the handler will be called with the data.
handler in interface ReadStream<Long>TimeoutStream pause()
ReadStreamPause the ReadSupport. While it’s paused, no data will be sent to the dataHandler
pause in interface ReadStream<Long>TimeoutStream resume()
ReadStreamResume reading. If the ReadSupport has been paused, reading will recommence on it.
resume in interface ReadStream<Long>TimeoutStream endHandler(Handler<Void> endHandler)
ReadStreamSet an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.
endHandler in interface ReadStream<Long>void cancel()
Cancels the timeout. Note this has the same effect as calling handler(Handler) with a null
argument.
Copyright © 2014. All Rights Reserved.