Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv class	HttpServerImpl.HttpStreamHandler<C extends ReadStream<Buffer>>

Modifier and Type	Field and Description
private Handler<HttpConnection>	connectionHandler
private static final Handler<Throwable>	DEFAULT_EXCEPTION_HANDLER
pack-priv static final boolean	DISABLE_WEBSOCKETS
private static final String	DISABLE_WEBSOCKETS_PROP_NAME
private Handler<Throwable>	exceptionHandler
private static final String	FLASH_POLICY_HANDLER_PROP_NAME
private Handler<HttpServerRequest>	invalidRequestHandler
pack-priv static final Logger	log Hides io.vertx.core.net.impl.TCPServerBase.log.
pack-priv final HttpServerOptions	options Hides io.vertx.core.net.impl.TCPServerBase.options.
private final HttpServerImpl.HttpStreamHandler<HttpServerRequest>	requestStream
pack-priv static final boolean	USE_FLASH_POLICY_HANDLER
pack-priv final boolean	useH2UniformStreamByteDistributor
private Handler<ServerWebSocketHandshake>	webSocketHandshakeHandler
private final HttpServerImpl.HttpStreamHandler<ServerWebSocket>	wsStream

Constructor Summary

Access	Constructor and Description
public	HttpServerImpl(VertxInternal vertx, HttpServerOptions options)

Method Summary

Modifier and Type	Method and Description
protected BiConsumer<Channel, SslChannelProvider>	childHandler(ContextInternal context, SocketAddress address, GlobalTrafficShapingHandler trafficShapingHandler) Implements abstract io.vertx.core.net.impl.TCPServerBase.childHandler.
public Future<Void>	close() Implements abstract io.vertx.core.net.impl.TCPServerBase.close. Implements io.vertx.core.http.HttpServer.close. Close the server.
public void	close(Handler<AsyncResult<Void>> the handler done) Implements io.vertx.core.http.HttpServer.close. Like `close` but supplying a handler that will be called when the server is actually closed (or has failed).
public synchronized void	close(Promise<Void> the promise to signal when close has completed completion) Overrides io.vertx.core.net.impl.TCPServerBase.close. Implements io.vertx.core.Closeable.close. Close this resource, the `completion` promise must be notified when the operation has completed.
public synchronized HttpServer	connectionHandler(Handler<HttpConnection> handler) Implements io.vertx.core.http.HttpServer.connectionHandler. Set a connection handler for the server.
protected TCPMetrics<?>	createMetrics(SocketAddress localAddress) Overrides io.vertx.core.net.impl.TCPServerBase.createMetrics.
protected SSLHelper	createSSLHelper() Overrides io.vertx.core.net.impl.TCPServerBase.createSSLHelper.
public synchronized HttpServer	exceptionHandler(Handler<Throwable> the handler to set handler) Implements io.vertx.core.http.HttpServer.exceptionHandler. Set an exception handler called for socket errors happening before the HTTP connection is established, e.g during the TLS handshake.
public HttpServer	invalidRequestHandler(Handler<HttpServerRequest> handler) Implements io.vertx.core.http.HttpServer.invalidRequestHandler. Set a `handler` for handling invalid requests.
public boolean	isClosed()
public Future<HttpServer>	listen() Implements io.vertx.core.http.HttpServer.listen. Tell the server to start listening.
public synchronized Future<HttpServer>	listen(SocketAddress address) Implements io.vertx.core.http.HttpServer.listen. Like `listen(SocketAddress, Handler)` but returns a `Future` of the asynchronous result
pack-priv boolean	requestAccept()
public synchronized HttpServer	requestHandler(Handler<HttpServerRequest> handler) Implements io.vertx.core.http.HttpServer.requestHandler. Set the request handler for the server to `requestHandler`.
public Handler<HttpServerRequest>	requestHandler() Implements io.vertx.core.http.HttpServer.requestHandler.
public ReadStream<HttpServerRequest>	requestStream() Implements io.vertx.core.http.HttpServer.requestStream. Return the request stream for the server.
public HttpServer	webSocketHandler(Handler<ServerWebSocket> handler) Implements io.vertx.core.http.HttpServer.webSocketHandler. Set the WebSocket handler for the server to `wsHandler`.
public Handler<ServerWebSocket>	webSocketHandler() Implements io.vertx.core.http.HttpServer.webSocketHandler.
public HttpServer	webSocketHandshakeHandler(Handler<ServerWebSocketHandshake> handler) Implements io.vertx.core.http.HttpServer.webSocketHandshakeHandler. Set a handler for WebSocket handshake.
public ReadStream<ServerWebSocket>	webSocketStream() Implements io.vertx.core.http.HttpServer.webSocketStream. Return the WebSocket stream for the server.
pack-priv boolean	wsAccept()

