@groovy.transform.CompileStatic class WriteStreamImpl extends java.lang.Object
Constructor and description |
---|
WriteStreamImpl
(java.lang.Object delegate) |
Type | Name and description |
---|---|
WriteStream<T> |
drainHandler(io.vertx.core.Handler<java.lang.Void> handler) Set a drain handler on the stream. |
void |
end() Ends the stream. |
void |
end(T t) Same as WriteStream.end but writes some data to the stream before ending. |
WriteStream<T> |
exceptionHandler(io.vertx.core.Handler<java.lang.Throwable> handler) Set an exception handler on the write stream. |
java.lang.Object |
getDelegate() |
WriteStream<T> |
setWriteQueueMaxSize(int maxSize) Set the maximum size of the write queue to maxSize . |
WriteStream<T> |
write(T data) Write some data to the stream. |
boolean |
writeQueueFull() This will return true if there are more bytes in the write queue than the value set using WriteStream.setWriteQueueMaxSize |
Methods inherited from class | Name |
---|---|
class java.lang.Object |
java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll() |
Set a drain handler on the stream. If the write queue is full, then the handler will be called when the write queue has been reduced to maxSize / 2. See Pump for an example of this being used.
handler
- the handlerEnds the stream.
Once the stream has ended, it cannot be used any more.
Same as WriteStream.end but writes some data to the stream before ending.
Set an exception handler on the write stream.
handler
- the exception handler Set the maximum size of the write queue to maxSize
. You will still be able to write to the stream even
if there is more than maxSize
bytes in the write queue. This is used as an indicator by classes such as
Pump
to provide flow control.
maxSize
- the max size of the write streamWrite some data to the stream. The data is 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 a Pump.
data
- the data to write This will return true
if there are more bytes in the write queue than the value set using WriteStream.setWriteQueueMaxSize