vertx-lang-scala-docs_2.12 3.8.0 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package core
  Definition Classes
    scala
-  package http
  Definition Classes
    core
- GoAway
- Http2Settings
- HttpClient
- HttpClientOptions
- HttpClientRequest
- HttpClientResponse
- HttpConnection
- HttpFrame
- HttpServer
- HttpServerFileUpload
- HttpServerOptions
- HttpServerRequest
- HttpServerResponse
- RequestOptions
- ServerWebSocket
- StreamPriority
- WebSocket
- WebSocketBase
- WebSocketConnectOptions
- WebSocketFrame

c

io.vertx.scala.core.http

# HttpServerOptions 

###
Companion object HttpServerOptions

#### class HttpServerOptions extends NetServerOptions

Represents options used by an io.vertx.scala.core.http.HttpServer instance

Linear Supertypes
NetServerOptions, TCPSSLOptions, NetworkOptions, AnyRef, Any
Known Subclasses
HttpTermOptions
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. HttpServerOptions
2. NetServerOptions
3. TCPSSLOptions
4. NetworkOptions
5. AnyRef
6. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new HttpServerOptions(_asJava: core.http.HttpServerOptions)

### Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##(): Int
   Definition Classes
     AnyRef → Any
3.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
4.  def addCrlPath(value: String): HttpServerOptions

   Add a CRL path

   Add a CRL path

   Definition Classes
     HttpServerOptions → NetServerOptions → TCPSSLOptions
5.  def addCrlValue(value: Buffer): HttpServerOptions

   Add a CRL value

   Add a CRL value

   Definition Classes
     HttpServerOptions → NetServerOptions → TCPSSLOptions
6.  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
7.  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
8.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
9.  def asJava: core.http.HttpServerOptions
   Definition Classes
     HttpServerOptions → NetServerOptions
10.  def clone(): AnyRef
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @native() @throws( ... )
11.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
12.  def equals(arg0: Any): Boolean
    Definition Classes
      AnyRef → Any
13.  def finalize(): Unit
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )
14.  def getAcceptBacklog: Int
    Definition Classes
      HttpServerOptions → NetServerOptions
15.  def getAlpnVersions: Buffer[HttpVersion]
16.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
17.  def getClientAuth: ClientAuth
    Definition Classes
      HttpServerOptions → NetServerOptions
18.  def getCompressionLevel: Int
19.  def getCrlPaths: Buffer[String]
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
20.  def getCrlValues: Buffer[Buffer]
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
21.  def getDecoderInitialBufferSize: Int
22.  def getEnabledCipherSuites: Set[String]
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
23.  def getEnabledSecureTransportProtocols: Set[String]
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
24.  def getHost: String
    Definition Classes
      HttpServerOptions → NetServerOptions
25.  def getHttp2ConnectionWindowSize: Int
26.  def getIdleTimeout: Int
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
27.  def getIdleTimeoutUnit: TimeUnit
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
28.  def getInitialSettings: Http2Settings
29.  def getJdkSslEngineOptions: JdkSSLEngineOptions
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
30.  def getKeyStoreOptions: JksOptions
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
31.  def getLogActivity: Boolean
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
32.  def getMaxChunkSize: Int
33.  def getMaxHeaderSize: Int
34.  def getMaxInitialLineLength: Int
35.  def getMaxWebsocketFrameSize: Int
36.  def getMaxWebsocketMessageSize: Int
37.  def getOpenSslEngineOptions: OpenSSLEngineOptions
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
38.  def getPemKeyCertOptions: PemKeyCertOptions
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
39.  def getPemTrustOptions: PemTrustOptions
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
40.  def getPerFrameWebsocketCompressionSupported: Boolean
41.  def getPerMessageWebsocketCompressionSupported: Boolean
42.  def getPfxKeyCertOptions: PfxOptions
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
43.  def getPfxTrustOptions: PfxOptions
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
44.  def getPort: Int
    Definition Classes
      HttpServerOptions → NetServerOptions