Inherited from io.vertx.core.net.impl.TCPServerBase:: actualPort bind createTrafficShapingHandler getMetrics isListening isMetricsEnabled sniEntrySize sslContextProvider updateSSLOptions updateTrafficShapingOptions

Field Detail

connectionHandler	back to summary
private Handler<HttpConnection> connectionHandler

DEFAULT_EXCEPTION_HANDLER	back to summary
private static final Handler<Throwable> DEFAULT_EXCEPTION_HANDLER

DISABLE_WEBSOCKETS	back to summary
pack-priv static final boolean DISABLE_WEBSOCKETS

DISABLE_WEBSOCKETS_PROP_NAME	back to summary
private static final String DISABLE_WEBSOCKETS_PROP_NAME

exceptionHandler	back to summary
private Handler<Throwable> exceptionHandler

FLASH_POLICY_HANDLER_PROP_NAME	back to summary
private static final String FLASH_POLICY_HANDLER_PROP_NAME

invalidRequestHandler	back to summary
private Handler<HttpServerRequest> invalidRequestHandler

log	back to summary
pack-priv static final Logger log Hides io.vertx.core.net.impl.TCPServerBase.log.

options	back to summary
pack-priv final HttpServerOptions options Hides io.vertx.core.net.impl.TCPServerBase.options.

requestStream	back to summary
private final HttpServerImpl.HttpStreamHandler<HttpServerRequest> requestStream

USE_FLASH_POLICY_HANDLER	back to summary
pack-priv static final boolean USE_FLASH_POLICY_HANDLER

useH2UniformStreamByteDistributor	back to summary
pack-priv final boolean useH2UniformStreamByteDistributor

webSocketHandshakeHandler	back to summary
private Handler<ServerWebSocketHandshake> webSocketHandshakeHandler

wsStream	back to summary
private final HttpServerImpl.HttpStreamHandler<ServerWebSocket> wsStream

Constructor Detail

HttpServerImpl	back to summary
public HttpServerImpl(VertxInternal vertx, HttpServerOptions options)

Method Detail

childHandler	back to summary
protected BiConsumer<Channel, SslChannelProvider> childHandler(ContextInternal context, SocketAddress address, GlobalTrafficShapingHandler trafficShapingHandler) Implements abstract io.vertx.core.net.impl.TCPServerBase.childHandler. Annotations @Override

childHandler

back to summary

protected BiConsumer<Channel, SslChannelProvider> childHandler(ContextInternal context, SocketAddress address, GlobalTrafficShapingHandler trafficShapingHandler)

Implements abstract io.vertx.core.net.impl.TCPServerBase.childHandler.

Annotations

@Override

close	back to summary
public Future<Void> close() Implements abstract io.vertx.core.net.impl.TCPServerBase.close. Implements io.vertx.core.http.HttpServer.close. Doc from io.vertx.core.http.HttpServer.close. Close the server. Any open HTTP connections will be closed. The close happens asynchronously and the server may not be closed until some time after the call has returned. Returns:Future<Void> a future completed with the result Annotations @Override

back to summary

public Future<Void> close()

Implements abstract io.vertx.core.net.impl.TCPServerBase.close.

Implements io.vertx.core.http.HttpServer.close.

Doc from io.vertx.core.http.HttpServer.close.

Close the server. Any open HTTP connections will be closed.

The close happens asynchronously and the server may not be closed until some time after the call has returned.

