org.vertx.java.core.streams

Interface WriteStream<T>

All Superinterfaces:

ExceptionSupport<T>

All Known Subinterfaces:

AsyncFile, HttpClientRequest, HttpServerResponse, NetSocket, ServerWebSocket, SockJSSocket, WebSocket, WebSocketBase<T>

All Known Implementing Classes:

DefaultAsyncFile, DefaultHttpClientRequest, DefaultHttpServerResponse, DefaultNetSocket, DefaultServerWebSocket, DefaultWebSocket, SockJSSocketBase

public interface WriteStream<T>
extends ExceptionSupport<T>

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.

This interface exposes a fluent api and the type T represents the type of the object that implements the interface to allow method chaining

Method Summary

Methods

Modifier and Type	Method and Description
T	drainHandler(Handler<java.lang.Void> handler) Set a drain handler on the stream.
T	setWriteQueueMaxSize(int maxSize) Set the maximum size of the write queue to maxSize.
T	write(Buffer 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 setWriteQueueMaxSize(int)

Methods inherited from interface org.vertx.java.core.streams.ExceptionSupport

exceptionHandler

Method Detail

write

T 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.

setWriteQueueMaxSize

T setWriteQueueMaxSize(int 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.

writeQueueFull

boolean writeQueueFull()

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

drainHandler

T drainHandler(Handler<java.lang.Void> 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 Pump for an example of this being used.