Top Description Fields Constructors Methods
io.vertx.core.http

public Class HttpServerOptions

extends NetServerOptions
Class Inheritance
Annotations
@DataObject
@JsonGen
publicConverter:false
Imports
io.netty.handler.codec.compression.CompressionOptions, io.netty.handler.logging.ByteBufFormat, io.vertx.codegen.annotations.DataObject, .Unstable, io.vertx.codegen.json.annotations.JsonGen, io.vertx.core.Handler, io.vertx.core.buffer.Buffer, io.vertx.core.impl.Arguments, io.vertx.core.json.JsonObject, io.vertx.core.net.JdkSSLEngineOptions, .JksOptions, .KeyCertOptions, .NetServerOptions, .OpenSSLEngineOptions, .PemKeyCertOptions, .PemTrustOptions, .PfxOptions, .SSLEngineOptions, .TrafficShapingOptions, .TrustOptions, io.vertx.core.tracing.TracingPolicy, java.util.ArrayList, .Arrays, .Collections, .List, .Objects, .Set, java.util.concurrent.TimeUnit

Represents options used by an io.vertx.core.http.HttpServer instance
Author
Tim Fox

Field Summary

Modifier and TypeField and Description
private boolean
private List<HttpVersion>
private int
private boolean
private List<CompressionOptions>
private int
private boolean
public static final boolean
DEFAULT_ACCEPT_UNMASKED_FRAMES

Default WebSocket Masked bit is true as depicted by RFC = false

public static final List<HttpVersion>
DEFAULT_ALPN_VERSIONS

Default Application-Layer Protocol Negotiation versions = [HTTP/2,HTTP/1.1]

public static final int
DEFAULT_COMPRESSION_LEVEL

Default gzip/deflate compression level = 6 (Netty legacy)

public static final boolean
DEFAULT_COMPRESSION_SUPPORTED

Default value of whether compression is supported = false

public static final int
DEFAULT_DECODER_INITIAL_BUFFER_SIZE

Default initial buffer size for HttpObjectDecoder = 128 bytes

public static final boolean
DEFAULT_DECOMPRESSION_SUPPORTED

Default value of whether decompression is supported = false

public static final boolean
DEFAULT_HANDLE_100_CONTINE_AUTOMATICALLY

Default value of whether 100-Continue should be handled automatically = false

public static final boolean
DEFAULT_HTTP2_CLEAR_TEXT_ENABLED

Default H2C is enabled = true

public static final int
DEFAULT_HTTP2_CONNECTION_WINDOW_SIZE

The default HTTP/2 connection window size = -1

public static final int
DEFAULT_HTTP2_RST_FLOOD_MAX_RST_FRAME_PER_WINDOW

HTTP/2 RST floods DDOS protection, max number of RST frame per time window allowed = 200.

public static final int
DEFAULT_HTTP2_RST_FLOOD_WINDOW_DURATION

HTTP/2 RST floods DDOS protection, time window duration = 30.

public static final TimeUnit
DEFAULT_HTTP2_RST_FLOOD_WINDOW_DURATION_TIME_UNIT

HTTP/2 RST floods DDOS protection, time window duration unit = TimeUnit#SECONDS.

public static final long
DEFAULT_INITIAL_SETTINGS_MAX_CONCURRENT_STREAMS

The default initial settings max concurrent stream for an HTTP/2 server = 100

public static final int
DEFAULT_MAX_CHUNK_SIZE

Default max HTTP chunk size = 8192

public static final int
DEFAULT_MAX_FORM_ATTRIBUTE_SIZE

Default max size of a form attribute = 8192

public static final int
DEFAULT_MAX_FORM_BUFFERED_SIZE

Default max number buffered bytes when decoding a form = 1024

public static final int
DEFAULT_MAX_FORM_FIELDS

Default max number of form fields = 256

public static final int
DEFAULT_MAX_HEADER_SIZE

Default max length of all headers = 8192

public static final int
DEFAULT_MAX_INITIAL_LINE_LENGTH

Default max length of the initial line (e.g. "GET / HTTP/1.0") = 4096

public static final int
DEFAULT_MAX_WEBSOCKET_FRAME_SIZE

Default max WebSocket frame size = 65536

public static final int
DEFAULT_MAX_WEBSOCKET_MESSAGE_SIZE

