Class: WebClient

vertx-web-client-js/web_client~ WebClient

new WebClient()

Source:

Methods

close()

Close the client. Closing will close down any pooled connections. Clients should always be closed after use.
Source:

delete(port, host, requestURI) → {HttpRequest}

Create an HTTP DELETE request to send to the server at the specified host and port.
Parameters:
Name Type Description
port number the port
host string the host
requestURI string the relative URI
Source:
Returns:
an HTTP client request object
Type
HttpRequest

deleteAbs(absoluteURI) → {HttpRequest}

Create an HTTP DELETE request to send to the server using an absolute URI, specifying a response handler to receive the response
Parameters:
Name Type Description
absoluteURI string the absolute URI
Source:
Returns:
an HTTP client request object
Type
HttpRequest

get(port, host, requestURI) → {HttpRequest}

Create an HTTP GET request to send to the server at the specified host and port.
Parameters:
Name Type Description
port number the port
host string the host
requestURI string the relative URI
Source:
Returns:
an HTTP client request object
Type
HttpRequest

getAbs(absoluteURI) → {HttpRequest}

Create an HTTP GET request to send to the server using an absolute URI, specifying a response handler to receive the response
Parameters:
Name Type Description
absoluteURI string the absolute URI
Source:
Returns:
an HTTP client request object
Type
HttpRequest
Create an HTTP HEAD request to send to the server at the specified host and port.
Parameters:
Name Type Description
port number the port
host string the host
requestURI string the relative URI
Source:
Returns:
an HTTP client request object
Type
HttpRequest

headAbs(absoluteURI) → {HttpRequest}

Create an HTTP HEAD request to send to the server using an absolute URI, specifying a response handler to receive the response
Parameters:
Name Type Description
absoluteURI string the absolute URI
Source:
Returns:
an HTTP client request object
Type
HttpRequest

patch(port, host, requestURI) → {HttpRequest}

Create an HTTP PATCH request to send to the server at the specified host and port.
Parameters:
Name Type Description
port number the port
host string the host
requestURI string the relative URI
Source:
Returns:
an HTTP client request object
Type
HttpRequest

patchAbs(absoluteURI) → {HttpRequest}

Create an HTTP PATCH request to send to the server using an absolute URI, specifying a response handler to receive the response
Parameters:
Name Type Description
absoluteURI string the absolute URI
Source:
Returns:
an HTTP client request object
Type
HttpRequest

post(port, host, requestURI) → {HttpRequest}

Create an HTTP POST request to send to the server at the specified host and port.
Parameters:
Name Type Description
port number the port
host string the host
requestURI string the relative URI
Source:
Returns:
an HTTP client request object
Type
HttpRequest

postAbs(absoluteURI) → {HttpRequest}

Create an HTTP POST request to send to the server using an absolute URI, specifying a response handler to receive the response
Parameters:
Name Type Description
absoluteURI string the absolute URI
Source:
Returns:
an HTTP client request object
Type
HttpRequest

put(port, host, requestURI) → {HttpRequest}

Create an HTTP PUT request to send to the server at the specified host and port.
Parameters:
Name Type Description
port number the port
host string the host
requestURI string the relative URI
Source:
Returns:
an HTTP client request object
Type
HttpRequest

putAbs(absoluteURI) → {HttpRequest}

Create an HTTP PUT request to send to the server using an absolute URI, specifying a response handler to receive the response
Parameters:
Name Type Description
absoluteURI string the absolute URI
Source:
Returns:
an HTTP client request object
Type
HttpRequest

request(method, port, host, requestURI) → {HttpRequest}

Create an HTTP request to send to the server at the specified host and port.
Parameters:
Name Type Description
method Object the HTTP method
port number the port
host string the host
requestURI string the relative URI
Source:
Returns:
an HTTP client request object
Type
HttpRequest

requestAbs(method, absoluteURI) → {HttpRequest}

Create an HTTP request to send to the server using an absolute URI
Parameters:
Name Type Description
method Object the HTTP method
absoluteURI string the absolute URI
Source:
Returns:
an HTTP client request object
Type
HttpRequest