45.  def getReceiveBufferSize: Int
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
46.  def getSendBufferSize: Int
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
47.  def getSoLinger: Int
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
48.  def getSslHandshakeTimeout: Long
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
49.  def getSslHandshakeTimeoutUnit: TimeUnit
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
50.  def getTrafficClass: Int
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
51.  def getTrustStoreOptions: JksOptions
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
52.  def getWebsocketAllowServerNoContext: Boolean
53.  def getWebsocketCompressionLevel: Int
54.  def getWebsocketPreferredClientNoContext: Boolean
55.  def getWebsocketSubProtocols: String
56.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
57.  def isAcceptUnmaskedFrames: Boolean
58.  def isClientAuthRequired: Boolean
    Definition Classes
      HttpServerOptions → NetServerOptions
59.  def isCompressionSupported: Boolean
60.  def isDecompressionSupported: Boolean
61.  def isHandle100ContinueAutomatically: Boolean
62.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
63.  def isReuseAddress: Boolean
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
64.  def isReusePort: Boolean
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
65.  def isSni: Boolean
    Definition Classes
      HttpServerOptions → NetServerOptions
66.  def isSsl: Boolean
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
67.  def isTcpCork: Boolean
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
68.  def isTcpFastOpen: Boolean
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
69.  def isTcpKeepAlive: Boolean
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
70.  def isTcpNoDelay: Boolean
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
71.  def isTcpQuickAck: Boolean
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
72.  def isUseAlpn: Boolean
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
73.  def isUsePooledBuffers: Boolean
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
74.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
75.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
76.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
77.  def setAcceptBacklog(value: Int): HttpServerOptions

    Set the accept back log

    Set the accept back log

    Definition Classes
      HttpServerOptions → NetServerOptions
78.  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.

79.  def setAlpnVersions(value: Buffer[HttpVersion]): HttpServerOptions

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

80.  def setClientAuth(value: ClientAuth): HttpServerOptions

    Set whether client auth is required

    Set whether client auth is required

    Definition Classes
      HttpServerOptions → NetServerOptions
81.  def setClientAuthRequired(value: Boolean): HttpServerOptions

    Set whether client auth is required

    Set whether client auth is required

    Definition Classes
      HttpServerOptions → NetServerOptions
82.  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 the `Accept-Encoding` header

    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

83.  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)

84.  def setDecoderInitialBufferSize(value: Int): HttpServerOptions

    Set the initial buffer size for the HTTP decoder

85.  def setDecompressionSupported(value: Boolean): HttpServerOptions

    Set whether the server supports decompression

86.  def setEnabledSecureTransportProtocols(value: Set[String]): HttpServerOptions
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
87.  def setHandle100ContinueAutomatically(value: Boolean): HttpServerOptions

    Set whether 100 Continue should be handled automatically

88.  def setHost(value: String): HttpServerOptions

    Set the host

    Set the host

    Definition Classes
      HttpServerOptions → NetServerOptions
89.  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.

90.  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
91.  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
92.  def setInitialSettings(value: Http2Settings): HttpServerOptions

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

93.  def setJdkSslEngineOptions(value: JdkSSLEngineOptions): HttpServerOptions
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
94.  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
95.  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
96.  def setMaxChunkSize(value: Int): HttpServerOptions

    Set the maximum HTTP chunk size that io.vertx.scala.core.http.HttpServerRequest will receive

97.  def setMaxHeaderSize(value: Int): HttpServerOptions

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

98.  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"`)

99.  def setMaxWebsocketFrameSize(value: Int): HttpServerOptions

    Set the maximum WebSocket frames size

100.  def setMaxWebsocketMessageSize(value: Int): HttpServerOptions

     Set the maximum WebSocket message size

101.  def setOpenSslEngineOptions(value: OpenSSLEngineOptions): HttpServerOptions
     Definition Classes
       HttpServerOptions → NetServerOptions → TCPSSLOptions
102.  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
103.  def setPemTrustOptions(value: PemTrustOptions): HttpServerOptions

     Set the trust options in pem format

     Set the trust options in pem format

     Definition Classes
       HttpServerOptions → NetServerOptions → TCPSSLOptions
104.  def setPerFrameWebsocketCompressionSupported(value: Boolean): HttpServerOptions

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

105.  def setPerMessageWebsocketCompressionSupported(value: Boolean): HttpServerOptions

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