Returns:Future<Void>

a future completed with the result

Annotations

@Override

close back to summary

close	back to summary
public void close(Handler<AsyncResult<Void>> done) Implements io.vertx.core.http.HttpServer.close. Doc from io.vertx.core.http.HttpServer.close. Like `close` but supplying a handler that will be called when the server is actually closed (or has failed). Parameters done:Handler<AsyncResult<Void>> the handler Annotations @Override

public void close(Handler<AsyncResult<Void>> done)

Implements io.vertx.core.http.HttpServer.close.

Doc from io.vertx.core.http.HttpServer.close.

Like close but supplying a handler that will be called when the server is actually closed (or has failed).

Parameters

done:Handler<AsyncResult<Void>>: the handler

Annotations

@Override

close back to summary

close	back to summary
public synchronized void close(Promise<Void> completion) Overrides io.vertx.core.net.impl.TCPServerBase.close. Implements io.vertx.core.Closeable.close. Doc from io.vertx.core.Closeable.close. Close this resource, the `completion` promise must be notified when the operation has completed. Parameters completion:Promise<Void> the promise to signal when close has completed

public synchronized void close(Promise<Void> completion)

Overrides io.vertx.core.net.impl.TCPServerBase.close.

Implements io.vertx.core.Closeable.close.

Doc from io.vertx.core.Closeable.close.

Close this resource, the completion promise must be notified when the operation has completed.

Parameters

completion:Promise<Void>: the promise to signal when close has completed

connectionHandler	back to summary
public synchronized HttpServer connectionHandler(Handler<HttpConnection> handler) Implements io.vertx.core.http.HttpServer.connectionHandler. Doc from io.vertx.core.http.HttpServer.connectionHandler. Set a connection handler for the server. The handler will always be called on the event-loop thread. Returns:HttpServer a reference to this, so the API can be used fluently Annotations @Override

connectionHandler

back to summary

public synchronized HttpServer connectionHandler(Handler<HttpConnection> handler)

Implements io.vertx.core.http.HttpServer.connectionHandler.

Doc from io.vertx.core.http.HttpServer.connectionHandler.

Set a connection handler for the server.
The handler will always be called on the event-loop thread.

Returns:HttpServer

a reference to this, so the API can be used fluently

Annotations

@Override

createMetrics	back to summary
protected TCPMetrics<?> createMetrics(SocketAddress localAddress) Overrides io.vertx.core.net.impl.TCPServerBase.createMetrics. Annotations @Override

createMetrics

back to summary

protected TCPMetrics<?> createMetrics(SocketAddress localAddress)

Overrides io.vertx.core.net.impl.TCPServerBase.createMetrics.

Annotations

@Override

createSSLHelper	back to summary
protected SSLHelper createSSLHelper() Overrides io.vertx.core.net.impl.TCPServerBase.createSSLHelper. Annotations @Override

createSSLHelper

back to summary

protected SSLHelper createSSLHelper()

Overrides io.vertx.core.net.impl.TCPServerBase.createSSLHelper.

Annotations

@Override

exceptionHandler	back to summary
public synchronized HttpServer exceptionHandler(Handler<Throwable> handler) Implements io.vertx.core.http.HttpServer.exceptionHandler. Doc from io.vertx.core.http.HttpServer.exceptionHandler. Set an exception handler called for socket errors happening before the HTTP connection is established, e.g during the TLS handshake. Parameters handler:Handler<Throwable> the handler to set Returns:HttpServer a reference to this, so the API can be used fluently Annotations @Override

exceptionHandler

back to summary

public synchronized HttpServer exceptionHandler(Handler<Throwable> handler)

Implements io.vertx.core.http.HttpServer.exceptionHandler.

Doc from io.vertx.core.http.HttpServer.exceptionHandler.

Set an exception handler called for socket errors happening before the HTTP connection is established, e.g during the TLS handshake.

Parameters

handler:Handler<Throwable>: the handler to set

Returns:HttpServer

a reference to this, so the API can be used fluently

Annotations

@Override

invalidRequestHandler back to summary

