Packages

class HttpTermOptions extends HttpServerOptions

The web term configuration options.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HttpTermOptions
  2. HttpServerOptions
  3. NetServerOptions
  4. TCPSSLOptions
  5. NetworkOptions
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new HttpTermOptions(_asJava: ext.shell.term.HttpTermOptions)

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): HttpTermOptions

    Add a CRL path

    Add a CRL path

    Definition Classes
    HttpTermOptionsHttpServerOptionsNetServerOptionsTCPSSLOptions
  5. def addCrlValue(value: Buffer): HttpTermOptions

    Add a CRL value

    Add a CRL value

    Definition Classes
    HttpTermOptionsHttpServerOptionsNetServerOptionsTCPSSLOptions
  6. def addEnabledCipherSuite(value: String): HttpTermOptions

    Add an enabled cipher suite, appended to the ordered suites.

    Add an enabled cipher suite, appended to the ordered suites.

    Definition Classes
    HttpTermOptionsHttpServerOptionsNetServerOptionsTCPSSLOptions
  7. def addEnabledSecureTransportProtocol(value: String): HttpTermOptions

    Sets the list of enabled SSL/TLS protocols.

    Sets the list of enabled SSL/TLS protocols.

    Definition Classes
    HttpTermOptionsHttpServerOptionsNetServerOptionsTCPSSLOptions
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def asJava: ext.shell.term.HttpTermOptions
  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
  15. def getAlpnVersions: Buffer[HttpVersion]
    Definition Classes
    HttpTermOptionsHttpServerOptions
  16. def getCharset: String
  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def getClientAuth: ClientAuth
  19. def getCompressionLevel: Int
    Definition Classes
    HttpTermOptionsHttpServerOptions
  20. def getCrlPaths: Buffer[String]
  21. def getCrlValues: Buffer[Buffer]
  22. def getDecoderInitialBufferSize: Int
    Definition Classes
    HttpTermOptionsHttpServerOptions
  23. def getEnabledCipherSuites: Set[String]
  24. def getEnabledSecureTransportProtocols: Set[String]
  25. def getHost: String
  26. def getHttp2ConnectionWindowSize: Int
    Definition Classes
    HttpTermOptionsHttpServerOptions
  27. def getIdleTimeout: Int
  28. def getIdleTimeoutUnit: TimeUnit
  29. def getInitialSettings: Http2Settings
    Definition Classes
    HttpTermOptionsHttpServerOptions
  30. def getIntputrc: String
  31. def getJdkSslEngineOptions: JdkSSLEngineOptions
  32. def getKeyStoreOptions: JksOptions
  33. def getLogActivity: Boolean
  34. def getMaxChunkSize: Int
    Definition Classes
    HttpTermOptionsHttpServerOptions
  35. def getMaxHeaderSize: Int
    Definition Classes
    HttpTermOptionsHttpServerOptions
  36. def getMaxInitialLineLength: Int
    Definition Classes
    HttpTermOptionsHttpServerOptions
  37. def getMaxWebsocketFrameSize: Int
    Definition Classes
    HttpTermOptionsHttpServerOptions
  38. def getMaxWebsocketMessageSize: Int
    Definition Classes
    HttpTermOptionsHttpServerOptions
  39. def getOpenSslEngineOptions: OpenSSLEngineOptions
  40. def getPemKeyCertOptions: PemKeyCertOptions
  41. def getPemTrustOptions: PemTrustOptions
  42. def getPfxKeyCertOptions: PfxOptions
  43. def getPfxTrustOptions: PfxOptions
  44. def getPort: Int
  45. def getReceiveBufferSize: Int
  46. def getSendBufferSize: Int
  47. def getShellHtmlResource: Buffer
  48. def getSoLinger: Int
  49. def getSockJSHandlerOptions: SockJSHandlerOptions
  50. def getSockJSPath: String
  51. def getTermJsResource: Buffer
  52. def getTrafficClass: Int
  53. def getTrustStoreOptions: JksOptions
  54. def getVertsShellJsResource: Buffer
  55. def getWebsocketAllowServerNoContext: Boolean
    Definition Classes
    HttpTermOptionsHttpServerOptions
  56. def getWebsocketPreferredClientNoContext: Boolean
    Definition Classes
    HttpTermOptionsHttpServerOptions
  57. def getWebsocketSubProtocols: String
    Definition Classes
    HttpTermOptionsHttpServerOptions
  58. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  59. def isAcceptUnmaskedFrames: Boolean
    Definition Classes
    HttpTermOptionsHttpServerOptions
  60. def isClientAuthRequired: Boolean
  61. def isCompressionSupported: Boolean
    Definition Classes
    HttpTermOptionsHttpServerOptions
  62. def isDecompressionSupported: Boolean
    Definition Classes
    HttpTermOptionsHttpServerOptions
  63. def isHandle100ContinueAutomatically: Boolean
    Definition Classes
    HttpTermOptionsHttpServerOptions
  64. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  65. def isReuseAddress: Boolean
  66. def isReusePort: Boolean
  67. def isSni: Boolean
  68. def isSsl: Boolean
  69. def isTcpCork: Boolean
  70. def isTcpFastOpen: Boolean
  71. def isTcpKeepAlive: Boolean
  72. def isTcpNoDelay: Boolean
  73. def isTcpQuickAck: Boolean
  74. def isUseAlpn: Boolean
  75. def isUsePooledBuffers: Boolean
  76. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  77. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  78. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  79. def setAcceptBacklog(value: Int): HttpTermOptions

    Set the accept back log

    Set the accept back log

    Definition Classes
    HttpTermOptionsHttpServerOptionsNetServerOptions
  80. def setAcceptUnmaskedFrames(value: Boolean): HttpTermOptions

    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.

    Definition Classes
    HttpTermOptionsHttpServerOptions
  81. def setAlpnVersions(value: Buffer[HttpVersion]): HttpTermOptions

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

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

    Definition Classes
    HttpTermOptionsHttpServerOptions
  82. def setCharset(value: String): HttpTermOptions

    Set the charset used for encoding / decoding text data from/to SockJS

  83. def setClientAuth(value: ClientAuth): HttpTermOptions

    Set whether client auth is required

    Set whether client auth is required

    Definition Classes
    HttpTermOptionsHttpServerOptionsNetServerOptions
  84. def setClientAuthRequired(value: Boolean): HttpTermOptions

    Set whether client auth is required

    Set whether client auth is required

    Definition Classes
    HttpTermOptionsHttpServerOptionsNetServerOptions
  85. def setCompressionLevel(value: Int): HttpTermOptions

    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

    Definition Classes
    HttpTermOptionsHttpServerOptions
  86. def setCompressionSupported(value: Boolean): HttpTermOptions

    Set whether the server should support gzip/deflate compression (serving compressed responses to clients advertising support for them with Accept-Encoding header)

    Set whether the server should support gzip/deflate compression (serving compressed responses to clients advertising support for them with Accept-Encoding header)

    Definition Classes
    HttpTermOptionsHttpServerOptions
  87. def setDecoderInitialBufferSize(value: Int): HttpTermOptions

    Set the initial buffer size for the HTTP decoder

    Set the initial buffer size for the HTTP decoder

    Definition Classes
    HttpTermOptionsHttpServerOptions
  88. def setDecompressionSupported(value: Boolean): HttpTermOptions

    Set whether the server supports decompression

    Set whether the server supports decompression

    Definition Classes
    HttpTermOptionsHttpServerOptions
  89. def setEnabledSecureTransportProtocols(value: Set[String]): HttpTermOptions
  90. def setHandle100ContinueAutomatically(value: Boolean): HttpTermOptions

    Set whether 100 Continue should be handled automatically

    Set whether 100 Continue should be handled automatically

    Definition Classes
    HttpTermOptionsHttpServerOptions
  91. def setHost(value: String): HttpTermOptions

    Set the host

    Set the host

    Definition Classes
    HttpTermOptionsHttpServerOptionsNetServerOptions
  92. def setHttp2ConnectionWindowSize(value: Int): HttpTermOptions

    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.

    Definition Classes
    HttpTermOptionsHttpServerOptions
  93. def setIdleTimeout(value: Int): HttpTermOptions

    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
    HttpTermOptionsHttpServerOptionsNetServerOptionsTCPSSLOptions
  94. def setIdleTimeoutUnit(value: TimeUnit): HttpTermOptions

    Set the idle timeout unit.

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

    Definition Classes
    HttpTermOptionsHttpServerOptionsNetServerOptionsTCPSSLOptions
  95. def setInitialSettings(value: Http2Settings): HttpTermOptions

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

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

    Definition Classes
    HttpTermOptionsHttpServerOptions
  96. def setIntputrc(value: String): HttpTermOptions

    The path of the inputrc config.

  97. def setJdkSslEngineOptions(value: JdkSSLEngineOptions): HttpTermOptions
  98. def setKeyStoreOptions(value: JksOptions): HttpTermOptions

    Set the key/cert options in jks format, aka Java keystore.

    Set the key/cert options in jks format, aka Java keystore.

    Definition Classes
    HttpTermOptionsHttpServerOptionsNetServerOptionsTCPSSLOptions
  99. def setLogActivity(value: Boolean): HttpTermOptions

    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
    HttpTermOptionsHttpServerOptionsNetServerOptionsTCPSSLOptionsNetworkOptions
  100. def setMaxChunkSize(value: Int): HttpTermOptions

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

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

    Definition Classes
    HttpTermOptionsHttpServerOptions
  101. def setMaxHeaderSize(value: Int): HttpTermOptions

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

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

    Definition Classes
    HttpTermOptionsHttpServerOptions
  102. def setMaxInitialLineLength(value: Int): HttpTermOptions

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

    Definition Classes
    HttpTermOptionsHttpServerOptions
  103. def setMaxWebsocketFrameSize(value: Int): HttpTermOptions

    Set the maximum websocket frames size

    Set the maximum websocket frames size

    Definition Classes
    HttpTermOptionsHttpServerOptions
  104. def setMaxWebsocketMessageSize(value: Int): HttpTermOptions

    Set the maximum websocket message size

    Set the maximum websocket message size

    Definition Classes
    HttpTermOptionsHttpServerOptions
  105. def setOpenSslEngineOptions(value: OpenSSLEngineOptions): HttpTermOptions
  106. def setPemKeyCertOptions(value: PemKeyCertOptions): HttpTermOptions

    Set the key/cert store options in pem format.

    Set the key/cert store options in pem format.

    Definition Classes
    HttpTermOptionsHttpServerOptionsNetServerOptionsTCPSSLOptions
  107. def setPemTrustOptions(value: PemTrustOptions): HttpTermOptions

    Set the trust options in pem format

    Set the trust options in pem format

    Definition Classes
    HttpTermOptionsHttpServerOptionsNetServerOptionsTCPSSLOptions
  108. def setPerFrameWebsocketCompressionSupported(value: Boolean): HttpTermOptions

    Enable or disable support for WebSocket Defalte Frame compression

    Enable or disable support for WebSocket Defalte Frame compression

    Definition Classes
    HttpTermOptionsHttpServerOptions
  109. def setPerMessageWebsocketCompressionSupported(value: Boolean): HttpTermOptions

    Enable or disable support for WebSocket Permessage Deflate compression

    Enable or disable support for WebSocket Permessage Deflate compression

    Definition Classes
    HttpTermOptionsHttpServerOptions
  110. def setPfxKeyCertOptions(value: PfxOptions): HttpTermOptions

    Set the key/cert options in pfx format.

    Set the key/cert options in pfx format.

    Definition Classes
    HttpTermOptionsHttpServerOptionsNetServerOptionsTCPSSLOptions
  111. def setPfxTrustOptions(value: PfxOptions): HttpTermOptions

    Set the trust options in pfx format

    Set the trust options in pfx format

    Definition Classes
    HttpTermOptionsHttpServerOptionsNetServerOptionsTCPSSLOptions
  112. def setPort(value: Int): HttpTermOptions

    Set the port

    Set the port

    Definition Classes
    HttpTermOptionsHttpServerOptionsNetServerOptions
  113. def setReceiveBufferSize(value: Int): HttpTermOptions

    Set the TCP receive buffer size

    Set the TCP receive buffer size

    Definition Classes
    HttpTermOptionsHttpServerOptionsNetServerOptionsTCPSSLOptionsNetworkOptions
  114. def setReuseAddress(value: Boolean): HttpTermOptions

    Set the value of reuse address

    Set the value of reuse address

    Definition Classes
    HttpTermOptionsHttpServerOptionsNetServerOptionsTCPSSLOptionsNetworkOptions
  115. def setReusePort(value: Boolean): HttpTermOptions

    Set the value of reuse port.

    Set the value of reuse port.

    This is only supported by native transports.

    Definition Classes
    HttpTermOptionsHttpServerOptionsNetServerOptionsTCPSSLOptionsNetworkOptions
  116. def setSendBufferSize(value: Int): HttpTermOptions

    Set the TCP send buffer size

    Set the TCP send buffer size

    Definition Classes
    HttpTermOptionsHttpServerOptionsNetServerOptionsTCPSSLOptionsNetworkOptions
  117. def setShellHtmlResource(value: Buffer): HttpTermOptions

    Set shell.html resource to use.

  118. def setSni(value: Boolean): HttpTermOptions

    Set whether the server supports Server Name Indiciation

    Set whether the server supports Server Name Indiciation

    Definition Classes
    HttpTermOptionsHttpServerOptionsNetServerOptions
  119. def setSoLinger(value: Int): HttpTermOptions

    Set whether SO_linger keep alive is enabled

    Set whether SO_linger keep alive is enabled

    Definition Classes
    HttpTermOptionsHttpServerOptionsNetServerOptionsTCPSSLOptions
  120. def setSockJSHandlerOptions(value: SockJSHandlerOptions): HttpTermOptions

    The SockJS handler options.

  121. def setSockJSPath(value: String): HttpTermOptions

    Configure the SockJS path, the default value is /term/\*.

  122. def setSsl(value: Boolean): HttpTermOptions

    Set whether SSL/TLS is enabled

    Set whether SSL/TLS is enabled

    Definition Classes
    HttpTermOptionsHttpServerOptionsNetServerOptionsTCPSSLOptions
  123. def setTcpCork(value: Boolean): HttpTermOptions

    Enable the TCP_CORK option - only with linux native transport.

    Enable the TCP_CORK option - only with linux native transport.

    Definition Classes
    HttpTermOptionsHttpServerOptionsNetServerOptionsTCPSSLOptions
  124. def setTcpFastOpen(value: Boolean): HttpTermOptions

    Enable the TCP_FASTOPEN option - only with linux native transport.

    Enable the TCP_FASTOPEN option - only with linux native transport.

    Definition Classes
    HttpTermOptionsHttpServerOptionsNetServerOptionsTCPSSLOptions
  125. def setTcpKeepAlive(value: Boolean): HttpTermOptions

    Set whether TCP keep alive is enabled

    Set whether TCP keep alive is enabled

    Definition Classes
    HttpTermOptionsHttpServerOptionsNetServerOptionsTCPSSLOptions
  126. def setTcpNoDelay(value: Boolean): HttpTermOptions

    Set whether TCP no delay is enabled

    Set whether TCP no delay is enabled

    Definition Classes
    HttpTermOptionsHttpServerOptionsNetServerOptionsTCPSSLOptions
  127. def setTcpQuickAck(value: Boolean): HttpTermOptions

    Enable the TCP_QUICKACK option - only with linux native transport.

    Enable the TCP_QUICKACK option - only with linux native transport.

    Definition Classes
    HttpTermOptionsHttpServerOptionsNetServerOptionsTCPSSLOptions
  128. def setTermJsResource(value: Buffer): HttpTermOptions

    Set term.js resource to use.

  129. def setTrafficClass(value: Int): HttpTermOptions

    Set the value of traffic class

    Set the value of traffic class

    Definition Classes
    HttpTermOptionsHttpServerOptionsNetServerOptionsTCPSSLOptionsNetworkOptions
  130. def setTrustStoreOptions(value: JksOptions): HttpTermOptions

    Set the trust options in jks format, aka Java truststore

    Set the trust options in jks format, aka Java truststore

    Definition Classes
    HttpTermOptionsHttpServerOptionsNetServerOptionsTCPSSLOptions
  131. def setUseAlpn(value: Boolean): HttpTermOptions

    Set the ALPN usage.

    Set the ALPN usage.

    Definition Classes
    HttpTermOptionsHttpServerOptionsNetServerOptionsTCPSSLOptions
  132. def setUsePooledBuffers(value: Boolean): HttpTermOptions

    Set whether Netty pooled buffers are enabled

    Set whether Netty pooled buffers are enabled

    Definition Classes
    HttpTermOptionsHttpServerOptionsNetServerOptionsTCPSSLOptions
  133. def setVertsShellJsResource(value: Buffer): HttpTermOptions

    Set vertxshell.js resource to use.

  134. def setWebsocketAllowServerNoContext(value: Boolean): HttpTermOptions

    Set the WebSocket Allow Server No Context option

    Set the WebSocket Allow Server No Context option

    Definition Classes
    HttpTermOptionsHttpServerOptions
  135. def setWebsocketCompressionLevel(value: Int): HttpTermOptions

    Set the WebSocket compression level

    Set the WebSocket compression level

    Definition Classes
    HttpTermOptionsHttpServerOptions
  136. def setWebsocketPreferredClientNoContext(value: Boolean): HttpTermOptions

    Set the WebSocket Preferred Client No Context setting

    Set the WebSocket Preferred Client No Context setting

    Definition Classes
    HttpTermOptionsHttpServerOptions
  137. def setWebsocketSubProtocols(value: String): HttpTermOptions

    Set the websocket subprotocols supported by the server.

    Set the websocket subprotocols supported by the server.

    Definition Classes
    HttpTermOptionsHttpServerOptions
  138. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  139. def toString(): String
    Definition Classes
    AnyRef → Any
  140. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  141. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  142. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from HttpServerOptions

Inherited from NetServerOptions

Inherited from TCPSSLOptions

Inherited from NetworkOptions

Inherited from AnyRef

Inherited from Any

Ungrouped