public interface WriteStream<T> extends StreamBase
| Modifier and Type | Method and Description |
|---|---|
WriteStream<T> |
drainHandler(Handler<Void> handler)
Set a drain handler on the stream.
|
Completable |
end()
Same as
end() but with an handler called when the operation completes |
Completable |
end(T data)
Same as but with an
handler called when the operation completes |
WriteStream<T> |
exceptionHandler(Handler<Throwable> handler)
Set an exception handler on the write stream.
|
WriteStream |
getDelegate() |
static <T> WriteStream<T> |
newInstance(WriteStream arg) |
static <T> WriteStream<T> |
newInstance(WriteStream arg,
io.vertx.lang.rx.TypeArg<T> __typeArg_T) |
Completable |
rxEnd()
Same as
end() but with an handler called when the operation completes |
Completable |
rxEnd(T data)
Same as but with an
handler called when the operation completes |
Completable |
rxWrite(T data)
Same as but with an
handler called when the operation completes |
WriteStream<T> |
setWriteQueueMaxSize(int maxSize)
Set the maximum size of the write queue to
maxSize. |
Completable |
write(T data)
Same as but with an
handler called when the operation completes |
boolean |
writeQueueFull()
This will return
true if there are more bytes in the write queue than the value set using setWriteQueueMaxSize(int) |
newInstanceWriteStream getDelegate()
getDelegate in interface StreamBaseWriteStream<T> exceptionHandler(Handler<Throwable> handler)
exceptionHandler in interface StreamBasehandler - the exception handlerCompletable write(T data)
handler called when the operation completesdata - Completable rxWrite(T data)
handler called when the operation completesdata - Completable end()
end() but with an handler called when the operation completesCompletable rxEnd()
end() but with an handler called when the operation completesCompletable end(T data)
handler called when the operation completesdata - Completable rxEnd(T data)
handler called when the operation completesdata - WriteStream<T> setWriteQueueMaxSize(int maxSize)
maxSize. You will still be able to write to the stream even
if there is more than maxSize items in the write queue. This is used as an indicator by classes such as
Pipe to provide flow control.
The value is defined by the implementation of the stream, e.g in bytes for a
NetSocket, etc...maxSize - the max size of the write streamboolean writeQueueFull()
true if there are more bytes in the write queue than the value set using setWriteQueueMaxSize(int)true if write queue is fullWriteStream<T> drainHandler(Handler<Void> handler)
Pipe for an example of this being used.
The stream implementation defines when the drain handler, for example it could be when the queue size has been
reduced to maxSize / 2.
handler - the handlerstatic <T> WriteStream<T> newInstance(WriteStream arg)
static <T> WriteStream<T> newInstance(WriteStream arg, io.vertx.lang.rx.TypeArg<T> __typeArg_T)
Copyright © 2023 Eclipse. All rights reserved.