## Uses of Interface
io.vertx.core.streams.ReadStream

- Packages that use ReadStream
  Package | Description
  --- | ---
  io.vertx.cassandra |
  io.vertx.config |
  io.vertx.core |
  io.vertx.core.datagram |
  io.vertx.core.eventbus |
  io.vertx.core.file |
  io.vertx.core.http |
  io.vertx.core.net |
  io.vertx.core.parsetools |
  io.vertx.core.spi |
  io.vertx.core.streams |
  io.vertx.ext.cluster.infinispan |
  io.vertx.ext.mongo |
  io.vertx.ext.reactivestreams |
  io.vertx.ext.sql |
  io.vertx.ext.unit.report |
  io.vertx.ext.web.client |
  io.vertx.ext.web.handler.sockjs |
  io.vertx.grpc |
  io.vertx.kafka.client.consumer |
  io.vertx.rabbitmq |
  io.vertx.reactivex.core.streams |
  io.vertx.rxjava.core.streams |

- - ### Uses of ReadStream in io.vertx.cassandra

    Subinterfaces of ReadStream in io.vertx.cassandra
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `CassandraRowStream` A `ReadStream` for `Row` consumption.

  - ### Uses of ReadStream in io.vertx.config

    Methods in io.vertx.config that return ReadStream
    Modifier and Type | Method and Description
    --- | ---
    `ReadStream<JsonObject>` | ConfigRetriever.`configStream()`

  - ### Uses of ReadStream in io.vertx.core

    Subinterfaces of ReadStream in io.vertx.core
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `TimeoutStream` A timeout stream is triggered by a timer, the `Handler` will be call when the timer is fired, it can be once or several times depending on the nature of the timer related to this stream.

  - ### Uses of ReadStream in io.vertx.core.datagram

    Subinterfaces of ReadStream in io.vertx.core.datagram
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `DatagramSocket` A datagram socket can be used to send `DatagramPacket`'s to remote datagram servers and receive `DatagramPacket`s .

  - ### Uses of ReadStream in io.vertx.core.eventbus

    Subinterfaces of ReadStream in io.vertx.core.eventbus
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `MessageConsumer<T>` An event bus consumer object representing a stream of message to an `EventBus` address that can be read from.

    Methods in io.vertx.core.eventbus that return ReadStream
    Modifier and Type | Method and Description
    --- | ---
    `ReadStream<T>` | MessageConsumer.`bodyStream()`

  - ### Uses of ReadStream in io.vertx.core.file

    Subinterfaces of ReadStream in io.vertx.core.file
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `AsyncFile` Represents a file on the file-system which can be read from, or written to asynchronously.

  - ### Uses of ReadStream in io.vertx.core.http

    Subinterfaces of ReadStream in io.vertx.core.http
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `HttpClientRequest` Represents a client-side HTTP request.
    `interface` | `HttpClientResponse` Represents a client-side HTTP response.
    `interface` | `HttpServerFileUpload` Represents an file upload from an HTML FORM.
    `interface` | `HttpServerRequest` Represents a server-side HTTP request.
    `interface` | `ServerWebSocket` Represents a server side WebSocket.
    `interface` | `WebSocket` Represents a client-side WebSocket.
    `interface` | `WebSocketBase` Base WebSocket implementation.

    Methods in io.vertx.core.http that return ReadStream
    Modifier and Type | Method and Description
    --- | ---
    `ReadStream<HttpServerRequest>` | HttpServer.`requestStream()` Return the request stream for the server.
    `ReadStream<ServerWebSocket>` | HttpServer.`websocketStream()` Return the websocket stream for the server.
    `ReadStream<WebSocket>` | HttpClient.`websocketStream(int port, String host, String requestURI)` Create a WebSocket stream to the specified port, host and relative request URI
    `ReadStream<WebSocket>` | HttpClient.`websocketStream(int port, String host, String requestURI, MultiMap headers)` Create a WebSocket stream to the specified port, host and relative request URI, and with the specified headers
    `ReadStream<WebSocket>` | HttpClient.`websocketStream(int port, String host, String requestURI, MultiMap headers, WebsocketVersion version)` Create a WebSocket stream to the specified port, host and relative request URI, with the specified headers and using the specified version of WebSockets
    `ReadStream<WebSocket>` | HttpClient.`websocketStream(int port, String host, String requestURI, MultiMap headers, WebsocketVersion version, String subProtocols)` Create a WebSocket stream to the specified port, host and relative request URI, with the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols
    `ReadStream<WebSocket>` | HttpClient.`websocketStream(RequestOptions options)` Create a WebSocket stream with the specified options
    `ReadStream<WebSocket>` | HttpClient.`websocketStream(RequestOptions options, MultiMap headers)` Create a WebSocket stream with the specified options, and with the specified headers
    `ReadStream<WebSocket>` | HttpClient.`websocketStream(RequestOptions options, MultiMap headers, WebsocketVersion version)` Create a WebSocket stream with the specified options, with the specified headers and using the specified version of WebSockets
    `ReadStream<WebSocket>` | HttpClient.`websocketStream(RequestOptions options, MultiMap headers, WebsocketVersion version, String subProtocols)` Create a WebSocket stream to the specified port, host and relative request URI, with the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols
    `ReadStream<WebSocket>` | HttpClient.`websocketStream(String requestURI)` Create a WebSocket stream at the relative request URI using the default host and port and the specified headers
    `ReadStream<WebSocket>` | HttpClient.`websocketStream(String requestURI, MultiMap headers)` Create a WebSocket stream at the relative request URI using the default host and port and the specified headers
    `ReadStream<WebSocket>` | HttpClient.`websocketStream(String requestURI, MultiMap headers, WebsocketVersion version)` Create a WebSocket stream at the relative request URI using the default host and port, the specified headers and the specified version of WebSockets
    `ReadStream<WebSocket>` | HttpClient.`websocketStream(String requestURI, MultiMap headers, WebsocketVersion version, String subProtocols)` Create a WebSocket stream at the relative request URI using the default host and port, the specified headers, the specified version of WebSockets and the specified sub protocols
    `ReadStream<WebSocket>` | HttpClient.`websocketStream(String host, String requestURI)` Create a WebSocket stream to the specified host, relative request URI and default port
    `ReadStream<WebSocket>` | HttpClient.`websocketStream(String host, String requestURI, MultiMap headers)` Create a WebSocket stream to the specified host, relative request URI and default port and with the specified headers
    `ReadStream<WebSocket>` | HttpClient.`websocketStream(String host, String requestURI, MultiMap headers, WebsocketVersion version)` Create a WebSocket stream with the specified options and with the specified headers and using the specified version of WebSockets
    `ReadStream<WebSocket>` | HttpClient.`websocketStream(String host, String requestURI, MultiMap headers, WebsocketVersion version, String subProtocols)` Create a WebSocket stream to the specified host, relative request URI and default port, with the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols
    `ReadStream<WebSocket>` | HttpClient.`websocketStreamAbs(String url, MultiMap headers, WebsocketVersion version, String subProtocols)` Create a WebSocket stream with the specified absolute url, the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols.

  - ### Uses of ReadStream in io.vertx.core.net

    Subinterfaces of ReadStream in io.vertx.core.net
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `NetSocket` Represents a socket-like interface to a TCP connection on either the client or the server side.

    Methods in io.vertx.core.net that return ReadStream
    Modifier and Type | Method and Description
    --- | ---
    `ReadStream<NetSocket>` | NetServer.`connectStream()` Return the connect stream for this server.

  - ### Uses of ReadStream in io.vertx.core.parsetools

    Subinterfaces of ReadStream in io.vertx.core.parsetools
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `JsonParser` A parser class which allows to incrementally parse json elements and emit json parse events instead of parsing a json element fully.
    `interface` | `RecordParser` A helper class which allows you to easily parse protocols which are delimited by a sequence of bytes, or fixed size records.

    Methods in io.vertx.core.parsetools with parameters of type ReadStream
    Modifier and Type | Method and Description
    --- | ---
    `static RecordParser` | RecordParser.`newDelimited(Buffer delim, ReadStream<Buffer> stream)` Like `RecordParser.newDelimited(Buffer)` but wraps the `stream`.
    `static RecordParser` | RecordParser.`newDelimited(String delim, ReadStream<Buffer> stream)` Like `RecordParser.newDelimited(String)` but wraps the `stream`.
    `static RecordParser` | RecordParser.`newFixed(int size, ReadStream<Buffer> stream)` Like `RecordParser.newFixed(int)` but wraps the `stream`.
    `static JsonParser` | JsonParser.`newParser(ReadStream<Buffer> stream)` Create a new `JsonParser` instance.

  - ### Uses of ReadStream in io.vertx.core.spi

    Methods in io.vertx.core.spi with parameters of type ReadStream
    Modifier and Type | Method and Description
    --- | ---
    `<T> Pump` | PumpFactory.`pump(ReadStream<T> rs, WriteStream<T> ws)`
    `<T> Pump` | PumpFactory.`pump(ReadStream<T> rs, WriteStream<T> ws, int writeQueueMaxSize)`

  - ### Uses of ReadStream in io.vertx.core.streams

    Methods in io.vertx.core.streams that return ReadStream
    Modifier and Type | Method and Description
    --- | ---
    `ReadStream<T>` | ReadStream.`endHandler(Handler<Void> endHandler)` Set an end handler.
    `ReadStream<T>` | ReadStream.`exceptionHandler(Handler<Throwable> handler)` Set an exception handler on the read stream.
    `ReadStream<T>` | ReadStream.`fetch(long amount)` Fetch the specified `amount` of elements.
    `ReadStream<T>` | ReadStream.`handler(Handler<T> handler)` Set a data handler.
    `ReadStream<T>` | ReadStream.`pause()` Pause the `ReadStream`, it sets the buffer in `fetch` mode and clears the actual demand.
    `ReadStream<T>` | ReadStream.`resume()` Resume reading, and sets the buffer in `flowing` mode.

    Methods in io.vertx.core.streams with parameters of type ReadStream
    Modifier and Type | Method and Description
    --- | ---
    `static <T> Pump` | Pump.`pump(ReadStream<T> rs, WriteStream<T> ws)` Create a new `Pump` with the given `ReadStream` and `WriteStream`
    `static <T> Pump` | Pump.`pump(ReadStream<T> rs, WriteStream<T> ws, int writeQueueMaxSize)` Create a new `Pump` with the given `ReadStream` and `WriteStream` and `writeQueueMaxSize`

  - ### Uses of ReadStream in io.vertx.ext.cluster.infinispan

    Methods in io.vertx.ext.cluster.infinispan that return ReadStream
    Modifier and Type | Method and Description
    --- | ---
    `ReadStream<Map.Entry<K,V>>` | InfinispanAsyncMap.`entryStream()` Get the entries of the map as a `ReadStream`.
    `ReadStream<K>` | InfinispanAsyncMap.`keyStream()` Get the keys of the map as a `ReadStream`.
    `ReadStream<V>` | InfinispanAsyncMap.`valueStream()` Get the values of the map as a `ReadStream`.

  - ### Uses of ReadStream in io.vertx.ext.mongo

    Methods in io.vertx.ext.mongo that return ReadStream
    Modifier and Type | Method and Description
    --- | ---
    `ReadStream<JsonObject>` | MongoClient.`aggregate(String collection, JsonArray pipeline)` Run aggregate MongoDB command with default `AggregateOptions`.
    `ReadStream<JsonObject>` | MongoClient.`aggregateWithOptions(String collection, JsonArray pipeline, AggregateOptions options)` Run aggregate MongoDB command.
    `ReadStream<JsonObject>` | MongoClient.`distinctBatch(String collection, String fieldName, String resultClassname)` Gets the distinct values of the specified field name.
    `ReadStream<JsonObject>` | MongoClient.`distinctBatchWithQuery(String collection, String fieldName, String resultClassname, JsonObject query)` Gets the distinct values of the specified field name filtered by specified query.
    `ReadStream<JsonObject>` | MongoClient.`distinctBatchWithQuery(String collection, String fieldName, String resultClassname, JsonObject query, int batchSize)` Gets the distinct values of the specified field name filtered by specified query.
    `ReadStream<JsonObject>` | MongoClient.`findBatch(String collection, JsonObject query)` Find matching documents in the specified collection.
    `ReadStream<JsonObject>` | MongoClient.`findBatchWithOptions(String collection, JsonObject query, FindOptions options)` Find matching documents in the specified collection, specifying options.

  - ### Uses of ReadStream in io.vertx.ext.reactivestreams

    Subinterfaces of ReadStream in io.vertx.ext.reactivestreams
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `ReactiveReadStream<T>` A Vert.x read stream that also implements reactive streams subscriber interface.

  - ### Uses of ReadStream in io.vertx.ext.sql

    Subinterfaces of ReadStream in io.vertx.ext.sql
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `SQLRowStream` A ReadStream of Rows from the underlying RDBMS.

  - ### Uses of ReadStream in io.vertx.ext.unit.report

    Subinterfaces of ReadStream in io.vertx.ext.unit.report
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `TestSuiteReport` The test suite reports is basically a stream of events reporting the test suite execution.

  - ### Uses of ReadStream in io.vertx.ext.web.client

    Methods in io.vertx.ext.web.client with parameters of type ReadStream
    Modifier and Type | Method and Description
    --- | ---
    `void` | HttpRequest.`sendStream(ReadStream<Buffer> body, Handler<AsyncResult<HttpResponse<T>>> handler)` Like `HttpRequest.send(Handler)` but with an HTTP request `body` stream.

  - ### Uses of ReadStream in io.vertx.ext.web.handler.sockjs

    Subinterfaces of ReadStream in io.vertx.ext.web.handler.sockjs
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `SockJSSocket` You interact with SockJS clients through instances of SockJS socket.

  - ### Uses of ReadStream in io.vertx.grpc

    Subinterfaces of ReadStream in io.vertx.grpc
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `GrpcBidiExchange<I,O>`
    `interface` | `GrpcReadStream<T>`

  - ### Uses of ReadStream in io.vertx.kafka.client.consumer

    Subinterfaces of ReadStream in io.vertx.kafka.client.consumer
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `KafkaConsumer<K,V>` Vert.x Kafka consumer.
    `interface` | `KafkaReadStream<K,V>` A `ReadStream` for consuming Kafka `ConsumerRecord`.

  - ### Uses of ReadStream in io.vertx.rabbitmq

    Subinterfaces of ReadStream in io.vertx.rabbitmq
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `RabbitMQConsumer` A stream of messages from a rabbitmq queue.

  - ### Uses of ReadStream in io.vertx.reactivex.core.streams

    Methods in io.vertx.reactivex.core.streams that return ReadStream
    Modifier and Type | Method and Description
    --- | ---
    `ReadStream` | ReadStream.`getDelegate()`

    Methods in io.vertx.reactivex.core.streams with parameters of type ReadStream
    Modifier and Type | Method and Description
    --- | ---
    `static <T> ReadStream<T>` | ReadStream.`newInstance(ReadStream arg)`
    `static <T> ReadStream<T>` | ReadStream.`newInstance(ReadStream arg, io.vertx.lang.rx.TypeArg<T> __typeArg_T)`

  - ### Uses of ReadStream in io.vertx.rxjava.core.streams

    Methods in io.vertx.rxjava.core.streams that return ReadStream
    Modifier and Type | Method and Description
    --- | ---
    `ReadStream` | ReadStream.`getDelegate()`

    Methods in io.vertx.rxjava.core.streams with parameters of type ReadStream
    Modifier and Type | Method and Description
    --- | ---
    `static <T> ReadStream<T>` | ReadStream.`newInstance(ReadStream arg)`
    `static <T> ReadStream<T>` | ReadStream.`newInstance(ReadStream arg, io.vertx.lang.rx.TypeArg<T> __typeArg_T)`

Copyright © 2018 Eclipse. All rights reserved.