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.
|
void |
end()
Same as
end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes |
void |
end(Handler<AsyncResult<Void>> handler)
Same as
end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes |
void |
end(T data)
Same as but with an
handler called when the operation completes |
void |
end(T data,
Handler<AsyncResult<Void>> handler)
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) |
Single<Void> |
rxEnd()
Same as
end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes |
Single<Void> |
rxEnd(T data)
Same as but with an
handler called when the operation completes |
Single<Void> |
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 . |
void |
write(T data)
Same as but with an
handler called when the operation completes |
void |
write(T data,
Handler<AsyncResult<Void>> handler)
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) |
newInstance
WriteStream getDelegate()
getDelegate
in interface StreamBase
WriteStream<T> exceptionHandler(Handler<Throwable> handler)
exceptionHandler
in interface StreamBase
handler
- the exception handlervoid write(T data, Handler<AsyncResult<Void>> handler)
handler
called when the operation completesdata
- handler
- void write(T data)
handler
called when the operation completesdata
- Single<Void> rxWrite(T data)
handler
called when the operation completesdata
- void end(Handler<AsyncResult<Void>> handler)
end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with an handler
called when the operation completeshandler
- void end()
end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with an handler
called when the operation completesSingle<Void> rxEnd()
end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with an handler
called when the operation completesvoid end(T data, Handler<AsyncResult<Void>> handler)
handler
called when the operation completesdata
- handler
- void end(T data)
handler
called when the operation completesdata
- Single<Void> 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 © 2022 Eclipse. All rights reserved.