public interface HttpServer
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.
Instances cannot be used from worker verticles
Modifier and Type | Method and Description |
---|---|
void |
close()
Close the server.
|
void |
close(Handler<java.lang.Void> doneHandler)
Close the server.
|
java.lang.Integer |
getAcceptBacklog() |
java.lang.String |
getKeyStorePassword() |
java.lang.String |
getKeyStorePath() |
java.lang.Integer |
getReceiveBufferSize() |
java.lang.Integer |
getSendBufferSize() |
java.lang.Integer |
getTrafficClass() |
java.lang.String |
getTrustStorePassword() |
java.lang.String |
getTrustStorePath() |
java.lang.Boolean |
isReuseAddress() |
java.lang.Boolean |
isSoLinger() |
boolean |
isSSL() |
java.lang.Boolean |
isTCPKeepAlive() |
java.lang.Boolean |
isTCPNoDelay() |
HttpServer |
listen(int port)
Tell the server to start listening on all available interfaces and port
port |
HttpServer |
listen(int port,
java.lang.String host)
Tell the server to start listening on port
port and hostname or ip address given by host . |
Handler<HttpServerRequest> |
requestHandler()
Get the request handler
|
HttpServer |
requestHandler(Handler<HttpServerRequest> requestHandler)
Set the request handler for the server to
requestHandler . |
HttpServer |
setAcceptBacklog(int backlog)
Set the accept backlog
|
HttpServer |
setClientAuthRequired(boolean required)
Set
required to true if you want the server to request client authentication from any connecting clients. |
HttpServer |
setKeyStorePassword(java.lang.String pwd)
Set the password for the SSL key store.
|
HttpServer |
setKeyStorePath(java.lang.String path)
Set the path to the SSL key store.
|
HttpServer |
setReceiveBufferSize(int size)
Set the TCP receive buffer size for connections created by this instance to
size in bytes. |
HttpServer |
setReuseAddress(boolean reuse)
Set the TCP reuseAddress setting for connections created by this instance to
reuse . |
HttpServer |
setSendBufferSize(int size)
Set the TCP send buffer size for connections created by this instance to
size in bytes. |
HttpServer |
setSoLinger(boolean linger)
Set the TCP soLinger setting for connections created by this instance to
linger . |
HttpServer |
setSSL(boolean ssl)
If
ssl is true , this signifies that any connections will be SSL connections. |
HttpServer |
setTCPKeepAlive(boolean keepAlive)
Set the TCP keepAlive setting for connections created by this instance to
keepAlive . |
HttpServer |
setTCPNoDelay(boolean tcpNoDelay)
If
tcpNoDelay is set to true then Nagle's algorithm
will turned off for the TCP connections created by this instance. |
HttpServer |
setTrafficClass(int trafficClass)
Set the TCP trafficClass setting for connections created by this instance to
trafficClass . |
HttpServer |
setTrustStorePassword(java.lang.String pwd)
Set the password for the SSL trust store.
|
HttpServer |
setTrustStorePath(java.lang.String path)
Set the path to the SSL trust store.
|
Handler<ServerWebSocket> |
websocketHandler()
Get the websocket handler
|
HttpServer |
websocketHandler(Handler<ServerWebSocket> wsHandler)
Set the websocket handler for the server to
wsHandler . |
HttpServer requestHandler(Handler<HttpServerRequest> requestHandler)
requestHandler
. As HTTP requests are received by the server,
instances of HttpServerRequest
will be created and passed to this handler.Handler<HttpServerRequest> requestHandler()
HttpServer websocketHandler(Handler<ServerWebSocket> wsHandler)
wsHandler
. If a websocket connect handshake is successful a
new WebSocket
instance will be created and passed to the handler.Handler<ServerWebSocket> websocketHandler()
HttpServer listen(int port)
port
HttpServer listen(int port, java.lang.String host)
port
and hostname or ip address given by host
.void close()
void close(Handler<java.lang.Void> doneHandler)
doneHandler
will be called when the close
is complete.HttpServer setSSL(boolean ssl)
ssl
is true
, this signifies that any connections will be SSL connections.HttpServer setKeyStorePath(java.lang.String path)
setSSL(boolean)
has been set to true
.The SSL key store is a standard Java Key Store, and should contain the server certificate.
HttpServer setKeyStorePassword(java.lang.String pwd)
setSSL(boolean)
has been set to true
.HttpServer setTrustStorePath(java.lang.String path)
setSSL(boolean)
has been set to true
.The trust store is a standard Java Key Store, and should contain the certificates of any clients that the server trusts - this is only necessary if client authentication is enabled.
HttpServer setTrustStorePassword(java.lang.String pwd)
setSSL(boolean)
has been set to true
.HttpServer setClientAuthRequired(boolean required)
required
to true if you want the server to request client authentication from any connecting clients. This
is an extra level of security in SSL, and requires clients to provide client certificates. Those certificates must be added
to the server trust store.HttpServer setTCPNoDelay(boolean tcpNoDelay)
tcpNoDelay
is set to true
then Nagle's algorithm
will turned off for the TCP connections created by this instance.HttpServer setSendBufferSize(int size)
size
in bytes.HttpServer setReceiveBufferSize(int size)
size
in bytes.HttpServer setTCPKeepAlive(boolean keepAlive)
keepAlive
.HttpServer setReuseAddress(boolean reuse)
reuse
.HttpServer setSoLinger(boolean linger)
linger
.HttpServer setTrafficClass(int trafficClass)
trafficClass
.HttpServer setAcceptBacklog(int backlog)
java.lang.Boolean isTCPNoDelay()
java.lang.Integer getSendBufferSize()
java.lang.Integer getReceiveBufferSize()
java.lang.Boolean isTCPKeepAlive()
java.lang.Boolean isReuseAddress()
java.lang.Boolean isSoLinger()
java.lang.Integer getTrafficClass()
java.lang.Integer getAcceptBacklog()
boolean isSSL()
java.lang.String getKeyStorePath()
java.lang.String getKeyStorePassword()
java.lang.String getTrustStorePath()
java.lang.String getTrustStorePassword()