Default max WebSocket message size (could be assembled from multiple frames) is 4 full frames worth of data

public static final boolean
DEFAULT_PER_FRAME_WEBSOCKET_COMPRESSION_SUPPORTED

Default support for WebSockets per-frame deflate compression extension = true

public static final boolean
DEFAULT_PER_MESSAGE_WEBSOCKET_COMPRESSION_SUPPORTED

Default support for WebSockets per-message deflate compression extension = true

public static final int
DEFAULT_PORT

Hides io.vertx.core.net.NetServerOptions.DEFAULT_PORT.

Default port the server will listen on = 80
public static final boolean
DEFAULT_REGISTER_WEBSOCKET_WRITE_HANDLERS

Whether write-handlers for server websockets should be registered by default = false.

public static final TracingPolicy
public static final boolean
DEFAULT_WEBSOCKET_ALLOW_SERVER_NO_CONTEXT

Default allowance of the server_no_context_takeover WebSocket parameter deflate compression extension = false

public static final int
DEFAULT_WEBSOCKET_CLOSING_TIMEOUT

Default WebSocket closing timeout = 10 second)

public static final int
DEFAULT_WEBSOCKET_COMPRESSION_LEVEL

Default WebSocket deflate compression level = 6

public static final boolean
DEFAULT_WEBSOCKET_PREFERRED_CLIENT_NO_CONTEXT

Default allowance of the client_no_context_takeover WebSocket parameter deflate compression extension = false

private boolean
private boolean
private int
private int
private int
private TimeUnit
private Http2Settings
private int
private int
private int
private int
private int
private int
private int
private int
private boolean
private boolean
private boolean
private TracingPolicy
private boolean
private int
private int
private boolean
private List<String>
Inherited from io.vertx.core.net.NetServerOptions:
DEFAULT_ACCEPT_BACKLOGDEFAULT_CLIENT_AUTHDEFAULT_HOSTDEFAULT_PROXY_PROTOCOL_TIMEOUTDEFAULT_PROXY_PROTOCOL_TIMEOUT_TIME_UNITDEFAULT_REGISTER_WRITE_HANDLERDEFAULT_SNIDEFAULT_USE_PROXY_PROTOCOL

Constructor Summary

AccessConstructor and Description
public
HttpServerOptions()

Default constructor

public
HttpServerOptions(HttpServerOptions
the options to copy
other
)

Copy constructor

public
HttpServerOptions(JsonObject
the JSON
json
)
References Deprecated JsonObject is deprecated or references (maybe indirectly) at least one deprecated element.

Create an options from JSON

Method Summary

Modifier and TypeMethod and Description
public HttpServerOptions

Returns:

a reference to this, so the API can be used fluently
addCompressor
(CompressionOptions compressor)

Add a compressor.

public HttpServerOptions
addCrlPath(String
the path
crlPath
)

Overrides io.vertx.core.net.NetServerOptions.addCrlPath.

Add a CRL path

public HttpServerOptions
addCrlValue(Buffer
the value
crlValue
)

Overrides io.vertx.core.net.NetServerOptions.addCrlValue.

References Deprecated Buffer is deprecated or references (maybe indirectly) at least one deprecated element.

Add a CRL value

public HttpServerOptions
addEnabledCipherSuite(String
the suite
suite
)

Overrides io.vertx.core.net.NetServerOptions.addEnabledCipherSuite.

Add an enabled cipher suite, appended to the ordered suites.

public HttpServerOptions
addEnabledSecureTransportProtocol(final String
the SSL/TLS protocol to enable
protocol
)

Overrides io.vertx.core.net.NetServerOptions.addEnabledSecureTransportProtocol.

Add an enabled SSL/TLS protocols, appended to the ordered protocols.

public HttpServerOptions

Returns:

a reference to this, so the API can be used fluently
addWebSocketSubProtocol
(String
the sub-protocol to add
subProtocol
)

Add a WebSocket sub-protocol to the list supported by the server.

public List<HttpVersion>

Returns:

the list of protocol versions to provide during the Application-Layer Protocol Negotiatiation
getAlpnVersions
()

public int

Returns:

the server gzip/deflate 'compression level' to be used in responses when client and server support is turned on
getCompressionLevel
()

public List<CompressionOptions>

Returns:

the list of compressor to use
getCompressors
()

public int

Returns:

