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

- Packages that use ReadStream
  Package | Description
  --- | ---
  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.spi |
  io.vertx.core.streams |
  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.rx.java |
  io.vertx.rxjava.core.streams |

- - ### 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

  - ### 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.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.`handler(Handler<T> handler)` Set a data handler.
    `ReadStream<T>` | ReadStream.`pause()` Pause the `ReadSupport`.
    `ReadStream<T>` | ReadStream.`resume()` Resume reading.

    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.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.rx.java

    Classes in io.vertx.rx.java that implement ReadStream
    Modifier and Type | Class and Description
    --- | ---
    `class` | `ReadStreamSubscriber<R,J>` An RxJava `Subscriber` that turns an `Observable` into a `ReadStream`.

    Methods in io.vertx.rx.java that return ReadStream
    Modifier and Type | Method and Description
    --- | ---
    `static <R,J> ReadStream<J>` | ReadStreamSubscriber.`asReadStream(rx.Observable<R> observable, java.util.function.Function<R,J> adapter)`
    `ReadStream<J>` | ReadStreamSubscriber.`endHandler(Handler<Void> handler)`
    `ReadStream<J>` | ReadStreamSubscriber.`exceptionHandler(Handler<Throwable> handler)`
    `ReadStream<J>` | ReadStreamSubscriber.`handler(Handler<J> handler)`
    `ReadStream<J>` | ReadStreamSubscriber.`pause()`
    `ReadStream<J>` | ReadStreamSubscriber.`resume()`
    `static <T> ReadStream<T>` | RxHelper.`toReadStream(rx.Observable<T> observable)` Adapts an RxJava `Observable` to a Vert.x `io.vertx.core.streams.ReadStream`.

    Methods in io.vertx.rx.java with parameters of type ReadStream
    Modifier and Type | Method and Description
    --- | ---
    `static <T> rx.Observable<T>` | RxHelper.`toObservable(ReadStream<T> stream)` Adapts a Vert.x `io.vertx.core.streams.ReadStream` to an RxJava `Observable`.
    `static <T,R> rx.Observable<R>` | RxHelper.`toObservable(ReadStream<T> stream, java.util.function.Function<T,R> adapter)` Like `RxHelper.toObservable(ReadStream)` but with a function that adapts the items.
    `static <T,R> rx.Observable<R>` | RxHelper.`toObservable(ReadStream<T> stream, java.util.function.Function<T,R> adapter, int maxBufferSize)` Like `RxHelper.toObservable(ReadStream, int)` but with a function that adapts the items.
    `static <T> rx.Observable<T>` | RxHelper.`toObservable(ReadStream<T> stream, int maxBufferSize)` Adapts a Vert.x `io.vertx.core.streams.ReadStream` to an RxJava `Observable`.

    Constructors in io.vertx.rx.java with parameters of type ReadStream
    Constructor and Description
    `ObservableReadStream(ReadStream<T> stream, java.util.function.Function<T,R> adapter)`
    `ObservableReadStream(ReadStream<T> stream, java.util.function.Function<T,R> adapter, long maxBufferSize)`

  - ### 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` | ReadStream.`newInstance(ReadStream arg)`
    `static <T> ReadStream` | ReadStream.`newInstance(ReadStream arg, TypeArg<T> __typeArg_T)`

Copyright © 2017. All rights reserved.