class HttpServerOptions extends NetServerOptions

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

Linear Supertypes
Known Subclasses
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
    HttpServerOptionsNetServerOptionsTCPSSLOptions
  5. def addCrlValue(value: Buffer): HttpServerOptions

    Add a CRL value

    Add a CRL value

    Definition Classes
    HttpServerOptionsNetServerOptionsTCPSSLOptions
  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
    HttpServerOptionsNetServerOptionsTCPSSLOptions
  7. def addEnabledSecureTransportProtocol(value: String): HttpServerOptions

    Sets the list of enabled SSL/TLS protocols.

    Sets the list of enabled SSL/TLS protocols.

    Definition Classes
    HttpServerOptionsNetServerOptionsTCPSSLOptions
  8. def addWebSocketSubProtocol(value: String): HttpServerOptions

    Set the WebSocket list of sub-protocol supported by the server.

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

    Set the accept back log

    Set the accept back log

    Definition Classes
    HttpServerOptionsNetServerOptions
  87. 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.

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

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

  89. def setClientAuth(value: ClientAuth): HttpServerOptions

    Set whether client auth is required

    Set whether client auth is required

    Definition Classes
    HttpServerOptionsNetServerOptions
  90. def setClientAuthRequired(value: Boolean): HttpServerOptions

    Set whether client auth is required

    Set whether client auth is required

    Definition Classes
    HttpServerOptionsNetServerOptions
  91. 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

  92. 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)

  93. def setDecoderInitialBufferSize(value: Int): HttpServerOptions

    Set the initial buffer size for the HTTP decoder

  94. def setDecompressionSupported(value: Boolean): HttpServerOptions

    Set whether the server supports decompression

  95. def setEnabledSecureTransportProtocols(value: Set[String]): HttpServerOptions
  96. def setHandle100ContinueAutomatically(value: Boolean): HttpServerOptions

    Set whether 100 Continue should be handled automatically

  97. def setHost(value: String): HttpServerOptions

    Set the host

    Set the host

    Definition Classes
    HttpServerOptionsNetServerOptions
  98. 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.

  99. 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
    HttpServerOptionsNetServerOptionsTCPSSLOptions
  100. def setIdleTimeoutUnit(value: TimeUnit): HttpServerOptions

    Set the idle timeout unit.

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

    Definition Classes
    HttpServerOptionsNetServerOptionsTCPSSLOptions
  101. def setInitialSettings(value: Http2Settings): HttpServerOptions

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

  102. def setJdkSslEngineOptions(value: JdkSSLEngineOptions): HttpServerOptions
  103. 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
    HttpServerOptionsNetServerOptionsTCPSSLOptions
  104. 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
    HttpServerOptionsNetServerOptionsNetworkOptions
  105. def setMaxChunkSize(value: Int): HttpServerOptions

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

  106. def setMaxHeaderSize(value: Int): HttpServerOptions

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

  107. 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")

  108. def setMaxWebSocketFrameSize(value: Int): HttpServerOptions

    Set the maximum WebSocket frames size

  109. def setMaxWebSocketMessageSize(value: Int): HttpServerOptions

    Set the maximum WebSocket message size

  110. def setMaxWebsocketFrameSize(value: Int): HttpServerOptions

    Set the maximum WebSocket frames size

  111. def setMaxWebsocketMessageSize(value: Int): HttpServerOptions

    Set the maximum WebSocket message size

  112. def setOpenSslEngineOptions(value: OpenSSLEngineOptions): HttpServerOptions
  113. 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
    HttpServerOptionsNetServerOptionsTCPSSLOptions
  114. def setPemTrustOptions(value: PemTrustOptions): HttpServerOptions

    Set the trust options in pem format

    Set the trust options in pem format

    Definition Classes
    HttpServerOptionsNetServerOptionsTCPSSLOptions
  115. def setPerFrameWebSocketCompressionSupported(value: Boolean): HttpServerOptions

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

  116. def setPerFrameWebsocketCompressionSupported(value: Boolean): HttpServerOptions

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

  117. def setPerMessageWebSocketCompressionSupported(value: Boolean): HttpServerOptions

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

  118. def setPerMessageWebsocketCompressionSupported(value: Boolean): HttpServerOptions

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

  119. def setPfxKeyCertOptions(value: PfxOptions): HttpServerOptions

    Set the key/cert options in pfx format.

    Set the key/cert options in pfx format.

    Definition Classes
    HttpServerOptionsNetServerOptionsTCPSSLOptions
  120. def setPfxTrustOptions(value: PfxOptions): HttpServerOptions

    Set the trust options in pfx format

    Set the trust options in pfx format

    Definition Classes
    HttpServerOptionsNetServerOptionsTCPSSLOptions
  121. def setPort(value: Int): HttpServerOptions

    Set the port

    Set the port

    Definition Classes
    HttpServerOptionsNetServerOptions
  122. def setReceiveBufferSize(value: Int): HttpServerOptions

    Set the TCP receive buffer size

    Set the TCP receive buffer size

    Definition Classes
    HttpServerOptionsNetServerOptionsNetworkOptions
  123. def setReuseAddress(value: Boolean): HttpServerOptions

    Set the value of reuse address

    Set the value of reuse address

    Definition Classes
    HttpServerOptionsNetServerOptionsNetworkOptions
  124. 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
    HttpServerOptionsNetServerOptionsNetworkOptions
  125. def setSendBufferSize(value: Int): HttpServerOptions

    Set the TCP send buffer size

    Set the TCP send buffer size

    Definition Classes
    HttpServerOptionsNetServerOptionsNetworkOptions
  126. def setSni(value: Boolean): HttpServerOptions

    Set whether the server supports Server Name Indiciation

    Set whether the server supports Server Name Indiciation

    Definition Classes
    HttpServerOptionsNetServerOptions
  127. def setSoLinger(value: Int): HttpServerOptions

    Set whether SO_linger keep alive is enabled

    Set whether SO_linger keep alive is enabled

    Definition Classes
    HttpServerOptionsNetServerOptionsTCPSSLOptions
  128. def setSsl(value: Boolean): HttpServerOptions

    Set whether SSL/TLS is enabled

    Set whether SSL/TLS is enabled

    Definition Classes
    HttpServerOptionsNetServerOptionsTCPSSLOptions
  129. 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
    HttpServerOptionsNetServerOptionsTCPSSLOptions
  130. 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
    HttpServerOptionsNetServerOptionsTCPSSLOptions
  131. 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
    HttpServerOptionsNetServerOptionsTCPSSLOptions
  132. 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
    HttpServerOptionsNetServerOptionsTCPSSLOptions
  133. def setTcpKeepAlive(value: Boolean): HttpServerOptions

    Set whether TCP keep alive is enabled

    Set whether TCP keep alive is enabled

    Definition Classes
    HttpServerOptionsNetServerOptionsTCPSSLOptions
  134. def setTcpNoDelay(value: Boolean): HttpServerOptions

    Set whether TCP no delay is enabled

    Set whether TCP no delay is enabled

    Definition Classes
    HttpServerOptionsNetServerOptionsTCPSSLOptions
  135. 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
    HttpServerOptionsNetServerOptionsTCPSSLOptions
  136. def setTrafficClass(value: Int): HttpServerOptions

    Set the value of traffic class

    Set the value of traffic class

    Definition Classes
    HttpServerOptionsNetServerOptionsNetworkOptions
  137. 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
    HttpServerOptionsNetServerOptionsTCPSSLOptions
  138. def setUseAlpn(value: Boolean): HttpServerOptions

    Set the ALPN usage.

    Set the ALPN usage.

    Definition Classes
    HttpServerOptionsNetServerOptionsTCPSSLOptions
  139. def setUsePooledBuffers(value: Boolean): HttpServerOptions

    Set whether Netty pooled buffers are enabled

    Set whether Netty pooled buffers are enabled

    Definition Classes
    HttpServerOptionsNetServerOptionsTCPSSLOptions
  140. 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.

  141. def setWebSocketCompressionLevel(value: Int): HttpServerOptions

    Set the WebSocket compression level.

  142. 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.

  143. def setWebSocketSubProtocols(value: Buffer[String]): HttpServerOptions
  144. 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.

  145. def setWebsocketCompressionLevel(value: Int): HttpServerOptions

    Set the WebSocket compression level.

  146. 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.

  147. def setWebsocketSubProtocols(value: String): HttpServerOptions

    Set the WebSocket sub-protocols supported by the server.

  148. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  149. def toString(): String
    Definition Classes
    AnyRef → Any
  150. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  151. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  152. 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