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 |
Methods | |
drainHandler | shared 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 tomaxSize / 2 .
Parameters:
|
end | shared void end() Ends the stream. Once the stream has ended, it cannot be used any more. |
end | shared void end(T t) Same as end but writes some data to the stream before ending. |
exceptionHandler | shared WriteStream<T> exceptionHandler(Anything(Throwable)? handler) Set an exception handler on the write stream. Parameters:
|
setWriteQueueMaxSize | shared WriteStream<T> setWriteQueueMaxSize(Integer maxSize) Set the maximum size of the write queue to Parameters:
|
write | shared 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. Parameters:
|
writeQueueFull | shared Boolean writeQueueFull() This will return |
Inherited Methods |
Methods inherited from: Object equals |
Methods inherited from: StreamBase |