Class TimeoutStream
- java.lang.Object
-
- io.vertx.reactivex.core.TimeoutStream
-
- All Implemented Interfaces:
ReadStream<Long>
,StreamBase
public class TimeoutStream extends Object implements ReadStream<Long>
A timeout stream is triggered by a timer, theHandler
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 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.
NOTE: This class has been automatically generated from theoriginal
non RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static TypeArg<TimeoutStream>
__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description TimeoutStream(TimeoutStream delegate)
TimeoutStream(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
cancel()
Deprecated.TimeoutStream
endHandler(Handler<Void> endHandler)
Deprecated.boolean
equals(Object o)
TimeoutStream
exceptionHandler(Handler<Throwable> handler)
Deprecated.TimeoutStream
fetch(long amount)
Deprecated.TimeoutStream
getDelegate()
TimeoutStream
handler(Handler<Long> handler)
Deprecated.int
hashCode()
static TimeoutStream
newInstance(TimeoutStream arg)
TimeoutStream
pause()
Deprecated.Pipe<Long>
pipe()
Deprecated.void
pipeTo(WriteStream<Long> dst)
Deprecated.void
pipeTo(WriteStream<Long> dst, Handler<AsyncResult<Void>> handler)
Deprecated.TimeoutStream
resume()
Deprecated.io.reactivex.Completable
rxPipeTo(WriteStream<Long> dst)
Deprecated.io.reactivex.Flowable<Long>
toFlowable()
io.reactivex.Observable<Long>
toObservable()
String
toString()
-
-
-
Field Detail
-
__TYPE_ARG
public static final TypeArg<TimeoutStream> __TYPE_ARG
-
-
Constructor Detail
-
TimeoutStream
public TimeoutStream(TimeoutStream delegate)
-
TimeoutStream
public TimeoutStream(Object delegate)
-
-
Method Detail
-
getDelegate
public TimeoutStream getDelegate()
- Specified by:
getDelegate
in interfaceReadStream<Long>
- Specified by:
getDelegate
in interfaceStreamBase
-
toObservable
public io.reactivex.Observable<Long> toObservable()
- Specified by:
toObservable
in interfaceReadStream<Long>
-
toFlowable
public io.reactivex.Flowable<Long> toFlowable()
- Specified by:
toFlowable
in interfaceReadStream<Long>
-
pipe
@Deprecated public Pipe<Long> pipe()
Deprecated.Pause this stream and return a to transfer the elements of this stream to a destination . The stream will be resumed when the pipe will be wired to aWriteStream
.- Specified by:
pipe
in interfaceReadStream<Long>
- Returns:
- a pipe
-
pipeTo
@Deprecated public void pipeTo(WriteStream<Long> dst, Handler<AsyncResult<Void>> handler)
Deprecated.Pipe thisReadStream
to theWriteStream
.Elements emitted by this stream will be written to the write stream until this stream ends or fails.
Once this stream has ended or failed, the write stream will be ended and the
handler
will be called with the result.- Specified by:
pipeTo
in interfaceReadStream<Long>
- Parameters:
dst
- the destination write streamhandler
-
-
pipeTo
@Deprecated public void pipeTo(WriteStream<Long> dst)
Deprecated.Pipe thisReadStream
to theWriteStream
.Elements emitted by this stream will be written to the write stream until this stream ends or fails.
Once this stream has ended or failed, the write stream will be ended and the
handler
will be called with the result.- Specified by:
pipeTo
in interfaceReadStream<Long>
- Parameters:
dst
- the destination write stream
-
rxPipeTo
@Deprecated public io.reactivex.Completable rxPipeTo(WriteStream<Long> dst)
Deprecated.Pipe thisReadStream
to theWriteStream
.Elements emitted by this stream will be written to the write stream until this stream ends or fails.
Once this stream has ended or failed, the write stream will be ended and the
handler
will be called with the result.- Specified by:
rxPipeTo
in interfaceReadStream<Long>
- Parameters:
dst
- the destination write stream- Returns:
-
exceptionHandler
@Deprecated public TimeoutStream exceptionHandler(Handler<Throwable> handler)
Deprecated.Description copied from interface:ReadStream
Set an exception handler on the read stream.- Specified by:
exceptionHandler
in interfaceReadStream<Long>
- Specified by:
exceptionHandler
in interfaceStreamBase
- Parameters:
handler
- the exception handler- Returns:
- a reference to this, so the API can be used fluently
-
handler
@Deprecated public TimeoutStream handler(Handler<Long> handler)
Deprecated.Description copied from interface:ReadStream
Set a data handler. As data is read, the handler will be called with the data.- Specified by:
handler
in interfaceReadStream<Long>
- Returns:
- a reference to this, so the API can be used fluently
-
pause
@Deprecated public TimeoutStream pause()
Deprecated.Description copied from interface:ReadStream
Pause theReadStream
, it sets the buffer infetch
mode and clears the actual demand.While it's paused, no data will be sent to the data
handler
.- Specified by:
pause
in interfaceReadStream<Long>
- Returns:
- a reference to this, so the API can be used fluently
-
resume
@Deprecated public TimeoutStream resume()
Deprecated.Description copied from interface:ReadStream
Resume reading, and sets the buffer inflowing
mode. If theReadStream
has been paused, reading will recommence on it.- Specified by:
resume
in interfaceReadStream<Long>
- Returns:
- a reference to this, so the API can be used fluently
-
fetch
@Deprecated public TimeoutStream fetch(long amount)
Deprecated.Description copied from interface:ReadStream
Fetch the specifiedamount
of elements. If theReadStream
has been paused, reading will recommence with the specifiedamount
of items, otherwise the specifiedamount
will be added to the current stream demand.- Specified by:
fetch
in interfaceReadStream<Long>
- Returns:
- a reference to this, so the API can be used fluently
-
endHandler
@Deprecated public TimeoutStream endHandler(Handler<Void> endHandler)
Deprecated.Description copied from interface:ReadStream
Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.- Specified by:
endHandler
in interfaceReadStream<Long>
- Returns:
- a reference to this, so the API can be used fluently
-
cancel
@Deprecated public void cancel()
Deprecated.Cancels the timeout. Note this has the same effect as callinghandler(io.vertx.core.Handler<java.lang.Long>)
with a null argument.
-
newInstance
public static TimeoutStream newInstance(TimeoutStream arg)
-
-