Represents a stream of data that can be written to.

Any class that implements this interface can be used by a Pump to pump data from a ReadStream to it.

By: Julien Viet

no subtypes hierarchy

Initializer
WriteStream(WriteStream<out Object> delegate)
Attributes
delegateshared WriteStream<out Object> delegate
Inherited Attributes
Attributes inherited from: Object
hash, string
Methods
drainHandlershared void drainHandler(void onDrain())

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.

exceptionHandlershared void exceptionHandler(void onException(Throwable t))

Set an exception handler.

setWriteQueueMaxSizeshared void setWriteQueueMaxSize(Integer maxSize)

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.

writeshared void write(Buffer 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 writeQueueFull() method before writing. This is done automatically if using a Pump.

writeQueueFullshared void writeQueueFull()

This will return true if there are more bytes in the write queue than the value set using setWriteQueueMaxSize()

Inherited Methods
Methods inherited from: Object
equals