the initial buffer size for the HTTP decoder
getDecoderInitialBufferSize
()

public int

Returns:

the default HTTP/2 connection window size
getHttp2ConnectionWindowSize
()

public int

Returns:

the max number of RST frame allowed per time window
getHttp2RstFloodMaxRstFramePerWindow
()

public int

Returns:

the duration of the time window when checking the max number of RST frames.
getHttp2RstFloodWindowDuration
()

public TimeUnit

Returns:

the time unit of the duration of the time window when checking the max number of RST frames.
getHttp2RstFloodWindowDurationTimeUnit
()

public Http2Settings

Returns:

the initial HTTP/2 connection settings
getInitialSettings
()

public int

Returns:

the maximum HTTP chunk size that HttpServerRequest#handler(Handler) will receive
getMaxChunkSize
()

public int

Returns:

Returns the maximum size of a form attribute
getMaxFormAttributeSize
()

public int

Returns:

Returns the maximum number of bytes a server can buffer when decoding a form
getMaxFormBufferedBytes
()

public int

Returns:

Returns the maximum number of form fields
getMaxFormFields
()

public int

Returns:

Returns the maximum length of all headers for HTTP/1.x
getMaxHeaderSize
()

public int

Returns:

the maximum length of the initial line for HTTP/1.x (e.g. "GET / HTTP/1.0")
getMaxInitialLineLength
()

public int

Returns:

the maximum WebSocket frame size
getMaxWebSocketFrameSize
()

public int

Returns:

the maximum WebSocket message size
getMaxWebSocketMessageSize
()

public boolean

Returns:

true if the http server will accept the per-frame deflate compression extension
getPerFrameWebSocketCompressionSupported
()

Get whether WebSocket the per-frame deflate compression extension is supported.

public boolean

Returns:

true if the http server will accept the per-message deflate compression extension
getPerMessageWebSocketCompressionSupported
()

Get whether WebSocket per-message deflate compression extension is supported.

public TracingPolicy

Returns:

the tracing policy
getTracingPolicy
()

public boolean

Returns:

true when the WebSocket server will accept the server_no_context_takeover parameter for the per-message deflate compression extension offered by the client
getWebSocketAllowServerNoContext
()

public int

Returns:

the amount of time (in seconds) a client WebSocket will wait until it closes TCP connection after receiving a close frame
getWebSocketClosingTimeout
()

public int

Returns:

the current WebSocket deflate compression level
getWebSocketCompressionLevel
()

public boolean

Returns:

true when the WebSocket server will accept the client_no_context_takeover parameter for the per-message deflate compression extension offered by the client
getWebSocketPreferredClientNoContext
()

public List<String>

Returns:

Get the WebSocket list of sub-protocol
getWebSocketSubProtocols
()

private void
public boolean
public boolean

Returns:

true if the server supports gzip/deflate compression
isCompressionSupported
()

public boolean

Returns:

true if the server supports decompression
isDecompressionSupported
()

public boolean

Returns:

whether 100 Continue should be handled automatically
isHandle100ContinueAutomatically
()

public boolean

Returns:

whether the server accepts HTTP/2 over clear text connections
isHttp2ClearTextEnabled
()

public boolean

Returns:

true if write-handlers for server websockets should be registered on the io.vertx.core.eventbus.EventBus, otherwise false
isRegisterWebSocketWriteHandlers
()

public boolean

Returns:

false, does not apply to HTTP servers
isRegisterWriteHandler
()

Overrides io.vertx.core.net.NetServerOptions.isRegisterWriteHandler.

public HttpServerOptions
removeEnabledCipherSuite(String
the suite
suite
)

Overrides io.vertx.core.net.NetServerOptions.removeEnabledCipherSuite.

Removes an enabled cipher suite from the ordered suites.

public HttpServerOptions
removeEnabledSecureTransportProtocol(String
the SSL/TLS protocol to disable
protocol
)

Overrides io.vertx.core.net.NetServerOptions.removeEnabledSecureTransportProtocol.

Removes an enabled SSL/TLS protocol from the ordered protocols.

public HttpServerOptions
setAcceptBacklog(int
accept backlog
acceptBacklog
)

Overrides io.vertx.core.net.NetServerOptions.setAcceptBacklog.

Set the accept back log

public HttpServerOptions

Returns:

