io.vertx.core.http

Interface HttpServer

All Superinterfaces:

Measured

All Known Implementing Classes:

HttpServerImpl

public interface HttpServer
extends Measured

An HTTP and WebSockets server<p> If an instance is instantiated from an event loop then the handlers of the instance will always be called on that same event loop. If an instance is instantiated from some other arbitrary Java thread then an event loop will be assigned to the instance and used when any of its handlers are called.<p> Instances of HttpServer are thread-safe.<p>

Author:

<a href="http://tfox.org">Tim Fox</a>

Method Summary

Modifier and Type	Method and Description
void	close() Close the server.
void	close(Handler<AsyncResult<Void>> completionHandler) Close the server.
HttpServer	listen()
HttpServer	listen(Handler<AsyncResult<HttpServer>> listenHandler)
Handler<HttpServerRequest>	requestHandler()
HttpServer	requestHandler(Handler<HttpServerRequest> handler) Set the request handler for the server to requestHandler.
HttpServerRequestStream	requestStream() Return the request stream for the server.
Handler<ServerWebSocket>	websocketHandler()
HttpServer	websocketHandler(Handler<ServerWebSocket> handler) Set the websocket handler for the server to wsHandler.
ServerWebSocketStream	websocketStream() Return the websocket stream for the server.

Methods inherited from interface io.vertx.core.metrics.Measured

metricBaseName, metrics

Method Detail

requestStream

HttpServerRequestStream 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 this stream ReadStream.handler(io.vertx.core.Handler).

Returns:

the request stream

requestHandler

HttpServer requestHandler(Handler<HttpServerRequest> handler)

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:

a reference to this, so methods can be chained.

requestHandler

Handler<HttpServerRequest> requestHandler()

websocketStream

ServerWebSocketStream 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 this stream ReadStream.handler(io.vertx.core.Handler).

Returns:

the websocket stream

websocketHandler

HttpServer websocketHandler(Handler<ServerWebSocket> handler)

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:

a reference to this, so methods can be chained.

websocketHandler

Handler<ServerWebSocket> websocketHandler()

listen

HttpServer listen()

listen

HttpServer listen(Handler<AsyncResult<HttpServer>> listenHandler)

close

void close()

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

close

void close(Handler<AsyncResult<Void>> completionHandler)

Close the server. Any open HTTP connections will be closed. The completionHandler will be called when the close is complete.