invalidRequestHandler	back to summary
public HttpServer invalidRequestHandler(Handler<HttpServerRequest> handler) Implements io.vertx.core.http.HttpServer.invalidRequestHandler. Doc from io.vertx.core.http.HttpServer.invalidRequestHandler. Set a `handler` for handling invalid requests. When an invalid request is received by the server this handler will be called with the request. The handler can send any HTTP response, when the response ends, the server shall close the connection. `HttpServerRequest#decoderResult()` can be used to obtain the Netty decoder result and the failure cause reported by the decoder. Currently this handler is only used for HTTP/1.x requests. When no specific handler is set, the `HttpServerRequest#DEFAULT_INVALID_REQUEST_HANDLER` is used. Returns:HttpServer a reference to this, so the API can be used fluently Annotations @Override

public HttpServer invalidRequestHandler(Handler<HttpServerRequest> handler)

Implements io.vertx.core.http.HttpServer.invalidRequestHandler.

Doc from io.vertx.core.http.HttpServer.invalidRequestHandler.

Set a handler for handling invalid requests. When an invalid request is received by the server this handler will be called with the request. The handler can send any HTTP response, when the response ends, the server shall close the connection. HttpServerRequest#decoderResult() can be used to obtain the Netty decoder result and the failure cause reported by the decoder.

Currently this handler is only used for HTTP/1.x requests.

When no specific handler is set, the HttpServerRequest#DEFAULT_INVALID_REQUEST_HANDLER is used.

Returns:HttpServer

a reference to this, so the API can be used fluently

Annotations

@Override

isClosed	back to summary
public boolean isClosed()

listen back to summary

listen	back to summary
public Future<HttpServer> listen() Implements io.vertx.core.http.HttpServer.listen. Doc from io.vertx.core.http.HttpServer.listen. Tell the server to start listening. The server will listen on the port and host specified in the `io.vertx.core.http.HttpServerOptions` that was used when creating the server. The listen happens asynchronously and the server may not be listening until some time after the call has returned. Returns:Future<HttpServer> a future completed with the listen operation result Annotations @Override

public Future<HttpServer> listen()

Implements io.vertx.core.http.HttpServer.listen.

Doc from io.vertx.core.http.HttpServer.listen.

Tell the server to start listening. The server will listen on the port and host specified in the io.vertx.core.http.HttpServerOptions that was used when creating the server.

The listen happens asynchronously and the server may not be listening until some time after the call has returned.

Returns:Future<HttpServer>

a future completed with the listen operation result

Annotations

@Override

listen back to summary

listen	back to summary
public synchronized Future<HttpServer> listen(SocketAddress address) Implements io.vertx.core.http.HttpServer.listen. Doc from io.vertx.core.http.HttpServer.listen. Like `listen(SocketAddress, Handler)` but returns a `Future` of the asynchronous result Annotations @Override

public synchronized Future<HttpServer> listen(SocketAddress address)

Implements io.vertx.core.http.HttpServer.listen.

Doc from io.vertx.core.http.HttpServer.listen.

Like listen(SocketAddress, Handler) but returns a Future of the asynchronous result

Annotations

@Override

requestAccept	back to summary
pack-priv boolean requestAccept()

requestHandler back to summary

requestHandler	back to summary
public synchronized HttpServer requestHandler(Handler<HttpServerRequest> handler) Implements io.vertx.core.http.HttpServer.requestHandler. Doc from io.vertx.core.http.HttpServer.requestHandler. Set the request handler for the server to `requestHandler`. As HTTP requests are received by the server, instances of `HttpServerRequest` will be created and passed to this handler. Returns:HttpServer a reference to this, so the API can be used fluently Annotations @Override

public synchronized HttpServer requestHandler(Handler<HttpServerRequest> handler)

Implements io.vertx.core.http.HttpServer.requestHandler.

Doc from io.vertx.core.http.HttpServer.requestHandler.

Set the request handler for the server to requestHandler. As HTTP requests are received by the server, instances of HttpServerRequest will be created and passed to this handler.

Returns:HttpServer

a reference to this, so the API can be used fluently

Annotations

@Override

