Interface HttpClient

All Superinterfaces:
io.vertx.lang.rx.RxDelegate
All Known Implementing Classes:
HttpClientAgent, HttpClientConnection
public interface HttpClient extends io.vertx.lang.rx.RxDelegate
The API to interacts with an HTTP server.

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

  • Method Details

    • getDelegate

      HttpClient getDelegate()
      Specified by:
      getDelegate in interface io.vertx.lang.rx.RxDelegate

    • request

      Future<HttpClientRequest> request()
      Create an HTTP request to send to the server with the default host and port of the client.
      Returns:
      a future notified when the request is ready to be sent

    • rxRequest

      Single<HttpClientRequest> rxRequest()
      Create an HTTP request to send to the server with the default host and port of the client.
      Returns:
      a future notified when the request is ready to be sent

    • request

      Future<HttpClientRequest> request(RequestOptions options)
      Create an HTTP request to send to the server.
      Parameters:
      options - the request options
      Returns:
      a future notified when the request is ready to be sent

    • rxRequest

      Single<HttpClientRequest> rxRequest(RequestOptions options)
      Create an HTTP request to send to the server.
      Parameters:
      options - the request options
      Returns:
      a future notified when the request is ready to be sent

    • request

      Future<HttpClientRequest> request(HttpMethod method, int port, String host, String requestURI)
      Create an HTTP request to send to the server at the host and port.
      Parameters:
      method - the HTTP method
      port - the port
      host - the host
      requestURI - the relative URI
      Returns:
      a future notified when the request is ready to be sent

    • rxRequest

      Single<HttpClientRequest> rxRequest(HttpMethod method, int port, String host, String requestURI)
      Create an HTTP request to send to the server at the host and port.
      Parameters:
      method - the HTTP method
      port - the port
      host - the host
      requestURI - the relative URI
      Returns:
      a future notified when the request is ready to be sent

    • request

      Future<HttpClientRequest> request(HttpMethod method, String host, String requestURI)
      Create an HTTP request to send to the server at the host and default port.
      Parameters:
      method - the HTTP method
      host - the host
      requestURI - the relative URI
      Returns:
      a future notified when the request is ready to be sent

    • rxRequest

      Single<HttpClientRequest> rxRequest(HttpMethod method, String host, String requestURI)
      Create an HTTP request to send to the server at the host and default port.
      Parameters:
      method - the HTTP method
      host - the host
      requestURI - the relative URI
      Returns:
      a future notified when the request is ready to be sent

    • request

      Future<HttpClientRequest> request(HttpMethod method, String requestURI)
      Create an HTTP request to send to the server at the default host and port.
      Parameters:
      method - the HTTP method
      requestURI - the relative URI
      Returns:
      a future notified when the request is ready to be sent

    • rxRequest

      Single<HttpClientRequest> rxRequest(HttpMethod method, String requestURI)
      Create an HTTP request to send to the server at the default host and port.
      Parameters:
      method - the HTTP method
      requestURI - the relative URI
      Returns:
      a future notified when the request is ready to be sent

    • shutdown

      Future<Void> shutdown()
      Shutdown with a 30 seconds timeout (shutdown(30, TimeUnit.SECONDS)).
      Returns:
      a future completed when shutdown has completed

    • rxShutdown

      Completable rxShutdown()
      Shutdown with a 30 seconds timeout (shutdown(30, TimeUnit.SECONDS)).
      Returns:
      a future completed when shutdown has completed

    • close

      Future<Void> close()
      Close immediately (shutdown(0, TimeUnit.SECONDS).
      Returns:
      a future notified when the client is closed

    • rxClose

      Completable rxClose()
      Close immediately (shutdown(0, TimeUnit.SECONDS).
      Returns:
      a future notified when the client is closed

    • shutdown

      Future<Void> shutdown(long timeout, TimeUnit unit)
      Calls shutdown().
      Parameters:
      timeout -
      unit -
      Returns:

    • rxShutdown

      Completable rxShutdown(long timeout, TimeUnit unit)
      Calls shutdown().
      Parameters:
      timeout -
      unit -
      Returns:

    • newInstance

      static HttpClient newInstance(HttpClient arg)