public interface WriteStream<T> extends StreamBase
Any class that implements this interface can be used by a Pipe
to pipe data from a ReadStream
to it.
Modifier and Type | Method and Description |
---|---|
WriteStream<T> |
drainHandler(Handler<Void> handler)
Set a drain handler on the stream.
|
default Future<Void> |
end()
Ends the stream.
|
void |
end(Handler<AsyncResult<Void>> handler)
Same as
end() but with an handler called when the operation completes |
default Future<Void> |
end(T data)
Same as
end() but writes some data to the stream before ending. |
default void |
end(T data,
Handler<AsyncResult<Void>> handler)
Same as
#end(T) but with an handler called when the operation completes |
WriteStream<T> |
exceptionHandler(Handler<Throwable> handler)
Set an exception handler on the write stream.
|
WriteStream<T> |
setWriteQueueMaxSize(int maxSize)
Set the maximum size of the write queue to
maxSize . |
Future<Void> |
write(T data)
Write some data to the stream.
|
void |
write(T data,
Handler<AsyncResult<Void>> handler)
Same as
#write(T) 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) |
WriteStream<T> exceptionHandler(Handler<Throwable> handler)
exceptionHandler
in interface StreamBase
handler
- the exception handlerFuture<Void> write(T data)
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 writeQueueFull()
method before writing. This is done automatically if
using a Pipe
.
When the data
is moved from the queue to the actual medium, the returned
Future
will 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.
data
- the data to writevoid write(T data, Handler<AsyncResult<Void>> handler)
#write(T)
but with an handler
called when the operation completesdefault Future<Void> end()
Once the stream has ended, it cannot be used any more.
void end(Handler<AsyncResult<Void>> handler)
end()
but with an handler
called when the operation completesdefault Future<Void> end(T data)
end()
but writes some data to the stream before ending.data
- the data to writedefault void end(T data, Handler<AsyncResult<Void>> handler)
#end(T)
but with an handler
called when the operation completesWriteStream<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 handlerCopyright © 2021 Eclipse. All rights reserved.