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

- Packages that use WriteStream
  Package | Description
  --- | ---
  io.vertx.amqp |
  io.vertx.cassandra |
  io.vertx.core.datagram |
  io.vertx.core.file |
  io.vertx.core.http |
  io.vertx.core.net |
  io.vertx.core.streams |
  io.vertx.ext.mongo |
  io.vertx.ext.reactivestreams |
  io.vertx.ext.web.codec |
  io.vertx.ext.web.codec.spi |
  io.vertx.ext.web.handler.sockjs |
  io.vertx.grpc.stub |
  io.vertx.kafka.client.producer |
  io.vertx.reactivex |
  io.vertx.reactivex.core.streams |
  io.vertx.rx.java |
  io.vertx.rxjava.core.streams |
  io.vertx.rxjava3 |
  io.vertx.rxjava3.core.streams |

- - ### Uses of WriteStream in io.vertx.amqp

    Subinterfaces of WriteStream in io.vertx.amqp
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `AmqpSender` AMQP Sender interface used to send messages.

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

    Methods in io.vertx.cassandra with parameters of type WriteStream
    Modifier and Type | Method and Description
    --- | ---
    `default Future<Void>` | CassandraRowStream.`pipeTo(WriteStream<com.datastax.oss.driver.api.core.cql.Row> dst)`
    `default void` | CassandraRowStream.`pipeTo(WriteStream<com.datastax.oss.driver.api.core.cql.Row> dst, Handler<AsyncResult<Void>> handler)`

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

    Methods in io.vertx.core.datagram that return WriteStream
    Modifier and Type | Method and Description
    --- | ---
    `WriteStream<Buffer>` | DatagramSocket.`sender(int port, String host)` Returns a `WriteStream<Buffer>` able to send `Buffer` to the `SocketAddress`.

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

    Subinterfaces of WriteStream 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 WriteStream in io.vertx.core.http

    Subinterfaces of WriteStream in io.vertx.core.http
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `HttpClientRequest` Represents a client-side HTTP request.
    `interface` | `HttpServerResponse` Represents a server-side HTTP response.
    `interface` | `ServerWebSocket` Represents a server side WebSocket.
    `interface` | `WebSocket` Represents a client-side WebSocket.
    `interface` | `WebSocketBase` Base WebSocket implementation.

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

    Subinterfaces of WriteStream 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.

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

    Methods in io.vertx.core.streams that return WriteStream
    Modifier and Type | Method and Description
    --- | ---
    `WriteStream<T>` | WriteStream.`drainHandler(Handler<Void> handler)` Set a drain handler on the stream.
    `WriteStream<T>` | WriteStream.`exceptionHandler(Handler<Throwable> handler)` Set an exception handler on the write stream.
    `WriteStream<T>` | WriteStream.`setWriteQueueMaxSize(int maxSize)` Set the maximum size of the write queue to `maxSize`.

    Methods in io.vertx.core.streams with parameters of type WriteStream
    Modifier and Type | Method and Description
    --- | ---
    `default Future<Void>` | ReadStream.`pipeTo(WriteStream<T> dst)` Same as `ReadStream.pipeTo(WriteStream, Handler)` but returns a `Future` of the asynchronous result
    `default void` | ReadStream.`pipeTo(WriteStream<T> dst, Handler<AsyncResult<Void>> handler)` Pipe this `ReadStream` to the `WriteStream`.
    `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`
    `default Future<Void>` | Pipe.`to(WriteStream<T> dst)` Same as `Pipe.to(WriteStream, Handler)` but returns a `Future` of the asynchronous result
    `void` | Pipe.`to(WriteStream<T> dst, Handler<AsyncResult<Void>> completionHandler)` Start to pipe the elements to the destination `WriteStream`.

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

    Methods in io.vertx.ext.mongo with parameters of type WriteStream
    Modifier and Type | Method and Description
    --- | ---
    `Future<Long>` | MongoGridFsClient.`downloadByFileName(WriteStream<Buffer> stream, String fileName)` Like `MongoGridFsClient.downloadByFileName(WriteStream, String, Handler)` but returns a `Future` of the asynchronous result
    `MongoGridFsClient` | MongoGridFsClient.`downloadByFileName(WriteStream<Buffer> stream, String fileName, Handler<AsyncResult<Long>> resultHandler)`
    `Future<Long>` | MongoGridFsClient.`downloadByFileNameWithOptions(WriteStream<Buffer> stream, String fileName, GridFsDownloadOptions options)` Like `MongoGridFsClient.downloadByFileNameWithOptions(WriteStream, String, GridFsDownloadOptions, Handler)` but returns a `Future` of the asynchronous result
    `MongoGridFsClient` | MongoGridFsClient.`downloadByFileNameWithOptions(WriteStream<Buffer> stream, String fileName, GridFsDownloadOptions options, Handler<AsyncResult<Long>> resultHandler)`
    `Future<Long>` | MongoGridFsClient.`downloadById(WriteStream<Buffer> stream, String id)` Like `MongoGridFsClient.downloadById(WriteStream, String, Handler)` but returns a `Future` of the asynchronous result
    `MongoGridFsClient` | MongoGridFsClient.`downloadById(WriteStream<Buffer> stream, String id, Handler<AsyncResult<Long>> resultHandler)`

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

    Subinterfaces of WriteStream in io.vertx.ext.reactivestreams
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `ReactiveWriteStream<T>` A Vert.x write stream that also implements reactive streams publisher interface.

  - ### Uses of WriteStream in io.vertx.ext.web.codec

    Methods in io.vertx.ext.web.codec with parameters of type WriteStream
    Modifier and Type | Method and Description
    --- | ---
    `static BodyCodec<Void>` | BodyCodec.`pipe(WriteStream<Buffer> stream)` A body codec that pipes the body to a write stream.
    `static BodyCodec<Void>` | BodyCodec.`pipe(WriteStream<Buffer> stream, boolean close)` A body codec that pipes the body to a write stream.

  - ### Uses of WriteStream in io.vertx.ext.web.codec.spi

    Subinterfaces of WriteStream in io.vertx.ext.web.codec.spi
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `BodyStream<T>` The body stream decodes a `WriteStream` into the a `T` instance.

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

    Subinterfaces of WriteStream 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 WriteStream in io.vertx.grpc.stub

    Classes in io.vertx.grpc.stub that implement WriteStream
    Modifier and Type | Class and Description
    --- | ---
    `class` | `GrpcWriteStream<T>`

    Methods in io.vertx.grpc.stub that return WriteStream
    Modifier and Type | Method and Description
    --- | ---
    `WriteStream<T>` | GrpcWriteStream.`drainHandler(Handler<Void> hndlr)`
    `WriteStream<T>` | GrpcWriteStream.`exceptionHandler(Handler<Throwable> hndlr)`
    `WriteStream<T>` | GrpcWriteStream.`setWriteQueueMaxSize(int i)`

    Method parameters in io.vertx.grpc.stub with type arguments of type WriteStream
    Modifier and Type | Method and Description
    --- | ---
    `static <I,O> ReadStream<O>` | ClientCalls.`manyToMany(io.vertx.core.impl.ContextInternal ctx, Handler<WriteStream<I>> requestHandler, java.util.function.Function<io.grpc.stub.StreamObserver<O>,io.grpc.stub.StreamObserver<I>> delegate)`
    `static <I,O> io.grpc.stub.StreamObserver<I>` | ServerCalls.`manyToMany(io.grpc.stub.StreamObserver<O> response, String compression, java.util.function.BiConsumer<ReadStream<I>,WriteStream<O>> delegate)`
    `static <I,O> Future<O>` | ClientCalls.`manyToOne(io.vertx.core.impl.ContextInternal ctx, Handler<WriteStream<I>> requestHandler, java.util.function.Function<io.grpc.stub.StreamObserver<O>,io.grpc.stub.StreamObserver<I>> delegate)`
    `static <I,O> void` | ServerCalls.`oneToMany(I request, io.grpc.stub.StreamObserver<O> response, String compression, java.util.function.BiConsumer<I,WriteStream<O>> delegate)`

  - ### Uses of WriteStream in io.vertx.kafka.client.producer

    Subinterfaces of WriteStream in io.vertx.kafka.client.producer
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `KafkaProducer<K,V>` Vert.x Kafka producer.
    `interface` | `KafkaWriteStream<K,V>` A `WriteStream` for writing to Kafka `ProducerRecord`.

  - ### Uses of WriteStream in io.vertx.reactivex

    Methods in io.vertx.reactivex with parameters of type WriteStream
    Modifier and Type | Method and Description
    --- | ---
    `static <T> WriteStreamObserver<T>` | RxHelper.`toObserver(WriteStream<T> stream)` Adapts a Vert.x `WriteStream` to an RxJava `Observer`.
    `static <R,T> WriteStreamObserver<R>` | RxHelper.`toObserver(WriteStream<T> stream, java.util.function.Function<R,T> mapping)` Like `RxHelper.toObserver(WriteStream)`, except the provided `mapping` function is applied to each `Observable` item.
    `static <T> WriteStreamSubscriber<T>` | RxHelper.`toSubscriber(WriteStream<T> stream)` Adapts a Vert.x `WriteStream` to an RxJava `Subscriber`.
    `static <R,T> WriteStreamSubscriber<R>` | RxHelper.`toSubscriber(WriteStream<T> stream, java.util.function.Function<R,T> mapping)` Like `RxHelper.toSubscriber(WriteStream)`, except the provided `mapping` function is applied to each `Flowable` item.

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

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

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

  - ### Uses of WriteStream in io.vertx.rx.java

    Methods in io.vertx.rx.java with parameters of type WriteStream
    Modifier and Type | Method and Description
    --- | ---
    `static <T> WriteStreamSubscriber<T>` | RxHelper.`toSubscriber(WriteStream<T> stream)` Adapts a Vert.x `WriteStream` to an RxJava `Subscriber`.
    `static <R,T> WriteStreamSubscriber<R>` | RxHelper.`toSubscriber(WriteStream<T> stream, java.util.function.Function<R,T> mapping)` Like `RxHelper.toSubscriber(WriteStream)`, except the provided `mapping` function is applied to each `Observable` item.

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

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

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

  - ### Uses of WriteStream in io.vertx.rxjava3

    Methods in io.vertx.rxjava3 with parameters of type WriteStream
    Modifier and Type | Method and Description
    --- | ---
    `static <T> WriteStreamObserver<T>` | RxHelper.`toObserver(WriteStream<T> stream)` Adapts a Vert.x `WriteStream` to an RxJava `Observer`.
    `static <R,T> WriteStreamObserver<R>` | RxHelper.`toObserver(WriteStream<T> stream, java.util.function.Function<R,T> mapping)` Like `RxHelper.toObserver(WriteStream)`, except the provided `mapping` function is applied to each `Observable` item.
    `static <T> WriteStreamSubscriber<T>` | RxHelper.`toSubscriber(WriteStream<T> stream)` Adapts a Vert.x `WriteStream` to an RxJava `Subscriber`.
    `static <R,T> WriteStreamSubscriber<R>` | RxHelper.`toSubscriber(WriteStream<T> stream, java.util.function.Function<R,T> mapping)` Like `RxHelper.toSubscriber(WriteStream)`, except the provided `mapping` function is applied to each `Flowable` item.

  - ### Uses of WriteStream in io.vertx.rxjava3.core.streams

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

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

Copyright © 2022 Eclipse. All rights reserved.