a reference to this, so the API can be used fluently
setAcceptUnmaskedFrames
(boolean
true if enabled
acceptUnmaskedFrames
)

Set true when the server accepts unmasked frame.

public HttpServerOptions
setActivityLogDataFormat(ByteBufFormat
the format to use
activityLogDataFormat
)

Overrides io.vertx.core.net.NetServerOptions.setActivityLogDataFormat.

Set the value of Netty's logging handler's data format: Netty's pipeline is configured for logging on Netty's logger.

public HttpServerOptions

Returns:

a reference to this, so the API can be used fluently
setAlpnVersions
(List<HttpVersion>
the versions
alpnVersions
)

Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiatiation.

public HttpServerOptions
setClientAuth(ClientAuth
One of "NONE, REQUEST, REQUIRED". If it's set to "REQUIRED" then server will require the SSL cert to be presented otherwise it won't accept the request. If it's set to "REQUEST" then it won't mandate the certificate to be presented, basically make it optional.
clientAuth
)

Overrides io.vertx.core.net.NetServerOptions.setClientAuth.

Set whether client auth is required

public HttpServerOptions

Returns:

a reference to this, so the API can be used fluently
setCompressionLevel
(int
integer 1-9, 1 means use fastest algorithm, 9 slower algorithm but better compression ratio
compressionLevel
)

This method allows to set the compression level to be used in http1.x/2 response bodies when compression support is turned on 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. more dictionary lookups and loops.

public HttpServerOptions

Returns:

a reference to this, so the API can be used fluently
setCompressionSupported
(boolean
true to enable compression support
compressionSupported
)

Set whether the server should support gzip/deflate compression (serving compressed responses to clients advertising support for them with Accept-Encoding header)

public HttpServerOptions

Returns:

a reference to this, so the API can be used fluently
setCompressors
(List<CompressionOptions>
the list of compressors
compressors
)

Set the list of compressor to use instead of using the default gzip/deflate setCompressionLevel(int) configuration.

public HttpServerOptions

Returns:

a reference to this, so the API can be used fluently
setDecoderInitialBufferSize
(int
the initial size
decoderInitialBufferSize
)

Set the initial buffer size for the HTTP decoder

public HttpServerOptions

Returns:

a reference to this, so the API can be used fluently
setDecompressionSupported
(boolean
true if decompression supported
decompressionSupported
)

Set whether the server supports decompression

public HttpServerOptions
setEnabledSecureTransportProtocols(Set<String>
the SSL/TLS protocols to enable
enabledSecureTransportProtocols
)

Overrides io.vertx.core.net.NetServerOptions.setEnabledSecureTransportProtocols.

Sets the list of enabled SSL/TLS protocols.

public HttpServerOptions

Returns:

a reference to this, so the API can be used fluently
setHandle100ContinueAutomatically
(boolean
true if it should be handled automatically
handle100ContinueAutomatically
)

Set whether 100 Continue should be handled automatically

public HttpServerOptions
setHost(String
the host
host
)

Overrides io.vertx.core.net.NetServerOptions.setHost.

Set the host

public HttpServerOptions

Returns:

a reference to this, so the API can be used fluently
setHttp2ClearTextEnabled
(boolean
whether to accept HTTP/2 over clear text
http2ClearTextEnabled
)

Set whether HTTP/2 over clear text is enabled or disabled, default is enabled.

public HttpServerOptions

Returns:

a reference to this, so the API can be used fluently
setHttp2ConnectionWindowSize
(int
the window size applied to the connection
http2ConnectionWindowSize
)

Set the default HTTP/2 connection window size.

public HttpServerOptions

Returns:

a reference to this, so the API can be used fluently
setHttp2RstFloodMaxRstFramePerWindow
(int
the new maximum
http2RstFloodMaxRstFramePerWindow
)

Set the max number of RST frame allowed per time window, this is used to prevent HTTP/2 RST frame flood DDOS attacks.

public HttpServerOptions

Returns:

a reference to this, so the API can be used fluently
setHttp2RstFloodWindowDuration
(int
the new duration
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.

public HttpServerOptions

Returns:

a reference to this, so the API can be used fluently
setHttp2RstFloodWindowDurationTimeUnit
(TimeUnit
the new duration
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.

public HttpServerOptions
setIdleTimeout(int
the timeout
idleTimeout
)

Overrides io.vertx.core.net.NetServerOptions.setIdleTimeout.

Set the idle timeout, default time unit is seconds.

public HttpServerOptions
setIdleTimeoutUnit(TimeUnit
specify time unit.
idleTimeoutUnit
)

Overrides io.vertx.core.net.NetServerOptions.setIdleTimeoutUnit.

Set the idle timeout unit.

public HttpServerOptions

Returns:

a reference to this, so the API can be used fluently
setInitialSettings
(Http2Settings
the settings value
settings
)

Set the HTTP/2 connection settings immediatly sent by the server when a client connects.

public HttpServerOptions
public HttpServerOptions
setKeyCertOptions(KeyCertOptions
the key store options
options
)

Overrides io.vertx.core.net.NetServerOptions.setKeyCertOptions.

Set the key/cert options.

public HttpServerOptions
setKeyStoreOptions(JksOptions
the key store in jks format
options
)

Overrides io.vertx.core.net.NetServerOptions.setKeyStoreOptions.

Deprecated

Set the key/cert options in jks format, aka Java keystore.

public HttpServerOptions
setLogActivity(boolean
true for logging the network activity
logEnabled
)

Overrides io.vertx.core.net.NetServerOptions.setLogActivity.

Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

public HttpServerOptions

Returns:

a reference to this, so the API can be used fluently
setMaxChunkSize
(int
the maximum chunk size
maxChunkSize
)

Set the maximum HTTP chunk size that HttpServerRequest#handler(Handler) will receive

public HttpServerOptions

Returns:

a reference to this, so the API can be used fluently
setMaxFormAttributeSize
(int
the new maximum size
maxSize
)

Set the maximum size of a form attribute.

public HttpServerOptions

Returns:

a reference to this, so the API can be used fluently
setMaxFormBufferedBytes
(int
the new maximum
maxFormBufferedBytes
)

Set the maximum number of bytes a server can buffer when decoding a form.

public HttpServerOptions

Returns:

a reference to this, so the API can be used fluently
setMaxFormFields
(int
the new maximum
maxFormFields
)

Set the maximum number of fields of a form.

public HttpServerOptions

Returns:

a reference to this, so the API can be used fluently
setMaxHeaderSize
(int
the new maximum length
maxHeaderSize
)

Set the maximum length of all headers for HTTP/1.x .

public HttpServerOptions

Returns:

a reference to this, so the API can be used fluently
setMaxInitialLineLength
(int
the new maximum initial length
maxInitialLineLength
)

Set the maximum length of the initial line for HTTP/1.x (e.g. "GET / HTTP/1.0")

public HttpServerOptions

Returns:

a reference to this, so the API can be used fluently
setMaxWebSocketFrameSize
(int
the maximum frame size in bytes.
maxWebSocketFrameSize
)

Set the maximum WebSocket frames size

public HttpServerOptions

Returns:

a reference to this, so the API can be used fluently
setMaxWebSocketMessageSize
(int
the maximum message size in bytes.
maxWebSocketMessageSize
)

Set the maximum WebSocket message size

public HttpServerOptions
public HttpServerOptions
setPemKeyCertOptions(PemKeyCertOptions
the options in pem format
options
)

Overrides io.vertx.core.net.NetServerOptions.setPemKeyCertOptions.

Deprecated

Set the key/cert store options in pem format.

public HttpServerOptions
setPemTrustOptions(PemTrustOptions
the trust options in pem format
options
)

Overrides io.vertx.core.net.NetServerOptions.setPemTrustOptions.

Deprecated

Set the trust options in pem format

public HttpServerOptions

Returns:

a reference to this, so the API can be used fluently
setPerFrameWebSocketCompressionSupported
(boolean
true when the per-frame deflate compression extension is supported
supported
)

Enable or disable support for the WebSocket per-frame deflate compression extension.

public HttpServerOptions

Returns:

a reference to this, so the API can be used fluently
setPerMessageWebSocketCompressionSupported
(boolean
true when the per-message WebSocket compression extension is supported
supported
)

Enable or disable support for WebSocket per-message deflate compression extension.

public HttpServerOptions
setPfxKeyCertOptions(PfxOptions
the key cert options in pfx format
options
)

Overrides io.vertx.core.net.NetServerOptions.setPfxKeyCertOptions.

Deprecated

Set the key/cert options in pfx format.

public HttpServerOptions
setPfxTrustOptions(PfxOptions
the trust options in pfx format
options
)

Overrides io.vertx.core.net.NetServerOptions.setPfxTrustOptions.

Deprecated

Set the trust options in pfx format

public HttpServerOptions
setPort(int
the port
port
)

Overrides io.vertx.core.net.NetServerOptions.setPort.

Set the port

public HttpServerOptions
setProxyProtocolTimeout(long
the Proxy protocol timeout to set
proxyProtocolTimeout
)

Overrides io.vertx.core.net.NetServerOptions.setProxyProtocolTimeout.

Set the Proxy protocol timeout, default time unit is seconds.

public HttpServerOptions
setProxyProtocolTimeoutUnit(TimeUnit
specify time unit.
proxyProtocolTimeoutUnit
)

Overrides io.vertx.core.net.NetServerOptions.setProxyProtocolTimeoutUnit.

Set the Proxy protocol timeout unit.

public HttpServerOptions
setReadIdleTimeout(int
the read timeout
idleTimeout
)

Overrides io.vertx.core.net.NetServerOptions.setReadIdleTimeout.

Set the read idle timeout, default time unit is seconds.

public HttpServerOptions
setReceiveBufferSize(int
the buffers size, in bytes
receiveBufferSize
)

Overrides io.vertx.core.net.NetServerOptions.setReceiveBufferSize.

Set the TCP receive buffer size

public HttpServerOptions

Returns:

a reference to this, so the API can be used fluently
setRegisterWebSocketWriteHandlers
(boolean
true to register write-handlers
registerWebSocketWriteHandlers
)

Whether write-handlers for server websockets should be registered on the io.vertx.core.eventbus.EventBus.

public HttpServerOptions
setRegisterWriteHandler(boolean
true to register a write-handler
registerWriteHandler
)

Overrides io.vertx.core.net.NetServerOptions.setRegisterWriteHandler.

Has no effect on HTTP server options.

public HttpServerOptions
setReuseAddress(boolean
the value of reuse address
reuseAddress
)

Overrides io.vertx.core.net.NetServerOptions.setReuseAddress.

Set the value of reuse address

public HttpServerOptions
setReusePort(boolean
the value of reuse port
reusePort
)

Overrides io.vertx.core.net.NetServerOptions.setReusePort.

Set the value of reuse port.

public HttpServerOptions
setSendBufferSize(int
the buffers size, in bytes
sendBufferSize
)

Overrides io.vertx.core.net.NetServerOptions.setSendBufferSize.

Set the TCP send buffer size

public HttpServerOptions
setSni(boolean sni)

Overrides io.vertx.core.net.NetServerOptions.setSni.

Set whether the server supports Server Name Indiciation

public HttpServerOptions
setSoLinger(int
true if SO_linger is enabled
soLinger
)

Overrides io.vertx.core.net.NetServerOptions.setSoLinger.

Set whether SO_linger keep alive is enabled

public HttpServerOptions
setSsl(boolean
true if enabled
ssl
)

Overrides io.vertx.core.net.NetServerOptions.setSsl.

Set whether SSL/TLS is enabled

public HttpServerOptions
setSslEngineOptions(SSLEngineOptions
the ssl engine to use
sslEngineOptions
)

Overrides io.vertx.core.net.NetServerOptions.setSslEngineOptions.

Set to use SSL engine implementation to use.

public HttpServerOptions
setSslHandshakeTimeout(long
the SSL handshake timeout to set, in milliseconds
sslHandshakeTimeout
)

Overrides io.vertx.core.net.NetServerOptions.setSslHandshakeTimeout.

Set the SSL handshake timeout, default time unit is seconds.

public HttpServerOptions
setSslHandshakeTimeoutUnit(TimeUnit
specify time unit.
sslHandshakeTimeoutUnit
)

Overrides io.vertx.core.net.NetServerOptions.setSslHandshakeTimeoutUnit.

Set the SSL handshake timeout unit.

public HttpServerOptions
setTcpCork(boolean
the cork value
tcpCork
)

Overrides io.vertx.core.net.NetServerOptions.setTcpCork.

Enable the TCP_CORK option - only with linux native transport.

public HttpServerOptions
setTcpFastOpen(boolean
the fast open value
tcpFastOpen
)

Overrides io.vertx.core.net.NetServerOptions.setTcpFastOpen.

Enable the TCP_FASTOPEN option - only with linux native transport.

public HttpServerOptions
setTcpKeepAlive(boolean
true if TCP keep alive is enabled
tcpKeepAlive
)

Overrides io.vertx.core.net.NetServerOptions.setTcpKeepAlive.

Set whether TCP keep alive is enabled

public HttpServerOptions
setTcpNoDelay(boolean
true if TCP no delay is enabled (Nagle disabled)
tcpNoDelay
)

Overrides io.vertx.core.net.NetServerOptions.setTcpNoDelay.

Set whether TCP no delay is enabled

public HttpServerOptions
setTcpQuickAck(boolean
the quick ack value
tcpQuickAck
)

Overrides io.vertx.core.net.NetServerOptions.setTcpQuickAck.

Enable the TCP_QUICKACK option - only with linux native transport.

public HttpServerOptions

Returns:

a reference to this, so the API can be used fluently
setTracingPolicy
(TracingPolicy
the tracing policy
tracingPolicy
)

Set the tracing policy for the server behavior when Vert.x has tracing enabled.

public HttpServerOptions
setTrafficClass(int
the value of traffic class
trafficClass
)

Overrides io.vertx.core.net.NetServerOptions.setTrafficClass.

Set the value of traffic class

public HttpServerOptions
setTrafficShapingOptions(TrafficShapingOptions
options used by traffic handler
trafficShapingOptions
)

Overrides io.vertx.core.net.NetServerOptions.setTrafficShapingOptions.

Set traffic shaping options.

public HttpServerOptions
setTrustOptions(TrustOptions
the trust options
options
)

Overrides io.vertx.core.net.NetServerOptions.setTrustOptions.

Set the trust options.

public HttpServerOptions
setTrustStoreOptions(JksOptions
the trust options in jks format
options
)

Overrides io.vertx.core.net.NetServerOptions.setTrustStoreOptions.

Deprecated

Set the trust options in jks format, aka Java truststore

public HttpServerOptions
setUseAlpn(boolean
true when Application-Layer Protocol Negotiation should be used
useAlpn
)

Overrides io.vertx.core.net.NetServerOptions.setUseAlpn.

Set the ALPN usage.

public HttpServerOptions
setUseProxyProtocol(boolean useProxyProtocol)

Overrides io.vertx.core.net.NetServerOptions.setUseProxyProtocol.

Set whether the server uses the HA Proxy protocol

public HttpServerOptions

Returns:

a reference to this, so the API can be used fluently
setWebSocketAllowServerNoContext
(boolean
true to accept the server_no_context_takeover parameter when the client offers it
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.

public HttpServerOptions

Returns:

a reference to this, so the API can be used fluently
setWebSocketClosingTimeout
(int
the timeout is seconds
webSocketClosingTimeout
)

Set the amount of time a server WebSocket will wait until it closes the TCP connection after sending a close frame.

public HttpServerOptions

Returns:

a reference to this, so the API can be used fluently
setWebSocketCompressionLevel
(int
the compression level
compressionLevel
)

Set the WebSocket compression level.

public HttpServerOptions

Returns:

a reference to this, so the API can be used fluently
setWebSocketPreferredClientNoContext
(boolean
true to accept the client_no_context_takeover parameter when the client offers it
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.

public HttpServerOptions

Returns:

a reference to this, so the API can be used fluently
setWebSocketSubProtocols
(List<String>
comma separated list of sub-protocols
subProtocols
)

Set the WebSocket list of sub-protocol supported by the server.

public HttpServerOptions
setWriteIdleTimeout(int
the write timeout
idleTimeout
)

Overrides io.vertx.core.net.NetServerOptions.setWriteIdleTimeout.

Set the write idle timeout, default time unit is seconds.

public JsonObject

Returns:

the JSON
toJson
()

Overrides io.vertx.core.net.NetServerOptions.toJson.

References Deprecated JsonObject is deprecated or references (maybe indirectly) at least one deprecated element.

Convert to JSON

Inherited from io.vertx.core.net.NetServerOptions:
getAcceptBackloggetClientAuthgetHostgetPortgetProxyProtocolTimeoutgetProxyProtocolTimeoutUnitgetTrafficShapingOptionsisSniisUseProxyProtocol