Modifier and Type | Method and Description |
---|---|
HttpServer |
Vertx.createHttpServer(HttpServerOptions options)
Create an HTTP/HTTPS server using the specified options
|
Modifier and Type | Method and Description |
---|---|
HttpServerOptions |
HttpServerOptions.addCompressor(CompressionOptions compressor)
Add a compressor.
|
HttpServerOptions |
HttpServerOptions.addCrlPath(String crlPath) |
HttpServerOptions |
HttpServerOptions.addCrlValue(Buffer crlValue) |
HttpServerOptions |
HttpServerOptions.addEnabledCipherSuite(String suite) |
HttpServerOptions |
HttpServerOptions.addEnabledSecureTransportProtocol(String protocol) |
HttpServerOptions |
HttpServerOptions.addWebSocketSubProtocol(String subProtocol)
Add a WebSocket sub-protocol to the list supported by the server.
|
HttpServerOptions |
HttpServerOptions.removeEnabledCipherSuite(String suite) |
HttpServerOptions |
HttpServerOptions.removeEnabledSecureTransportProtocol(String protocol) |
HttpServerOptions |
HttpServerOptions.setAcceptBacklog(int acceptBacklog) |
HttpServerOptions |
HttpServerOptions.setAcceptUnmaskedFrames(boolean acceptUnmaskedFrames)
Set
true when the server accepts unmasked frame. |
HttpServerOptions |
HttpServerOptions.setActivityLogDataFormat(ByteBufFormat activityLogDataFormat) |
HttpServerOptions |
HttpServerOptions.setAlpnVersions(List<HttpVersion> alpnVersions)
Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiatiation.
|
HttpServerOptions |
HttpServerOptions.setClientAuth(ClientAuth clientAuth) |
HttpServerOptions |
HttpServerOptions.setCompressionLevel(int compressionLevel)
This method allows to set the compression level to be used in http1.x/2 response bodies
when compression support is turned on (@see setCompressionSupported) and the client advertises
to support
deflate/gzip compression in the Accept-Encoding header
default value is : 6 (Netty legacy)
The compression level determines how much the data is compressed on a scale from 1 to 9,
where '9' is trying to achieve the maximum compression ratio while '1' instead is giving
priority to speed instead of compression ratio using some algorithm optimizations and skipping
pedantic loops that usually gives just little improvements
While one can think that best value is always the maximum compression ratio,
there's a trade-off to consider: the most compressed level requires the most
computational work to compress/decompress data, e.g. |
HttpServerOptions |
HttpServerOptions.setCompressionSupported(boolean compressionSupported)
Set whether the server should support gzip/deflate compression
(serving compressed responses to clients advertising support for them with Accept-Encoding header)
|
HttpServerOptions |
HttpServerOptions.setCompressors(List<CompressionOptions> compressors)
Set the list of compressor to use instead of using the default gzip/deflate
setCompressionLevel(int) configuration. |
HttpServerOptions |
HttpServerOptions.setDecoderInitialBufferSize(int decoderInitialBufferSize)
Set the initial buffer size for the HTTP decoder
|
HttpServerOptions |
HttpServerOptions.setDecompressionSupported(boolean decompressionSupported)
Set whether the server supports decompression
|
HttpServerOptions |
HttpServerOptions.setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols) |
HttpServerOptions |
HttpServerOptions.setHandle100ContinueAutomatically(boolean handle100ContinueAutomatically)
Set whether 100 Continue should be handled automatically
|
HttpServerOptions |
HttpServerOptions.setHost(String host) |
HttpServerOptions |
HttpServerOptions.setHttp2ConnectionWindowSize(int http2ConnectionWindowSize)
Set the default HTTP/2 connection window size.
|
HttpServerOptions |
HttpServerOptions.setHttp2RstFloodMaxRstFramePerWindow(int http2RstFloodMaxRstFramePerWindow)
Set the max number of RST frame allowed per time window, this is used to prevent HTTP/2 RST frame flood DDOS
attacks.
|
HttpServerOptions |
HttpServerOptions.setHttp2RstFloodWindowDuration(int http2RstFloodWindowDuration)
Set the duration of the time window when checking the max number of RST frames, this is used to prevent HTTP/2 RST frame flood DDOS
attacks.
|
HttpServerOptions |
HttpServerOptions.setHttp2RstFloodWindowDurationTimeUnit(TimeUnit http2RstFloodWindowDurationTimeUnit)
Set the time unit of the duration of the time window when checking the max number of RST frames, this is used to
prevent HTTP/2 RST frame flood DDOS attacks.
|
HttpServerOptions |
HttpServerOptions.setIdleTimeout(int idleTimeout) |
HttpServerOptions |
HttpServerOptions.setIdleTimeoutUnit(TimeUnit idleTimeoutUnit) |
HttpServerOptions |
HttpServerOptions.setInitialSettings(Http2Settings settings)
Set the HTTP/2 connection settings immediatly sent by the server when a client connects.
|
HttpServerOptions |
HttpServerOptions.setJdkSslEngineOptions(JdkSSLEngineOptions sslEngineOptions) |
HttpServerOptions |
HttpServerOptions.setKeyCertOptions(KeyCertOptions options) |
HttpServerOptions |
HttpServerOptions.setKeyStoreOptions(JksOptions options) |
HttpServerOptions |
HttpServerOptions.setLogActivity(boolean logEnabled) |
HttpServerOptions |
HttpServerOptions.setMaxChunkSize(int maxChunkSize)
Set the maximum HTTP chunk size that
HttpServerRequest.handler(Handler) will receive |
HttpServerOptions |
HttpServerOptions.setMaxFormAttributeSize(int maxSize)
Set the maximum size of a form attribute.
|
HttpServerOptions |
HttpServerOptions.setMaxFormBufferedBytes(int maxFormBufferedBytes)
Set the maximum number of bytes a server can buffer when decoding a form.
|
HttpServerOptions |
HttpServerOptions.setMaxFormFields(int maxFormFields)
Set the maximum number of fields of a form.
|
HttpServerOptions |
HttpServerOptions.setMaxHeaderSize(int maxHeaderSize)
Set the maximum length of all headers for HTTP/1.x .
|
HttpServerOptions |
HttpServerOptions.setMaxInitialLineLength(int maxInitialLineLength)
Set the maximum length of the initial line for HTTP/1.x (e.g.
|
HttpServerOptions |
HttpServerOptions.setMaxWebSocketFrameSize(int maxWebSocketFrameSize)
Set the maximum WebSocket frames size
|
HttpServerOptions |
HttpServerOptions.setMaxWebSocketMessageSize(int maxWebSocketMessageSize)
Set the maximum WebSocket message size
|
HttpServerOptions |
HttpServerOptions.setOpenSslEngineOptions(OpenSSLEngineOptions sslEngineOptions) |
HttpServerOptions |
HttpServerOptions.setPemKeyCertOptions(PemKeyCertOptions options) |
HttpServerOptions |
HttpServerOptions.setPemTrustOptions(PemTrustOptions options) |
HttpServerOptions |
HttpServerOptions.setPerFrameWebSocketCompressionSupported(boolean supported)
Enable or disable support for the WebSocket per-frame deflate compression extension.
|
HttpServerOptions |
HttpServerOptions.setPerMessageWebSocketCompressionSupported(boolean supported)
Enable or disable support for WebSocket per-message deflate compression extension.
|
HttpServerOptions |
HttpServerOptions.setPfxKeyCertOptions(PfxOptions options) |
HttpServerOptions |
HttpServerOptions.setPfxTrustOptions(PfxOptions options) |
HttpServerOptions |
HttpServerOptions.setPort(int port) |
HttpServerOptions |
HttpServerOptions.setProxyProtocolTimeout(long proxyProtocolTimeout) |
HttpServerOptions |
HttpServerOptions.setProxyProtocolTimeoutUnit(TimeUnit proxyProtocolTimeoutUnit) |
HttpServerOptions |
HttpServerOptions.setReadIdleTimeout(int idleTimeout) |
HttpServerOptions |
HttpServerOptions.setReceiveBufferSize(int receiveBufferSize) |
HttpServerOptions |
HttpServerOptions.setRegisterWebSocketWriteHandlers(boolean registerWebSocketWriteHandlers)
Whether write-handlers for server websockets should be registered on the
EventBus . |
HttpServerOptions |
HttpServerOptions.setRegisterWriteHandler(boolean registerWriteHandler)
Has no effect on HTTP server options.
|
HttpServerOptions |
HttpServerOptions.setReuseAddress(boolean reuseAddress) |
HttpServerOptions |
HttpServerOptions.setReusePort(boolean reusePort) |
HttpServerOptions |
HttpServerOptions.setSendBufferSize(int sendBufferSize) |
HttpServerOptions |
HttpServerOptions.setSni(boolean sni) |
HttpServerOptions |
HttpServerOptions.setSoLinger(int soLinger) |
HttpServerOptions |
HttpServerOptions.setSsl(boolean ssl) |
HttpServerOptions |
HttpServerOptions.setSslEngineOptions(SSLEngineOptions sslEngineOptions) |
HttpServerOptions |
HttpServerOptions.setSslHandshakeTimeout(long sslHandshakeTimeout) |
HttpServerOptions |
HttpServerOptions.setSslHandshakeTimeoutUnit(TimeUnit sslHandshakeTimeoutUnit) |
HttpServerOptions |
HttpServerOptions.setTcpCork(boolean tcpCork) |
HttpServerOptions |
HttpServerOptions.setTcpFastOpen(boolean tcpFastOpen) |
HttpServerOptions |
HttpServerOptions.setTcpKeepAlive(boolean tcpKeepAlive) |
HttpServerOptions |
HttpServerOptions.setTcpNoDelay(boolean tcpNoDelay) |
HttpServerOptions |
HttpServerOptions.setTcpQuickAck(boolean tcpQuickAck) |
HttpServerOptions |
HttpServerOptions.setTracingPolicy(TracingPolicy tracingPolicy)
Set the tracing policy for the server behavior when Vert.x has tracing enabled.
|
HttpServerOptions |
HttpServerOptions.setTrafficClass(int trafficClass) |
HttpServerOptions |
HttpServerOptions.setTrafficShapingOptions(TrafficShapingOptions trafficShapingOptions) |
HttpServerOptions |
HttpServerOptions.setTrustOptions(TrustOptions options) |
HttpServerOptions |
HttpServerOptions.setTrustStoreOptions(JksOptions options) |
HttpServerOptions |
HttpServerOptions.setUseAlpn(boolean useAlpn) |
HttpServerOptions |
HttpServerOptions.setUseProxyProtocol(boolean useProxyProtocol) |
HttpServerOptions |
HttpServerOptions.setWebSocketAllowServerNoContext(boolean accept)
Set whether the WebSocket server will accept the
server_no_context_takeover parameter of the per-message
deflate compression extension offered by the client. |
HttpServerOptions |
HttpServerOptions.setWebSocketClosingTimeout(int webSocketClosingTimeout)
Set the amount of time a server WebSocket will wait until it closes the TCP connection
after sending a close frame.
|
HttpServerOptions |
HttpServerOptions.setWebSocketCompressionLevel(int compressionLevel)
Set the WebSocket compression level.
|
HttpServerOptions |
HttpServerOptions.setWebSocketPreferredClientNoContext(boolean accept)
Set whether the WebSocket server will accept the
client_no_context_takeover parameter of the per-message
deflate compression extension offered by the client. |
HttpServerOptions |
HttpServerOptions.setWebSocketSubProtocols(List<String> subProtocols)
Set the WebSocket list of sub-protocol supported by the server.
|
HttpServerOptions |
HttpServerOptions.setWriteIdleTimeout(int idleTimeout) |
Constructor and Description |
---|
HttpServerOptions(HttpServerOptions other)
Copy constructor
|
Modifier and Type | Method and Description |
---|---|
default HttpServerMetrics<?,?,?> |
VertxMetrics.createHttpServerMetrics(HttpServerOptions options,
SocketAddress localAddress)
Provides the http server metrics SPI when an http server is created.
|
Modifier and Type | Class and Description |
---|---|
class |
HttpTermOptions
The web term configuration options.
|
Modifier and Type | Method and Description |
---|---|
VertxServerBuilder |
VertxServerBuilder.useSsl(Handler<HttpServerOptions> handler) |
Modifier and Type | Method and Description |
---|---|
HttpServerOptions |
VertxPrometheusOptions.getEmbeddedServerOptions()
Get the HTTP server options of the embedded server, if any
|
Modifier and Type | Method and Description |
---|---|
VertxPrometheusOptions |
VertxPrometheusOptions.setEmbeddedServerOptions(HttpServerOptions embeddedServerOptions)
HTTP server options for the embedded server
|
Modifier and Type | Method and Description |
---|---|
HttpServer |
Vertx.createHttpServer(HttpServerOptions options)
Create an HTTP/HTTPS server using the specified options
|
Modifier and Type | Method and Description |
---|---|
HttpServer |
Vertx.createHttpServer(HttpServerOptions options)
Create an HTTP/HTTPS server using the specified options
|
Modifier and Type | Method and Description |
---|---|
HttpServer |
Vertx.createHttpServer(HttpServerOptions options)
Create an HTTP/HTTPS server using the specified options
|
Copyright © 2024 Eclipse. All rights reserved.