Class: WriteStream

vertx/streams~ WriteStream

new WriteStream(delegate)

Provides methods to read from a data stream. It's used by things like module:vertx/file_system.AsyncFile and module:vertx/http.HttpServerResponse and is not typically instantiated directly.
Parameters:
Name Type Description
delegate external:WriteStream The Java delegate
Source:

Extends

Methods

drainHandler(handler)

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 module:vertx/pump~Pump for an example of this being used.
Parameters:
Name Type Description
handler Handler the handler to call when the stream has been drained
Inherited From:
Source:

exceptionHandler(handler)

Set an exception handler on the stream
Parameters:
Name Type Description
handler Handler the handler to call when an exception occurs
Inherited From:
Source:

write(data)

Write 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 module:vertx/streams~WriteStream#writeQueueFull method before writing. This is done automatically if using a module:vertx/pump~Pump.
Parameters:
Name Type Description
data module:vertx/buffer~Buffer the data to write
Source:

writeQueueFull()

This will return true if there are more bytes in the write queue than the value set using writeQueueMaxSize
Inherited From:
Source:

writeQueueMaxSize(size)

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.
Parameters:
Name Type Description
size number the size of the write queue
Inherited From:
Source: