vertx-lang-scala-docs_2.12 3.4.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
- WebSocket
- WebSocketBase
- 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

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

   Add an enabled SSL/TLS protocols, appended to the ordered 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
      @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
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 getEnabledCipherSuites: Set[String]
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
22.  def getEnabledSecureTransportProtocols: Set[String]
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
23.  def getHost: String
    Definition Classes
      HttpServerOptions → NetServerOptions
24.  def getHttp2ConnectionWindowSize: Int
25.  def getIdleTimeout: Int
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
26.  def getInitialSettings: Http2Settings
27.  def getJdkSslEngineOptions: JdkSSLEngineOptions
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
28.  def getKeyStoreOptions: JksOptions
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
29.  def getLogActivity: Boolean
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
30.  def getMaxChunkSize: Int
31.  def getMaxHeaderSize: Int
32.  def getMaxInitialLineLength: Int
33.  def getMaxWebsocketFrameSize: Int
34.  def getMaxWebsocketMessageSize: Int
35.  def getOpenSslEngineOptions: OpenSSLEngineOptions
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
36.  def getPemKeyCertOptions: PemKeyCertOptions
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
37.  def getPemTrustOptions: PemTrustOptions
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
38.  def getPfxKeyCertOptions: PfxOptions
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
39.  def getPfxTrustOptions: PfxOptions
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
40.  def getPort: Int
    Definition Classes
      HttpServerOptions → NetServerOptions
41.  def getReceiveBufferSize: Int
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
42.  def getSendBufferSize: Int
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
43.  def getSoLinger: Int
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
44.  def getTrafficClass: Int
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
45.  def getTrustStoreOptions: JksOptions
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
46.  def getWebsocketSubProtocols: String
47.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
48.  def isAcceptUnmaskedFrames: Boolean
49.  def isClientAuthRequired: Boolean
    Definition Classes
      HttpServerOptions → NetServerOptions
50.  def isCompressionSupported: Boolean
51.  def isDecompressionSupported: Boolean
52.  def isHandle100ContinueAutomatically: Boolean
53.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
54.  def isReuseAddress: Boolean
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
55.  def isSsl: Boolean
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
56.  def isTcpKeepAlive: Boolean
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
57.  def isTcpNoDelay: Boolean
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
58.  def isUseAlpn: Boolean
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
59.  def isUsePooledBuffers: Boolean
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
60.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
61.  final def notify(): Unit
    Definition Classes
      AnyRef
62.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
63.  def setAcceptBacklog(value: Int): HttpServerOptions

    Set the accept back log

    Set the accept back log

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

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

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

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

    Set whether client auth is required

    Set whether client auth is required

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

    Set whether client auth is required

    Set whether client auth is required

    Definition Classes
      HttpServerOptions → NetServerOptions
68.  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 computatinal 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 comptational 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

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

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

    Set whether the server supports decompression

71.  def setHandle100ContinueAutomatically(value: Boolean): HttpServerOptions

    Set whether 100 Continue should be handled automatically

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

    Set the host

    Set the host

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

74.  def setIdleTimeout(value: Int): HttpServerOptions

    Set the idle timeout, in seconds.

    Set the idle timeout, in seconds. zero means don't timeout. This determines if a connection will timeout and be closed if no data is received within the timeout.

    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
75.  def setInitialSettings(value: Http2Settings): HttpServerOptions

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

76.  def setJdkSslEngineOptions(value: JdkSSLEngineOptions): HttpServerOptions
    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
77.  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
78.  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
79.  def setMaxChunkSize(value: Int): HttpServerOptions

    Set the maximum HTTP chunk size

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

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

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

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

    Set the maximum websocket frames size

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

    Set the maximum websocket message size

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

    Set the trust options in pem format

    Set the trust options in pem format

    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
87.  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
88.  def setPfxTrustOptions(value: PfxOptions): HttpServerOptions

    Set the trust options in pfx format

    Set the trust options in pfx format

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

    Set the port

    Set the port

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

    Set the TCP receive buffer size

    Set the TCP receive buffer size

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

    Set the value of reuse address

    Set the value of reuse address

    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
92.  def setSendBufferSize(value: Int): HttpServerOptions

    Set the TCP send buffer size

    Set the TCP send buffer size

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

    Set whether SSL/TLS is enabled

    Set whether SSL/TLS is enabled

    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
95.  def setTcpKeepAlive(value: Boolean): HttpServerOptions

    Set whether TCP keep alive is enabled

    Set whether TCP keep alive is enabled

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

    Set whether TCP no delay is enabled

    Set whether TCP no delay is enabled

    Definition Classes
      HttpServerOptions → NetServerOptions → TCPSSLOptions
97.  def setTrafficClass(value: Int): HttpServerOptions

    Set the value of traffic class

    Set the value of traffic class

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

    Set the ALPN usage.

    Set the ALPN usage.

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

     Set whether Netty pooled buffers are enabled

     Set whether Netty pooled buffers are enabled

     Definition Classes
       HttpServerOptions → NetServerOptions → TCPSSLOptions
101.  def setWebsocketSubProtocols(value: String): HttpServerOptions

     Set the websocket subprotocols supported by the server.

102.  final def synchronized[T0](arg0: ⇒ T0): T0
     Definition Classes
       AnyRef
103.  def toString(): String
     Definition Classes
       AnyRef → Any
104.  final def wait(): Unit
     Definition Classes
       AnyRef
     Annotations
       @throws( ... )
105.  final def wait(arg0: Long, arg1: Int): Unit
     Definition Classes
       AnyRef
     Annotations
       @throws( ... )
106.  final def wait(arg0: Long): Unit
     Definition Classes
       AnyRef
     Annotations
       @throws( ... )

### Inherited from NetServerOptions

### Inherited from TCPSSLOptions

### Inherited from NetworkOptions

### Inherited from AnyRef

### Inherited from Any

### Ungrouped