106.  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
107.  def setPfxTrustOptions(value: PfxOptions): HttpServerOptions

     Set the trust options in pfx format

     Set the trust options in pfx format

     Definition Classes
       HttpServerOptions → NetServerOptions → TCPSSLOptions
108.  def setPort(value: Int): HttpServerOptions

     Set the port

     Set the port

     Definition Classes
       HttpServerOptions → NetServerOptions
109.  def setReceiveBufferSize(value: Int): HttpServerOptions

     Set the TCP receive buffer size

     Set the TCP receive buffer size

     Definition Classes
       HttpServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
110.  def setReuseAddress(value: Boolean): HttpServerOptions

     Set the value of reuse address

     Set the value of reuse address

     Definition Classes
       HttpServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
111.  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
112.  def setSendBufferSize(value: Int): HttpServerOptions

     Set the TCP send buffer size

     Set the TCP send buffer size

     Definition Classes
       HttpServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
113.  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
114.  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
115.  def setSsl(value: Boolean): HttpServerOptions

     Set whether SSL/TLS is enabled

     Set whether SSL/TLS is enabled

     Definition Classes
       HttpServerOptions → NetServerOptions → TCPSSLOptions
116.  def setSslHandshakeTimeout(value: Long): HttpServerOptions

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

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

     Definition Classes
       HttpServerOptions → NetServerOptions → TCPSSLOptions
117.  def setSslHandshakeTimeoutUnit(value: TimeUnit): HttpServerOptions

     Set the SSL handshake timeout unit.

     Set the SSL handshake timeout unit. If not specified, default is seconds.

     Definition Classes
       HttpServerOptions → NetServerOptions → TCPSSLOptions
118.  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
119.  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
120.  def setTcpKeepAlive(value: Boolean): HttpServerOptions

     Set whether TCP keep alive is enabled

     Set whether TCP keep alive is enabled

     Definition Classes
       HttpServerOptions → NetServerOptions → TCPSSLOptions
121.  def setTcpNoDelay(value: Boolean): HttpServerOptions

     Set whether TCP no delay is enabled

     Set whether TCP no delay is enabled

     Definition Classes
       HttpServerOptions → NetServerOptions → TCPSSLOptions
122.  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
123.  def setTrafficClass(value: Int): HttpServerOptions

     Set the value of traffic class

     Set the value of traffic class

     Definition Classes
       HttpServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
124.  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
125.  def setUseAlpn(value: Boolean): HttpServerOptions

     Set the ALPN usage.

     Set the ALPN usage.

     Definition Classes
       HttpServerOptions → NetServerOptions → TCPSSLOptions
126.  def setUsePooledBuffers(value: Boolean): HttpServerOptions

     Set whether Netty pooled buffers are enabled

     Set whether Netty pooled buffers are enabled

     Definition Classes
       HttpServerOptions → NetServerOptions → TCPSSLOptions
127.  def setWebsocketAllowServerNoContext(value: Boolean): HttpServerOptions

     Set whether the WebSocket server will accept the `server_no_context_takeover` parameter of the per-message deflate compression extension offered by the client.

128.  def setWebsocketCompressionLevel(value: Int): HttpServerOptions

     Set the WebSocket compression level.

129.  def setWebsocketPreferredClientNoContext(value: Boolean): HttpServerOptions

     Set whether the WebSocket server will accept the `client_no_context_takeover` parameter of the per-message deflate compression extension offered by the client.

130.  def setWebsocketSubProtocols(value: String): HttpServerOptions

     Set the WebSocket sub-protocols supported by the server.

131.  final def synchronized[T0](arg0: ⇒ T0): T0
     Definition Classes
       AnyRef
132.  def toString(): String
     Definition Classes
       AnyRef → Any
133.  final def wait(): Unit
     Definition Classes
       AnyRef
     Annotations
       @throws( ... )
134.  final def wait(arg0: Long, arg1: Int): Unit
     Definition Classes
       AnyRef
     Annotations
       @throws( ... )
135.  final def wait(arg0: Long): Unit
     Definition Classes
       AnyRef
     Annotations
       @native() @throws( ... )

### Inherited from NetServerOptions

### Inherited from TCPSSLOptions

### Inherited from NetworkOptions

### Inherited from AnyRef

### Inherited from Any

### Ungrouped