Package io.vertx.core.streams

== Streams There are several objects in Vert.x that allow items to be read from and written.

See: Description

Interface Summary

Interface	Description
Pump	Pumps data from a ReadStream to a WriteStream and performs flow control where necessary to prevent the write stream buffer from getting overfull.
ReadStream<T>	Represents a stream of items that can be read from.
StreamBase	Base interface for a stream.
WriteStream<T>	Represents a stream of data that can be written to.

Package io.vertx.core.streams Description

== Streams There are several objects in Vert.x that allow items to be read from and written. In previous versions the io.vertx.core.streams package was manipulating Buffer objects exclusively. From now, streams are not coupled to buffers anymore and they work with any kind of objects. In Vert.x, write calls return immediately, and writes are queued internally. It's not hard to see that if you write to an object faster than it can actually write the data to its underlying resource, then the write queue can grow unbounded - eventually resulting in memory exhaustion. To solve this problem a simple flow control (_back-pressure_) capability is provided by some objects in the Vert.x API. Any flow control aware object that can be _written-to_ implements WriteStream, while any flow control object that can be _read-from_ is said to implement ReadStream. Let's take an example where we want to read from a `ReadStream` then write the data to a `WriteStream`. A very simple example would be reading from a NetSocket then writing back to the same `NetSocket` - since `NetSocket` implements both `ReadStream` and `WriteStream`. Note that this works between any `ReadStream` and `WriteStream` compliant object, including HTTP requests, HTTP responses, async files I/O, WebSockets, etc. A naive way to do this would be to directly take the data that has been read and immediately write it to the `NetSocket`: [source,$lang] ---- examples.StreamsExamples#pump1(io.vertx.core.Vertx) ---- There is a problem with the example above: if data is read from the socket faster than it can be written back to the socket, it will build up in the write queue of the `NetSocket`, eventually running out of RAM. This might happen, for example if the client at the other end of the socket wasn't reading fast enough, effectively putting back-pressure on the connection. Since `NetSocket` implements `WriteStream`, we can check if the `WriteStream` is full before writing to it: [source,$lang] ---- examples.StreamsExamples#pump2(io.vertx.core.Vertx) ---- This example won't run out of RAM but we'll end up losing data if the write queue gets full. What we really want to do is pause the `NetSocket` when the write queue is full: [source,$lang] ---- examples.StreamsExamples#pump3(io.vertx.core.Vertx) ---- We're almost there, but not quite. The `NetSocket` now gets paused when the file is full, but we also need to unpause it when the write queue has processed its backlog: [source,$lang] ---- examples.StreamsExamples#pump4(io.vertx.core.Vertx) ---- And there we have it. The drainHandler(io.vertx.core.Handler<java.lang.Void>) event handler will get called when the write queue is ready to accept more data, this resumes the `NetSocket` that allows more data to be read. Wanting to do this is quite common while writing Vert.x applications, so we provide a helper class called Pump that does all of this hard work for you. You just feed it the `ReadStream` plus the `WriteStream` then start it: [source,$lang] ---- examples.StreamsExamples#pump5(io.vertx.core.Vertx) ---- This does exactly the same thing as the more verbose example. Let's now look at the methods on `ReadStream` and `WriteStream` in more detail: === ReadStream `ReadStream` is implemented by HttpClientResponse, DatagramSocket, HttpClientRequest, HttpServerFileUpload, HttpServerRequest, HttpServerRequestStream, MessageConsumer, NetSocket, NetSocketStream, WebSocket, WebSocketStream, TimeoutStream, AsyncFile. Functions: - ReadStream.handler(io.vertx.core.Handler<T>): set a handler which will receive items from the ReadStream. - ReadStream.pause(): pause the handler. When paused no items will be received in the handler. - ReadStream.resume(): resume the handler. The handler will be called if any item arrives. - ReadStream.exceptionHandler(io.vertx.core.Handler<java.lang.Throwable>): Will be called if an exception occurs on the ReadStream. - ReadStream.endHandler(io.vertx.core.Handler<java.lang.Void>): Will be called when end of stream is reached. This might be when EOF is reached if the ReadStream represents a file, or when end of request is reached if it's an HTTP request, or when the connection is closed if it's a TCP socket. === WriteStream `WriteStream` is implemented by HttpClientRequest, HttpServerResponse WebSocket, NetSocket, AsyncFile, PacketWritestream and MessageProducer Functions: - write(T): write an object to the WriteStream. This method will never block. Writes are queued internally and asynchronously written to the underlying resource. - setWriteQueueMaxSize(int): set the number of object at which the write queue is considered _full_, and the method writeQueueFull() returns `true`. Note that, when the write queue is considered full, if write is called the data will still be accepted and queued. The actual number depends on the stream implementation, for Buffer the size represents the actual number of bytes written and not the number of buffers. - writeQueueFull(): returns `true` if the write queue is considered full. - exceptionHandler(io.vertx.core.Handler<java.lang.Throwable>): Will be called if an exception occurs on the `WriteStream`. - drainHandler(io.vertx.core.Handler<java.lang.Void>): The handler will be called if the `WriteStream` is considered no longer full. === Pump Instances of Pump have the following methods: - Pump.start(): Start the pump. - Pump.stop(): Stops the pump. When the pump starts it is in stopped mode. - Pump.setWriteQueueMaxSize(int): This has the same meaning as setWriteQueueMaxSize(int) on the `WriteStream`. A pump can be started and stopped multiple times. When a pump is first created it is _not_ started. You need to call the `start()` method to start it.