Represents options used by an HttpServer instance
AnythingHttpServerOptionsBaseDataObjectNetServerOptionsBaseDataObjectTCPSSLOptionsBaseDataObjectNetworkOptionsBaseDataObjectBasicIdentifiableObjectAnythingno 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:
|
| Attributes | |
acceptUnmaskedFrames | shared Boolean? acceptUnmaskedFramesSet 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 | shared {HttpVersion*}? alpnVersionsSet the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiatiation. |
compressionLevel | shared Integer? compressionLevelThis 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 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 | shared Boolean? compressionSupportedSet whether the server should support gzip/deflate compression (serving compressed responses to clients advertising support for them with Accept-Encoding header) |
decoderInitialBufferSize | shared Integer? decoderInitialBufferSizeSet the initial buffer size for the HTTP decoder |
decompressionSupported | shared Boolean? decompressionSupportedSet whether the server supports decompression |
handle100ContinueAutomatically | shared Boolean? handle100ContinueAutomaticallySet whether 100 Continue should be handled automatically |
http2ConnectionWindowSize | shared Integer? http2ConnectionWindowSizeSet 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.
|
initialSettings | shared Http2Settings? initialSettingsSet the HTTP/2 connection settings immediatly sent by the server when a client connects. |
maxChunkSize | shared Integer? maxChunkSizeSet the maximum HTTP chunk size |
maxHeaderSize | shared Integer? maxHeaderSizeSet the maximum length of all headers for HTTP/1.x . |
maxInitialLineLength | shared Integer? maxInitialLineLengthSet the maximum length of the initial line for HTTP/1.x (e.g. |
maxWebsocketFrameSize | shared Integer? maxWebsocketFrameSizeSet the maximum websocket frames size |
maxWebsocketMessageSize | shared Integer? maxWebsocketMessageSizeSet the maximum websocket message size |
websocketSubProtocols | shared String? websocketSubProtocolsSet the websocket subprotocols supported by the server. |
| Inherited Attributes |
Attributes inherited from: NetServerOptions |
Attributes inherited from: NetworkOptions |
Attributes inherited from: Objecthash, string |
Attributes inherited from: TCPSSLOptionscrlPaths, enabledCipherSuites, enabledSecureTransportProtocols, idleTimeout, jdkSslEngineOptions, keyStoreOptions, openSslEngineOptions, pemKeyCertOptions, pemTrustOptions, pfxKeyCertOptions, pfxTrustOptions, soLinger, ssl, tcpCork, tcpFastOpen, tcpKeepAlive, tcpNoDelay, tcpQuickAck, trustStoreOptions, useAlpn, usePooledBuffers |
| Methods | |
toJson | shared actual default JsonObject toJson() |
| Inherited Methods |
Methods inherited from: NetServerOptions |
Methods inherited from: NetworkOptions |
Methods inherited from: Objectequals |
Methods inherited from: TCPSSLOptions |
Methods inherited from: BaseDataObjecttoJson |