requestHandler	back to summary
public Handler<HttpServerRequest> requestHandler() Implements io.vertx.core.http.HttpServer.requestHandler. Returns:Handler<HttpServerRequest> Doc from io.vertx.core.http.HttpServer.requestHandler. the request handler Annotations @Override

requestHandler

back to summary

public Handler<HttpServerRequest> requestHandler()

Implements io.vertx.core.http.HttpServer.requestHandler.

Returns:Handler<HttpServerRequest>

Doc from io.vertx.core.http.HttpServer.requestHandler.

the request handler

Annotations

@Override

requestStream back to summary

requestStream	back to summary
public ReadStream<HttpServerRequest> requestStream() Implements io.vertx.core.http.HttpServer.requestStream. Doc from io.vertx.core.http.HttpServer.requestStream. Return the request stream for the server. As HTTP requests are received by the server, instances of `HttpServerRequest` will be created and passed to the stream `io.vertx.core.streams.ReadStream#handler(io.vertx.core.Handler)`. Returns:ReadStream<HttpServerRequest> the request stream Annotations @Override

public ReadStream<HttpServerRequest> requestStream()

Implements io.vertx.core.http.HttpServer.requestStream.

Doc from io.vertx.core.http.HttpServer.requestStream.

Return the request stream for the server. As HTTP requests are received by the server, instances of HttpServerRequest will be created and passed to the stream io.vertx.core.streams.ReadStream#handler(io.vertx.core.Handler).

Returns:ReadStream<HttpServerRequest>

the request stream

Annotations

@Override

webSocketHandler back to summary

webSocketHandler	back to summary
public HttpServer webSocketHandler(Handler<ServerWebSocket> handler) Implements io.vertx.core.http.HttpServer.webSocketHandler. Doc from io.vertx.core.http.HttpServer.webSocketHandler. Set the WebSocket handler for the server to `wsHandler`. If a WebSocket connect handshake is successful a new `ServerWebSocket` instance will be created and passed to the handler. Returns:HttpServer a reference to this, so the API can be used fluently Annotations @Override

public HttpServer webSocketHandler(Handler<ServerWebSocket> handler)

Implements io.vertx.core.http.HttpServer.webSocketHandler.

Doc from io.vertx.core.http.HttpServer.webSocketHandler.

Set the WebSocket handler for the server to wsHandler. If a WebSocket connect handshake is successful a new ServerWebSocket instance will be created and passed to the handler.

Returns:HttpServer

a reference to this, so the API can be used fluently

Annotations

@Override

webSocketHandler	back to summary
public Handler<ServerWebSocket> webSocketHandler() Implements io.vertx.core.http.HttpServer.webSocketHandler. Returns:Handler<ServerWebSocket> Doc from io.vertx.core.http.HttpServer.webSocketHandler. the WebSocket handler Annotations @Override

webSocketHandler

back to summary

public Handler<ServerWebSocket> webSocketHandler()

Implements io.vertx.core.http.HttpServer.webSocketHandler.

Returns:Handler<ServerWebSocket>

Doc from io.vertx.core.http.HttpServer.webSocketHandler.

the WebSocket handler

Annotations

@Override

webSocketHandshakeHandler back to summary

webSocketHandshakeHandler	back to summary
public HttpServer webSocketHandshakeHandler(Handler<ServerWebSocketHandshake> handler) Implements io.vertx.core.http.HttpServer.webSocketHandshakeHandler. Doc from io.vertx.core.http.HttpServer.webSocketHandshakeHandler. Set a handler for WebSocket handshake. When an inbound HTTP request presents a WebSocket upgrade, this handler is called first. The handler can chose to `ServerWebSocketHandshake#accept()` or `ServerWebSocketHandshake#reject()` the request. Setting no handler, implicitly accepts any HTTP request connection presenting an upgrade header and upgrades it to a WebSocket. Annotations @Override

public HttpServer webSocketHandshakeHandler(Handler<ServerWebSocketHandshake> handler)

Implements io.vertx.core.http.HttpServer.webSocketHandshakeHandler.

Doc from io.vertx.core.http.HttpServer.webSocketHandshakeHandler.

