class HttpServerOptions extends NetServerOptions
Represents options used by an io.vertx.scala.core.http.HttpServer instance
- Alphabetic
- By Inheritance
- HttpServerOptions
- NetServerOptions
- TCPSSLOptions
- NetworkOptions
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new HttpServerOptions(_asJava: core.http.HttpServerOptions)
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
addCrlPath(value: String): HttpServerOptions
Add a CRL path
Add a CRL path
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
addCrlValue(value: Buffer): HttpServerOptions
Add a CRL value
Add a CRL value
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
addEnabledCipherSuite(value: String): HttpServerOptions
Add an enabled cipher suite, appended to the ordered suites.
Add an enabled cipher suite, appended to the ordered suites.
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
addEnabledSecureTransportProtocol(value: String): HttpServerOptions
Sets the list of enabled SSL/TLS protocols.
Sets the list of enabled SSL/TLS protocols.
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
asJava: core.http.HttpServerOptions
- Definition Classes
- HttpServerOptions → NetServerOptions
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
getAcceptBacklog: Int
- Definition Classes
- HttpServerOptions → NetServerOptions
- def getAlpnVersions: Buffer[HttpVersion]
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getClientAuth: ClientAuth
- Definition Classes
- HttpServerOptions → NetServerOptions
- def getCompressionLevel: Int
-
def
getCrlPaths: Buffer[String]
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
getCrlValues: Buffer[Buffer]
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
- def getDecoderInitialBufferSize: Int
-
def
getEnabledCipherSuites: Set[String]
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
getEnabledSecureTransportProtocols: Set[String]
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
getHost: String
- Definition Classes
- HttpServerOptions → NetServerOptions
- def getHttp2ConnectionWindowSize: Int
-
def
getIdleTimeout: Int
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
getIdleTimeoutUnit: TimeUnit
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
- def getInitialSettings: Http2Settings
-
def
getJdkSslEngineOptions: JdkSSLEngineOptions
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
getKeyStoreOptions: JksOptions
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
getLogActivity: Boolean
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
- def getMaxChunkSize: Int
- def getMaxHeaderSize: Int
- def getMaxInitialLineLength: Int
- def getMaxWebsocketFrameSize: Int
- def getMaxWebsocketMessageSize: Int
-
def
getOpenSslEngineOptions: OpenSSLEngineOptions
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
getPemKeyCertOptions: PemKeyCertOptions
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
getPemTrustOptions: PemTrustOptions
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
getPfxKeyCertOptions: PfxOptions
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
getPfxTrustOptions: PfxOptions
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
getPort: Int
- Definition Classes
- HttpServerOptions → NetServerOptions
-
def
getReceiveBufferSize: Int
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
-
def
getSendBufferSize: Int
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
-
def
getSoLinger: Int
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
getTrafficClass: Int
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
-
def
getTrustStoreOptions: JksOptions
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
- def getWebsocketAllowServerNoContext: Boolean
- def getWebsocketPreferredClientNoContext: Boolean
- def getWebsocketSubProtocols: String
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def isAcceptUnmaskedFrames: Boolean
-
def
isClientAuthRequired: Boolean
- Definition Classes
- HttpServerOptions → NetServerOptions
- def isCompressionSupported: Boolean
- def isDecompressionSupported: Boolean
- def isHandle100ContinueAutomatically: Boolean
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isReuseAddress: Boolean
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
-
def
isReusePort: Boolean
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
-
def
isSni: Boolean
- Definition Classes
- HttpServerOptions → NetServerOptions
-
def
isSsl: Boolean
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
isTcpCork: Boolean
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
isTcpFastOpen: Boolean
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
isTcpKeepAlive: Boolean
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
isTcpNoDelay: Boolean
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
isTcpQuickAck: Boolean
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
isUseAlpn: Boolean
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
isUsePooledBuffers: Boolean
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
setAcceptBacklog(value: Int): HttpServerOptions
Set the accept back log
Set the accept back log
- Definition Classes
- HttpServerOptions → NetServerOptions
-
def
setAcceptUnmaskedFrames(value: Boolean): HttpServerOptions
Set true when the server accepts unmasked frame.
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.
-
def
setAlpnVersions(value: Buffer[HttpVersion]): HttpServerOptions
Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiatiation.
-
def
setClientAuth(value: ClientAuth): HttpServerOptions
Set whether client auth is required
Set whether client auth is required
- Definition Classes
- HttpServerOptions → NetServerOptions
-
def
setClientAuthRequired(value: Boolean): HttpServerOptions
Set whether client auth is required
Set whether client auth is required
- Definition Classes
- HttpServerOptions → NetServerOptions
-
def
setCompressionLevel(value: Int): HttpServerOptions
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 theAccept-Encoding
headerThis 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 theAccept-Encoding
headerdefault 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
-
def
setCompressionSupported(value: Boolean): HttpServerOptions
Set whether the server should support gzip/deflate compression (serving compressed responses to clients advertising support for them with Accept-Encoding header)
-
def
setDecoderInitialBufferSize(value: Int): HttpServerOptions
Set the initial buffer size for the HTTP decoder
-
def
setDecompressionSupported(value: Boolean): HttpServerOptions
Set whether the server supports decompression
-
def
setEnabledSecureTransportProtocols(value: Set[String]): HttpServerOptions
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
setHandle100ContinueAutomatically(value: Boolean): HttpServerOptions
Set whether 100 Continue should be handled automatically
-
def
setHost(value: String): HttpServerOptions
Set the host
Set the host
- Definition Classes
- HttpServerOptions → NetServerOptions
-
def
setHttp2ConnectionWindowSize(value: Int): HttpServerOptions
Set the default HTTP/2 connection window size.
Set the default HTTP/2 connection window size. It overrides the initial window size set by Http2Settings, 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. -
def
setIdleTimeout(value: Int): HttpServerOptions
Set the idle timeout, default time unit is seconds.
Set the idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is received within the timeout.
If you want change default time unit, use HttpServerOptions
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
setIdleTimeoutUnit(value: TimeUnit): HttpServerOptions
Set the idle timeout unit.
Set the idle timeout unit. If not specified, default is seconds.
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
setInitialSettings(value: Http2Settings): HttpServerOptions
Set the HTTP/2 connection settings immediatly sent by the server when a client connects.
-
def
setJdkSslEngineOptions(value: JdkSSLEngineOptions): HttpServerOptions
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
setKeyStoreOptions(value: JksOptions): HttpServerOptions
Set the key/cert options in jks format, aka Java keystore.
Set the key/cert options in jks format, aka Java keystore.
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
setLogActivity(value: Boolean): HttpServerOptions
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
-
def
setMaxChunkSize(value: Int): HttpServerOptions
Set the maximum HTTP chunk size that io.vertx.scala.core.http.HttpServerRequest will receive
-
def
setMaxHeaderSize(value: Int): HttpServerOptions
Set the maximum length of all headers for HTTP/1.x .
-
def
setMaxInitialLineLength(value: Int): HttpServerOptions
Set the maximum length of the initial line for HTTP/1.x (e.g.
Set the maximum length of the initial line for HTTP/1.x (e.g.
"GET / HTTP/1.0"
) -
def
setMaxWebsocketFrameSize(value: Int): HttpServerOptions
Set the maximum websocket frames size
-
def
setMaxWebsocketMessageSize(value: Int): HttpServerOptions
Set the maximum websocket message size
-
def
setOpenSslEngineOptions(value: OpenSSLEngineOptions): HttpServerOptions
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
setPemKeyCertOptions(value: PemKeyCertOptions): HttpServerOptions
Set the key/cert store options in pem format.
Set the key/cert store options in pem format.
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
setPemTrustOptions(value: PemTrustOptions): HttpServerOptions
Set the trust options in pem format
Set the trust options in pem format
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
setPerFrameWebsocketCompressionSupported(value: Boolean): HttpServerOptions
Enable or disable support for WebSocket Defalte Frame compression
-
def
setPerMessageWebsocketCompressionSupported(value: Boolean): HttpServerOptions
Enable or disable support for WebSocket Permessage Deflate compression
-
def
setPfxKeyCertOptions(value: PfxOptions): HttpServerOptions
Set the key/cert options in pfx format.
Set the key/cert options in pfx format.
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
setPfxTrustOptions(value: PfxOptions): HttpServerOptions
Set the trust options in pfx format
Set the trust options in pfx format
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
setPort(value: Int): HttpServerOptions
Set the port
Set the port
- Definition Classes
- HttpServerOptions → NetServerOptions
-
def
setReceiveBufferSize(value: Int): HttpServerOptions
Set the TCP receive buffer size
Set the TCP receive buffer size
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
-
def
setReuseAddress(value: Boolean): HttpServerOptions
Set the value of reuse address
Set the value of reuse address
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
-
def
setReusePort(value: Boolean): HttpServerOptions
Set the value of reuse port.
Set the value of reuse port.
This is only supported by native transports.
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
-
def
setSendBufferSize(value: Int): HttpServerOptions
Set the TCP send buffer size
Set the TCP send buffer size
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
-
def
setSni(value: Boolean): HttpServerOptions
Set whether the server supports Server Name Indiciation
Set whether the server supports Server Name Indiciation
- Definition Classes
- HttpServerOptions → NetServerOptions
-
def
setSoLinger(value: Int): HttpServerOptions
Set whether SO_linger keep alive is enabled
Set whether SO_linger keep alive is enabled
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
setSsl(value: Boolean): HttpServerOptions
Set whether SSL/TLS is enabled
Set whether SSL/TLS is enabled
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
setTcpCork(value: Boolean): HttpServerOptions
Enable the
TCP_CORK
option - only with linux native transport.Enable the
TCP_CORK
option - only with linux native transport.- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
setTcpFastOpen(value: Boolean): HttpServerOptions
Enable the
TCP_FASTOPEN
option - only with linux native transport.Enable the
TCP_FASTOPEN
option - only with linux native transport.- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
setTcpKeepAlive(value: Boolean): HttpServerOptions
Set whether TCP keep alive is enabled
Set whether TCP keep alive is enabled
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
setTcpNoDelay(value: Boolean): HttpServerOptions
Set whether TCP no delay is enabled
Set whether TCP no delay is enabled
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
setTcpQuickAck(value: Boolean): HttpServerOptions
Enable the
TCP_QUICKACK
option - only with linux native transport.Enable the
TCP_QUICKACK
option - only with linux native transport.- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
setTrafficClass(value: Int): HttpServerOptions
Set the value of traffic class
Set the value of traffic class
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
-
def
setTrustStoreOptions(value: JksOptions): HttpServerOptions
Set the trust options in jks format, aka Java truststore
Set the trust options in jks format, aka Java truststore
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
setUseAlpn(value: Boolean): HttpServerOptions
Set the ALPN usage.
Set the ALPN usage.
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
setUsePooledBuffers(value: Boolean): HttpServerOptions
Set whether Netty pooled buffers are enabled
Set whether Netty pooled buffers are enabled
- Definition Classes
- HttpServerOptions → NetServerOptions → TCPSSLOptions
-
def
setWebsocketAllowServerNoContext(value: Boolean): HttpServerOptions
Set the WebSocket Allow Server No Context option
-
def
setWebsocketCompressionLevel(value: Int): HttpServerOptions
Set the WebSocket compression level
-
def
setWebsocketPreferredClientNoContext(value: Boolean): HttpServerOptions
Set the WebSocket Preferred Client No Context setting
-
def
setWebsocketSubProtocols(value: String): HttpServerOptions
Set the websocket subprotocols supported by the server.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )