moduleio.vertx.ceylon.core3.5.0 (jvm)
io.vertx.ceylon.core.http
classHttpServerOptions
extends NetServerOptions
satisfies BaseDataObject
OverviewPackageInitializerAttributesMethods

Represents options used by an HttpServer instance

no subtypes hierarchy

Initializer
HttpServerOptions(Integer? acceptBacklog = null, Boolean? acceptUnmaskedFrames = null, {HttpVersion*}? alpnVersions = null, ClientAuth? clientAuth = null, Boolean? clientAuthRequired = null, Integer? compressionLevel = null, Boolean? compressionSupported = null, {String*}? crlPaths = null, Integer? decoderInitialBufferSize = null, Boolean? decompressionSupported = null, {String*}? enabledCipherSuites = null, {String*}? enabledSecureTransportProtocols = null, Boolean? handle100ContinueAutomatically = null, String? host = null, Integer? http2ConnectionWindowSize = null, Integer? idleTimeout = null, Http2Settings? initialSettings = null, JdkSSLEngineOptions? jdkSslEngineOptions = null, JksOptions? keyStoreOptions = null, Boolean? logActivity = null, Integer? maxChunkSize = null, Integer? maxHeaderSize = null, Integer? maxInitialLineLength = null, Integer? maxWebsocketFrameSize = null, Integer? maxWebsocketMessageSize = null, OpenSSLEngineOptions? openSslEngineOptions = null, PemKeyCertOptions? pemKeyCertOptions = null, PemTrustOptions? pemTrustOptions = null, PfxOptions? pfxKeyCertOptions = null, PfxOptions? pfxTrustOptions = null, Integer? port = null, Integer? receiveBufferSize = null, Boolean? reuseAddress = null, Boolean? reusePort = null, Integer? sendBufferSize = null, Boolean? sni = null, Integer? soLinger = null, Boolean? ssl = null, Boolean? tcpCork = null, Boolean? tcpFastOpen = null, Boolean? tcpKeepAlive = null, Boolean? tcpNoDelay = null, Boolean? tcpQuickAck = null, Integer? trafficClass = null, JksOptions? trustStoreOptions = null, Boolean? useAlpn = null, Boolean? usePooledBuffers = null, String? websocketSubProtocols = null)
Parameters:
  • acceptBacklog = null
  • acceptUnmaskedFrames = null

    Set true when the server accepts unmasked frame. As default Server doesn't accept unmasked frame, you can bypass this behaviour (RFC 6455) setting true It's set to false as default.

  • alpnVersions = null

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

  • clientAuth = null
  • clientAuthRequired = null
  • compressionLevel = null

    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. more dictionary lookups and loops.

    E.g. you have it set fairly high on a high-volume website, you may experience performance degradation and latency on resource serving due to CPU overload, and, however - as the computational work is required also client side while decompressing - setting an higher compression level can result in an overall higher page load time especially nowadays when many clients are handled mobile devices with a low CPU profile.

    see also: http://www.gzip.org/algorithm.txt

  • compressionSupported = null

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

  • crlPaths = null
  • decoderInitialBufferSize = null

    Set the initial buffer size for the HTTP decoder

  • decompressionSupported = null

    Set whether the server supports decompression

  • enabledCipherSuites = null
  • enabledSecureTransportProtocols = null
  • handle100ContinueAutomatically = null

    Set whether 100 Continue should be handled automatically

  • host = null
  • http2ConnectionWindowSize = null

    Set the default HTTP/2 connection window size. It overrides the initial window size set by getInitialWindowSize, so the connection window size is greater than for its streams, in order the data throughput.

    A value of -1 reuses the initial window size setting.

  • idleTimeout = null
  • initialSettings = null

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

  • jdkSslEngineOptions = null
  • keyStoreOptions = null
  • logActivity = null
  • maxChunkSize = null

    Set the maximum HTTP chunk size

  • maxHeaderSize = null

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

  • maxInitialLineLength = null

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

  • maxWebsocketFrameSize = null

    Set the maximum websocket frames size

  • maxWebsocketMessageSize = null

    Set the maximum websocket message size

  • openSslEngineOptions = null
  • pemKeyCertOptions = null
  • pemTrustOptions = null
  • pfxKeyCertOptions = null
  • pfxTrustOptions = null
  • port = null
  • receiveBufferSize = null
  • reuseAddress = null
  • reusePort = null
  • sendBufferSize = null
  • sni = null
  • soLinger = null
  • ssl = null
  • tcpCork = null
  • tcpFastOpen = null
  • tcpKeepAlive = null
  • tcpNoDelay = null
  • tcpQuickAck = null
  • trafficClass = null
  • trustStoreOptions = null
  • useAlpn = null
  • usePooledBuffers = null
  • websocketSubProtocols = null

    Set the websocket subprotocols supported by the server.