Set a handler for WebSocket handshake.

When an inbound HTTP request presents a WebSocket upgrade, this handler is called first. The handler can chose to ServerWebSocketHandshake#accept() or ServerWebSocketHandshake#reject() the request.

Setting no handler, implicitly accepts any HTTP request connection presenting an upgrade header and upgrades it to a WebSocket.

Annotations

@Override

webSocketStream back to summary

webSocketStream	back to summary
public ReadStream<ServerWebSocket> webSocketStream() Implements io.vertx.core.http.HttpServer.webSocketStream. Doc from io.vertx.core.http.HttpServer.webSocketStream. Return the WebSocket stream for the server. If a WebSocket connect handshake is successful a new `ServerWebSocket` instance will be created and passed to the stream `io.vertx.core.streams.ReadStream#handler(io.vertx.core.Handler)`. Returns:ReadStream<ServerWebSocket> the WebSocket stream Annotations @Override

public ReadStream<ServerWebSocket> webSocketStream()

Implements io.vertx.core.http.HttpServer.webSocketStream.

Doc from io.vertx.core.http.HttpServer.webSocketStream.

Return the WebSocket stream for the server. If a WebSocket connect handshake is successful a new ServerWebSocket instance will be created and passed to the stream io.vertx.core.streams.ReadStream#handler(io.vertx.core.Handler).

Returns:ReadStream<ServerWebSocket>

the WebSocket stream

Annotations

@Override

wsAccept	back to summary
pack-priv boolean wsAccept()

io.vertx.core.http.impl back to summary

pack-priv Class HttpServerImpl.HttpStreamHandler<C extends ReadStream<Buffer>>

Class Inheritance

extends Object
implements ReadStream<C extends ReadStream<Buffer>>

java.lang.Object
io.vertx.core.http.impl.HttpServerImpl.HttpStreamHandler

All Implemented Interfaces

io.vertx.core.streams.ReadStream, io.vertx.core.streams.StreamBase

Field Summary

Modifier and Type	Field and Description
private long	demand
private Handler<Void>	endHandler
private Handler<C>	handler

Constructor Summary

Access	Constructor and Description
pack-priv	HttpStreamHandler()

Method Summary

Modifier and Type	Method and Description
pack-priv boolean	accept()
pack-priv Handler<Void>	endHandler()
public ReadStream<T>	endHandler(Handler<Void> endHandler)
public ReadStream<T>	exceptionHandler(Handler<Throwable> handler)
public ReadStream<T>	fetch(long amount) Implements io.vertx.core.streams.ReadStream.fetch. Fetch the specified `amount` of elements.
pack-priv Handler<C>	handler()
public ReadStream<T>	handler(Handler<C> handler)
public ReadStream<T>	pause() Implements io.vertx.core.streams.ReadStream.pause. Pause the `ReadStream`, it sets the buffer in `fetch` mode and clears the actual demand.
public ReadStream<T>	resume() Implements io.vertx.core.streams.ReadStream.resume. Resume reading, and sets the buffer in `flowing` mode.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

demand	back to summary
private long demand

endHandler	back to summary
private Handler<Void> endHandler

handler	back to summary
private Handler<C> handler

Constructor Detail

HttpStreamHandler	back to summary
pack-priv HttpStreamHandler()

Method Detail

accept	back to summary
pack-priv boolean accept()

endHandler	back to summary
pack-priv Handler<Void> endHandler()

endHandler	back to summary
public ReadStream<T> endHandler(Handler<Void> endHandler) Annotations @Override

exceptionHandler	back to summary
public ReadStream<T> exceptionHandler(Handler<Throwable> handler) Annotations @Override

fetch back to summary

public ReadStream<T> fetch(long amount)

Implements io.vertx.core.streams.ReadStream.fetch.

Doc from io.vertx.core.streams.ReadStream.fetch.

Fetch the specified amount of elements. If the ReadStream has been paused, reading will recommence with the specified amount of items, otherwise the specified amount will be added to the current stream demand.

Returns:ReadStream<T>

a reference to this, so the API can be used fluently

Annotations