Values
clientAuthshared clientAuth clientAuth
connectshared connect connect
deleteshared delete delete
getshared get get
goAwayshared goAway goAway
shared head head
http2Settingsshared http2Settings http2Settings
httpClientOptionsshared httpClientOptions httpClientOptions
httpMethodshared httpMethod httpMethod
httpServerOptionsshared httpServerOptions httpServerOptions
httpVersionshared httpVersion httpVersion
http_1_0shared http_1_0 http_1_0
http_1_1shared http_1_1 http_1_1
http_2shared http_2 http_2
noneshared none none

No client authentication is requested or required.

optionsshared options options
othershared other other
patchshared patch patch
postshared post post
putshared put put
requestshared request request

Accept authentication if presented by client. If this option is set and the client chooses not to provide authentication information about itself, the negotiations will continue.

requestOptionsshared requestOptions requestOptions
requiredshared required required

Require client to present authentication, if not presented then negotiations will be declined.

traceshared trace trace
v00shared v00 v00
v07shared v07 v07
v08shared v08 v08
v13shared v13 v13
webSocketFrameshared webSocketFrame webSocketFrame
websocketVersionshared websocketVersion websocketVersion
Interfaces
WebSocketBaseshared WebSocketBase

Base WebSocket implementation.

It implements both and so it can be used with Pump to pump data with flow control.

Classes
ClientAuthshared abstract ClientAuth

Configures the engine to require/request client authentication.

Created by manishk on 10/2/2015.

GoAwayshared GoAway

A frame.

Http2Settingsshared Http2Settings

HTTP2 settings, the settings is initialized with the default HTTP/2 values.

The settings expose the parameters defined by the HTTP/2 specification, as well as extra settings for protocol extensions.

HttpClientshared HttpClient

An asynchronous HTTP client.

It allows you to make requests to HTTP servers, and a single client can make requests to any server.

It also allows you to open WebSockets to servers.

The client can also pool HTTP connections.

For pooling to occur, keep-alive must be true on the HttpClientOptions (default is true). In this case connections will be pooled and re-used if there are pending HTTP requests waiting to get a connection, otherwise they will be closed.

This gives the benefits of keep alive when the client is loaded but means we don't keep connections hanging around unnecessarily when there would be no benefits anyway.

The client also supports pipe-lining of requests. Pipe-lining means another request is sent on the same connection before the response from the preceding one has returned. Pipe-lining is not appropriate for all requests.

To enable pipe-lining, it must be enabled on the HttpClientOptions (default is false).

When pipe-lining is enabled the connection will be automatically closed when all in-flight responses have returned and there are no outstanding pending requests to write.

The client is designed to be reused between requests.

HttpClientOptionsshared HttpClientOptions

Options describing how an HttpClient will make connections.

HttpClientRequestshared HttpClientRequest

Represents a client-side HTTP request.

Instances are created by an HttpClient instance, via one of the methods corresponding to the specific HTTP methods, or the generic request methods. On creation the request will not have been written to the wire.

Once a request has been obtained, headers can be set on it, and data can be written to its body if required. Once you are ready to send the request, one of the end methods should be called.

Nothing is actually sent until the request has been internally assigned an HTTP connection.

The HttpClient instance will return an instance of this class immediately, even if there are no HTTP connections available in the pool. Any requests sent before a connection is assigned will be queued internally and actually sent when an HTTP connection becomes available from the pool.

The headers of the request are queued for writing either when the end method is called, or, when the first part of the body is written, whichever occurs first.

This class supports both chunked and non-chunked HTTP.

It implements WriteStream so it can be used with Pump to pump data with flow control.

An example of using this class is as follows:

HttpClientResponseshared HttpClientResponse

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 Pump to pump data with flow control.

HttpConnectionshared HttpConnection

Represents an HTTP connection.

HTTP/1.x connection provides an limited implementation, the following methods are implemented:

  • [close](../http/HttpConnection.type.html#close)
  • [closeHandler](../http/HttpConnection.type.html#closeHandler)
  • [exceptionHandler](../http/HttpConnection.type.html#exceptionHandler)
HttpFrameshared HttpFrame

An HTTP/2 frame.

HttpMethodshared abstract HttpMethod

Represents an HTTP method

HttpServershared HttpServer

An HTTP and WebSockets server.

You receive HTTP requests by providing a requestHandler. As requests arrive on the server the handler will be called with the requests.

You receive WebSockets by providing a websocketHandler. As WebSocket connections arrive on the server, the WebSocket is passed to the handler.

HttpServerFileUploadshared HttpServerFileUpload

Represents an file upload from an HTML FORM.

HttpServerOptionsshared HttpServerOptions

Represents options used by an HttpServer instance

HttpServerRequestshared HttpServerRequest

Represents a server-side HTTP request.

Instances are created for each request and passed to the user via a handler.

Each instance of this class is associated with a corresponding HttpServerResponse instance via response.

It implements ReadStream so it can be used with Pump to pump data with flow control.

HttpServerResponseshared HttpServerResponse

Represents a server-side HTTP response.

An instance of this is created and associated to every instance of HttpServerRequest that.

It allows the developer to control the HTTP response that is sent back to the client for a particular HTTP request.

It contains methods that allow HTTP headers and trailers to be set, and for a body to be written out to the response.

It also allows files to be streamed by the kernel directly from disk to the outgoing HTTP connection, bypassing user space altogether (where supported by the underlying operating system). This is a very efficient way of serving files from the server since buffers do not have to be read one by one from the file and written to the outgoing socket.

It implements WriteStream so it can be used with Pump to pump data with flow control.

HttpVersionshared abstract HttpVersion

Represents the version of the HTTP protocol.

RequestOptionsshared RequestOptions

Options describing how an HttpClient will make connect to make a request.

ServerWebSocketshared ServerWebSocket

Represents a server side WebSocket.

Instances of this class are passed into a websocketHandler or provided when a WebSocket handshake is manually upgradeed.

WebSocketshared WebSocket

Represents a client-side WebSocket.

WebSocketFrameshared WebSocketFrame

A WebSocket frame that represents either text or binary data.

A WebSocket message is composed of one or more WebSocket frames.

If there is a just a single frame in the message then a single text or binary frame should be created with final = true.

If there are more than one frames in the message, then the first frame should be a text or binary frame with final = false, followed by one or more continuation frames. The last continuation frame should have final = true.

WebsocketVersionshared abstract WebsocketVersion

Represents the WebSocket version

clientAuthshared clientAuth
connectshared connect
deleteshared delete
getshared get
goAwayshared goAway
shared head
http2Settingsshared http2Settings
httpClientOptionsshared httpClientOptions
httpMethodshared httpMethod
httpServerOptionsshared httpServerOptions
httpVersionshared httpVersion
http_1_0shared http_1_0
http_1_1shared http_1_1
http_2shared http_2
noneshared none

No client authentication is requested or required.

optionsshared options
othershared other
patchshared patch
postshared post
putshared put
requestshared request

Accept authentication if presented by client. If this option is set and the client chooses not to provide authentication information about itself, the negotiations will continue.

requestOptionsshared requestOptions
requiredshared required

Require client to present authentication, if not presented then negotiations will be declined.

traceshared trace
v00shared v00
v07shared v07
v08shared v08
v13shared v13
webSocketFrameshared webSocketFrame
websocketVersionshared websocketVersion