Classes, interfaces and traits

GoAway

A frame.

« More »

Http2Settings

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

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

« More »

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 @see \io\vertx\jphp\core\http\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 @see \io\vertx\jphp\core\http\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.

« More »

HttpClientOptions

Options describing how an @see \io\vertx\jphp\core\http\HttpClient will make connections.

« More »

HttpClientRequest

Represents a client-side HTTP request.

Instances are created by an @see \io\vertx\jphp\core\http\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 @see \io\vertx\jphp\core\http\HttpClientRequest::end methods should be called.

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

The @see \io\vertx\jphp\core\http\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 @see \io\vertx\jphp\core\http\HttpClientRequest::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 @see \io\vertx\jphp\core\streams\WriteStream so it can be used with

« More »

HttpClientResponse

Represents a client-side HTTP response.

Vert.x provides you with one of these via the handler that was provided when creating the @see \io\vertx\jphp\core\http\HttpClientRequest or that was set on the @see \io\vertx\jphp\core\http\HttpClientRequest instance.

It implements @see \io\vertx\jphp\core\streams\ReadStream so it can be used with

« More »

HttpConnection

Represents an HTTP connection.

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

  • @see \io\vertx\jphp\core\http\HttpConnection::close
  • @see \io\vertx\jphp\core\http\HttpConnection::closeHandler
  • @see \io\vertx\jphp\core\http\HttpConnection::exceptionHandler
« More »

HttpFrame

An HTTP/2 frame.

« More »

HttpServer

An HTTP and WebSockets server.

You receive HTTP requests by providing a @see \io\vertx\jphp\core\http\HttpServer::requestHandler. As requests arrive on the server the handler will be called with the requests.

You receive WebSockets by providing a @see \io\vertx\jphp\core\http\HttpServer::websocketHandler. As WebSocket connections arrive on the server, the WebSocket is passed to the handler.

« More »

HttpServerFileUpload

Represents an file upload from an HTML FORM.

« More »

HttpServerOptions

Represents options used by an @see \io\vertx\jphp\core\http\HttpServer instance

« More »

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 @see \io\vertx\jphp\core\http\HttpServerResponse instance via

« More »

HttpServerResponse

Represents a server-side HTTP response.

An instance of this is created and associated to every instance of

« More »

RequestOptions

Options describing how an @see \io\vertx\jphp\core\http\HttpClient will make connect to make a request.

« More »

ServerWebSocket

Represents a server side WebSocket.

Instances of this class are passed into a @see \io\vertx\jphp\core\http\HttpServer::websocketHandler or provided when a WebSocket handshake is manually @see \io\vertx\jphp\core\http\HttpServerRequest::upgradeed.

« More »

StreamPriority

This class represents HTTP/2 stream priority defined in RFC 7540 clause 5.3

« More »

WebSocket

Represents a client-side WebSocket.

« More »

WebSocketBase

Base WebSocket implementation.

It implements both and so it can be used with

« More »

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.

« More »