Attributes
acceptUnmaskedFramesshared Boolean? acceptUnmaskedFrames

Set true when the server accepts unmasked frame. As default Server doesn't accept unmasked frame, you can bypass this behaviour (RFC 6455) setting true It's set to false as default.

alpnVersionsshared {HttpVersion*}? alpnVersions

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

compressionLevelshared Integer? 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. more dictionary lookups and loops.

E.g. you have it set fairly high on a high-volume website, you may experience performance degradation and latency on resource serving due to CPU overload, and, however - as the computational work is required also client side while decompressing - setting an higher compression level can result in an overall higher page load time especially nowadays when many clients are handled mobile devices with a low CPU profile.

see also: http://www.gzip.org/algorithm.txt

compressionSupportedshared Boolean? compressionSupported

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

decoderInitialBufferSizeshared Integer? decoderInitialBufferSize

Set the initial buffer size for the HTTP decoder

decompressionSupportedshared Boolean? decompressionSupported

Set whether the server supports decompression

handle100ContinueAutomaticallyshared Boolean? handle100ContinueAutomatically

Set whether 100 Continue should be handled automatically

http2ConnectionWindowSizeshared Integer? http2ConnectionWindowSize

Set the default HTTP/2 connection window size. It overrides the initial window size set by getInitialWindowSize, so the connection window size is greater than for its streams, in order the data throughput.

A value of -1 reuses the initial window size setting.

initialSettingsshared Http2Settings? initialSettings

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

maxChunkSizeshared Integer? maxChunkSize

Set the maximum HTTP chunk size

maxHeaderSizeshared Integer? maxHeaderSize

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

maxInitialLineLengthshared Integer? maxInitialLineLength

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

maxWebsocketFrameSizeshared Integer? maxWebsocketFrameSize

Set the maximum websocket frames size

maxWebsocketMessageSizeshared Integer? maxWebsocketMessageSize

Set the maximum websocket message size

websocketSubProtocolsshared String? websocketSubProtocols

Set the websocket subprotocols supported by the server.

Inherited Attributes
Attributes inherited from: NetServerOptions
acceptBacklog, clientAuth, clientAuthRequired, host, port, sni
Attributes inherited from: NetworkOptions
logActivity, receiveBufferSize, reuseAddress, reusePort, sendBufferSize, trafficClass
Attributes inherited from: Object
hash, string
Attributes inherited from: TCPSSLOptions
crlPaths, enabledCipherSuites, enabledSecureTransportProtocols, idleTimeout, jdkSslEngineOptions, keyStoreOptions, openSslEngineOptions, pemKeyCertOptions, pemTrustOptions, pfxKeyCertOptions, pfxTrustOptions, soLinger, ssl, tcpCork, tcpFastOpen, tcpKeepAlive, tcpNoDelay, tcpQuickAck, trustStoreOptions, useAlpn, usePooledBuffers
Methods
toJsonshared actual default JsonObject toJson()
Refines NetServerOptions.toJson ultimately refines BaseDataObject.toJson
Inherited Methods
Methods inherited from: NetServerOptions
toJson()
Methods inherited from: NetworkOptions
toJson()
Methods inherited from: Object
equals
Methods inherited from: TCPSSLOptions
toJson()
Methods inherited from: BaseDataObject
toJson