Package io.vertx.mutiny.core.http

Class HttpClientResponse

java.lang.Object
io.vertx.mutiny.core.http.HttpClientResponse
All Implemented Interfaces:
MutinyDelegate, HttpResponseHead, ReadStream<Buffer>, StreamBase
public class HttpClientResponse extends Object implements MutinyDelegate, ReadStream<Buffer>, HttpResponseHead
Represents a client-side HTTP response.

Vert.x provides you with one of these via the handler that was provided when creating the HttpClientRequest or that was set on the HttpClientRequest instance.

It implements ReadStream so it can be used with Pipe to pipe data with flow control.

NOTE: This class has been automatically generated from the original non Mutiny-ified interface using Vert.x codegen.

  • Field Details

  • Constructor Details

    • HttpClientResponse

      public HttpClientResponse(io.vertx.core.http.HttpClientResponse delegate)

    • HttpClientResponse

      public HttpClientResponse(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.core.http.HttpClientResponse getDelegate()
      Specified by:
      getDelegate in interface HttpResponseHead
      Specified by:
      getDelegate in interface MutinyDelegate
      Specified by:
      getDelegate in interface ReadStream<Buffer>
      Specified by:
      getDelegate in interface StreamBase
      Returns:
      the delegate used by this Mutiny object of generated type

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • version

      public io.vertx.core.http.HttpVersion version()
      Specified by:
      version in interface HttpResponseHead
      Returns:
      the version of the response

    • statusCode

      public int statusCode()
      Specified by:
      statusCode in interface HttpResponseHead
      Returns:
      the status code of the response

    • statusMessage

      public String statusMessage()
      Specified by:
      statusMessage in interface HttpResponseHead
      Returns:
      the status message of the response

    • headers

      public MultiMap headers()
      Specified by:
      headers in interface HttpResponseHead
      Returns:
      the headers

    • getHeader

      public String getHeader(String headerName)
      Specified by:
      getHeader in interface HttpResponseHead
      Parameters:
      headerName - the header name
      Returns:
      the header value

    • cookies

      public List<String> cookies()
      Specified by:
      cookies in interface HttpResponseHead
      Returns:
      the Set-Cookie headers (including trailers)

    • pipe

      public Pipe<Buffer> pipe()
      Specified by:
      pipe in interface ReadStream<Buffer>
      Returns:
      a pipe

    • pipeTo

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> pipeTo(WriteStream<Buffer> dst)
      Pipe this ReadStream to the WriteStream.

      Elements emitted by this stream will be written to the write stream until this stream ends or fails.

      Once this stream has ended or failed, the write stream will be ended and the handler will be called with the result.

      Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

      Specified by:
      pipeTo in interface ReadStream<Buffer>
      Parameters:
      dst - the destination write stream
      Returns:
      the uni firing the result of the operation when completed, or a failure if the operation failed.

    • pipeToAndAwait

      public Void pipeToAndAwait(WriteStream<Buffer> dst)
      Blocking variant of ReadStream.pipeTo(io.vertx.mutiny.core.streams.WriteStream).

      This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Specified by:
      pipeToAndAwait in interface ReadStream<Buffer>
      Parameters:
      dst - the destination write stream
      Returns:
      the Void instance produced by the operation.

    • pipeToAndForget

      public void pipeToAndForget(WriteStream<Buffer> dst)
      Variant of ReadStream.pipeTo(io.vertx.mutiny.core.streams.WriteStream) that ignores the result of the operation.

      This method subscribes on the result of ReadStream.pipeTo(io.vertx.mutiny.core.streams.WriteStream), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from ReadStream.pipeTo(io.vertx.mutiny.core.streams.WriteStream) but you don't need to compose it with other operations.

      Specified by:
      pipeToAndForget in interface ReadStream<Buffer>
      Parameters:
      dst - the destination write stream

    • fetch

      public HttpClientResponse fetch(long amount)
      Specified by:
      fetch in interface ReadStream<Buffer>
      Returns:
      a reference to this, so the API can be used fluently

    • resume

      public HttpClientResponse resume()
      Specified by:
      resume in interface ReadStream<Buffer>
      Returns:
      a reference to this, so the API can be used fluently

    • exceptionHandler

      public HttpClientResponse exceptionHandler(Consumer<Throwable> handler)
      Specified by:
      exceptionHandler in interface ReadStream<Buffer>
      Specified by:
      exceptionHandler in interface StreamBase
      Parameters:
      handler - the exception handler
      Returns:

    • handler

      public HttpClientResponse handler(Consumer<Buffer> handler)
      Specified by:
      handler in interface ReadStream<Buffer>
      Returns:

    • pause

      public HttpClientResponse pause()
      Specified by:
      pause in interface ReadStream<Buffer>
      Returns:
      a reference to this, so the API can be used fluently

    • endHandler

      public HttpClientResponse endHandler(Runnable endHandler)
      Specified by:
      endHandler in interface ReadStream<Buffer>
      Returns:

    • netSocket

      public NetSocket netSocket()
      Returns:
      a NetSocket facade to interact with the HTTP client response.

    • getTrailer

      public String getTrailer(String trailerName)
      Parameters:
      trailerName - the trailer name
      Returns:
      the trailer value

    • trailers

      public MultiMap trailers()
      Returns:
      the trailers

    • bodyHandler

      public HttpClientResponse bodyHandler(Consumer<Buffer> bodyHandler)
      Parameters:
      bodyHandler - This handler will be called after all the body has been received
      Returns:

    • body

      @CheckReturnValue public io.smallrye.mutiny.Uni<Buffer> body()
      Same as body() but with an handler called when the operation completes

      Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

      Returns:
      the uni firing the result of the operation when completed, or a failure if the operation failed.

    • bodyAndAwait

      public Buffer bodyAndAwait()
      Blocking variant of body().

      This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Returns:
      the Buffer instance produced by the operation.

    • bodyAndForget

      public HttpClientResponse bodyAndForget()
      Variant of body() that ignores the result of the operation.

      This method subscribes on the result of body(), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from body() but you don't need to compose it with other operations.

      Returns:
      the instance of HttpClientResponse to chain method calls.

    • end

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> end()
      Same as end() but with an handler called when the operation completes

      Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

      Returns:
      the uni firing the result of the operation when completed, or a failure if the operation failed.

    • endAndAwait

      public Void endAndAwait()
      Blocking variant of end().

      This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Returns:
      the Void instance produced by the operation.

    • endAndForget

      public void endAndForget()
      Variant of end() that ignores the result of the operation.

      This method subscribes on the result of end(), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from end() but you don't need to compose it with other operations.

    • customFrameHandler

      public HttpClientResponse customFrameHandler(Consumer<HttpFrame> handler)
      Parameters:
      handler -
      Returns:

    • request

      public HttpClientRequest request()
      Returns:
      the corresponding request

    • streamPriorityHandler

      public HttpClientResponse streamPriorityHandler(Consumer<io.vertx.core.http.StreamPriority> handler)
      Parameters:
      handler - the handler to be called when the stream priority changes
      Returns:

    • getHeader

      public String getHeader(CharSequence headerName)
      Specified by:
      getHeader in interface HttpResponseHead
      Parameters:
      headerName - the header name
      Returns:
      the header value

    • toMulti

      @CheckReturnValue public io.smallrye.mutiny.Multi<Buffer> toMulti()
      Specified by:
      toMulti in interface ReadStream<Buffer>

    • toBlockingIterable

      public Iterable<Buffer> toBlockingIterable()

    • toBlockingStream

      public Stream<Buffer> toBlockingStream()

    • newInstance

      public static HttpClientResponse newInstance(io.vertx.core.http.HttpClientResponse arg)