Package io.vertx.ext.reactivestreams
Interface ReactiveWriteStream<T>
-
- All Superinterfaces:
org.reactivestreams.Publisher<T>,StreamBase,WriteStream<T>
public interface ReactiveWriteStream<T> extends WriteStream<T>, org.reactivestreams.Publisher<T>
A Vert.x write stream that also implements reactive streams publisher interface.- Author:
- Tim Fox
-
-
Field Summary
Fields Modifier and Type Field Description static intDEFAULT_WRITE_QUEUE_MAX_SIZEDefault write queue max size
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description ReactiveWriteStream<T>close()Close the streamReactiveWriteStream<T>drainHandler(Handler<Void> handler)Set a drain handler on the stream.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 tomaxSize.Future<Void>write(T data)Write some data to the stream.static <T> ReactiveWriteStream<T>writeStream(Vertx vertx)Create a reactive write stream-
Methods inherited from interface io.vertx.core.streams.WriteStream
end, end, writeQueueFull
-
-
-
-
Field Detail
-
DEFAULT_WRITE_QUEUE_MAX_SIZE
static final int DEFAULT_WRITE_QUEUE_MAX_SIZE
Default write queue max size- See Also:
- Constant Field Values
-
-
Method Detail
-
writeStream
static <T> ReactiveWriteStream<T> writeStream(Vertx vertx)
Create a reactive write stream- Parameters:
vertx- the Vert.x instance- Returns:
- the stream
-
exceptionHandler
ReactiveWriteStream<T> exceptionHandler(Handler<Throwable> handler)
Description copied from interface:WriteStreamSet an exception handler on the write stream.- Specified by:
exceptionHandlerin interfaceStreamBase- Specified by:
exceptionHandlerin interfaceWriteStream<T>- Parameters:
handler- the exception handler- Returns:
- a reference to this, so the API can be used fluently
-
write
Future<Void> write(T data)
Description copied from interface:WriteStreamWrite some data to the stream.The data is usually put on an internal write queue, and the write actually happens asynchronously. To avoid running out of memory by putting too much on the write queue, check the
WriteStream.writeQueueFull()method before writing. This is done automatically if using aPipe.When the
datais moved from the queue to the actual medium, the returnedFuturewill be completed with the write result, e.g the future is succeeded when a server HTTP response buffer is written to the socket and failed if the remote client has closed the socket while the data was still pending for write.- Specified by:
writein interfaceWriteStream<T>- Parameters:
data- the data to write- Returns:
- a future completed with the write result
-
setWriteQueueMaxSize
ReactiveWriteStream<T> setWriteQueueMaxSize(int maxSize)
Description copied from interface:WriteStreamSet the maximum size of the write queue tomaxSize. You will still be able to write to the stream even if there is more thanmaxSizeitems in the write queue. This is used as an indicator by classes such asPipeto provide flow control. The value is defined by the implementation of the stream, e.g in bytes for aNetSocket, etc...- Specified by:
setWriteQueueMaxSizein interfaceWriteStream<T>- Parameters:
maxSize- the max size of the write stream- Returns:
- a reference to this, so the API can be used fluently
-
drainHandler
ReactiveWriteStream<T> drainHandler(Handler<Void> handler)
Description copied from interface:WriteStreamSet a drain handler on the stream. If the write queue is full, then the handler will be called when the write queue is ready to accept buffers again. SeePipefor 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.- Specified by:
drainHandlerin interfaceWriteStream<T>- Parameters:
handler- the handler- Returns:
- a reference to this, so the API can be used fluently
-
close
ReactiveWriteStream<T> close()
Close the stream- Returns:
- a reference to this for a fluent API
-
-