public interface ReactiveWriteStream<T> extends WriteStream<T>, org.reactivestreams.Publisher<T>
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_WRITE_QUEUE_MAX_SIZE
Default write queue max size
|
Modifier and Type | Method and Description |
---|---|
ReactiveWriteStream<T> |
close()
Close the stream
|
ReactiveWriteStream<T> |
drainHandler(Handler<Void> handler)
Set a drain handler on the stream.
|
void |
end()
Calls
close() . |
ReactiveWriteStream<T> |
exceptionHandler(Handler<Throwable> handler)
Set an exception handler on the write stream.
|
ReactiveWriteStream<T> |
setWriteQueueMaxSize(int maxSize)
Set the maximum size of the write queue to
maxSize . |
ReactiveWriteStream<T> |
write(T data)
Write some data to the stream.
|
ReactiveWriteStream<T> |
write(T data,
Handler<AsyncResult<Void>> handler)
Same as
#write(T) but with an handler called when the operation completes |
static <T> ReactiveWriteStream<T> |
writeStream(Vertx vertx)
Create a reactive write stream
|
end, end, end, writeQueueFull
static final int DEFAULT_WRITE_QUEUE_MAX_SIZE
static <T> ReactiveWriteStream<T> writeStream(Vertx vertx)
vertx
- the Vert.x instanceReactiveWriteStream<T> exceptionHandler(Handler<Throwable> handler)
WriteStream
exceptionHandler
in interface StreamBase
exceptionHandler
in interface WriteStream<T>
handler
- the exception handlerReactiveWriteStream<T> write(T data)
WriteStream
WriteStream.writeQueueFull()
method before writing. This is done automatically if using a Pump
.write
in interface WriteStream<T>
data
- the data to writeReactiveWriteStream<T> write(T data, Handler<AsyncResult<Void>> handler)
WriteStream
#write(T)
but with an handler
called when the operation completeswrite
in interface WriteStream<T>
ReactiveWriteStream<T> setWriteQueueMaxSize(int maxSize)
WriteStream
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
Pump
to provide flow control.
The value is defined by the implementation of the stream, e.g in bytes for a
NetSocket
, the number of Message
for a
MessageProducer
, etc...setWriteQueueMaxSize
in interface WriteStream<T>
maxSize
- the max size of the write streamReactiveWriteStream<T> drainHandler(Handler<Void> handler)
WriteStream
Pump
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
.drainHandler
in interface WriteStream<T>
handler
- the handlervoid end()
close()
.end
in interface WriteStream<T>
ReactiveWriteStream<T> close()
Copyright © 2023 Eclipse. All rights reserved.