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.

no type hierarchy

Inherited Attributes
Attributes inherited from: Object
hash, string
drainHandlershared WriteStream<T> drainHandler(Anything()? handler)

Set 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. See Pump 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 handler

endshared void end()

Ends the stream.

Once the stream has ended, it cannot be used any more.

endshared void end(T t)

Same as end but writes some data to the stream before ending.

exceptionHandlershared WriteStream<T> exceptionHandler(Anything(Throwable)? handler)

Set an exception handler on the write stream.

  • handler

    the exception handler

setWriteQueueMaxSizeshared WriteStream<T> 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 items in the write queue. This is used as an indicator by classes such as Pump to provide flow control.

The value is defined by the implementation of the stream, e.g in bytes for a NetSocket, the number of Message for a MessageProducer, etc…

  • maxSize

    the max size of the write stream

writeshared WriteStream<T> write(T 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.

  • data

    the data to write

writeQueueFullshared Boolean 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
Methods inherited from: StreamBase