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

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package ext
  Definition Classes
    scala
-  package shell
  Definition Classes
    ext
-  package term
  Definition Classes
    shell
- HttpTermOptions
- Pty
- SSHTermOptions
- SignalHandler
- SockJSTermHandler
- TelnetTermOptions
- Term
- TermServer
- Tty

c

io.vertx.scala.ext.shell.term

# HttpTermOptions 

###
Companion object HttpTermOptions

#### class HttpTermOptions extends HttpServerOptions

The web term configuration options.

Linear Supertypes
HttpServerOptions, NetServerOptions, TCPSSLOptions, NetworkOptions, AnyRef, Any
 
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
     HttpTermOptions → HttpServerOptions → NetServerOptions → TCPSSLOptions
5.  def addCrlValue(value: Buffer): HttpTermOptions

   Add a CRL value

   Add a CRL value

   Definition Classes
     HttpTermOptions → HttpServerOptions → NetServerOptions → TCPSSLOptions
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
     HttpTermOptions → HttpServerOptions → NetServerOptions → TCPSSLOptions
7.  def addEnabledSecureTransportProtocol(value: String): HttpTermOptions

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

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

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

    Set the accept back log

    Set the accept back log

    Definition Classes
      HttpTermOptions → HttpServerOptions → NetServerOptions
73.  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
      HttpTermOptions → HttpServerOptions
74.  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
      HttpTermOptions → HttpServerOptions
75.  def setCharset(value: String): HttpTermOptions

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

76.  def setClientAuth(value: ClientAuth): HttpTermOptions

    Set whether client auth is required

    Set whether client auth is required

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

    Set whether client auth is required

    Set whether client auth is required

    Definition Classes
      HttpTermOptions → HttpServerOptions → NetServerOptions
78.  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
      HttpTermOptions → HttpServerOptions
79.  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
      HttpTermOptions → HttpServerOptions
80.  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
      HttpTermOptions → HttpServerOptions
81.  def setDecompressionSupported(value: Boolean): HttpTermOptions

    Set whether the server supports decompression

    Set whether the server supports decompression

    Definition Classes
      HttpTermOptions → HttpServerOptions
82.  def setHandle100ContinueAutomatically(value: Boolean): HttpTermOptions

    Set whether 100 Continue should be handled automatically

    Set whether 100 Continue should be handled automatically

    Definition Classes
      HttpTermOptions → HttpServerOptions
83.  def setHost(value: String): HttpTermOptions

    Set the host

    Set the host

    Definition Classes
      HttpTermOptions → HttpServerOptions → NetServerOptions
84.  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
      HttpTermOptions → HttpServerOptions
85.  def setIdleTimeout(value: Int): HttpTermOptions

    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
      HttpTermOptions → HttpServerOptions → NetServerOptions → TCPSSLOptions
86.  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
      HttpTermOptions → HttpServerOptions
87.  def setIntputrc(value: String): HttpTermOptions

    The path of the inputrc config.

88.  def setJdkSslEngineOptions(value: JdkSSLEngineOptions): HttpTermOptions
    Definition Classes
      HttpTermOptions → HttpServerOptions → NetServerOptions → TCPSSLOptions
89.  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
      HttpTermOptions → HttpServerOptions → NetServerOptions → TCPSSLOptions
90.  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
      HttpTermOptions → HttpServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
91.  def setMaxChunkSize(value: Int): HttpTermOptions

    Set the maximum HTTP chunk size

    Set the maximum HTTP chunk size

    Definition Classes
      HttpTermOptions → HttpServerOptions
92.  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
      HttpTermOptions → HttpServerOptions
93.  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
      HttpTermOptions → HttpServerOptions
94.  def setMaxWebsocketFrameSize(value: Int): HttpTermOptions

    Set the maximum websocket frames size

    Set the maximum websocket frames size

    Definition Classes
      HttpTermOptions → HttpServerOptions
95.  def setMaxWebsocketMessageSize(value: Int): HttpTermOptions

    Set the maximum websocket message size

    Set the maximum websocket message size

    Definition Classes
      HttpTermOptions → HttpServerOptions
96.  def setOpenSslEngineOptions(value: OpenSSLEngineOptions): HttpTermOptions
    Definition Classes
      HttpTermOptions → HttpServerOptions → NetServerOptions → TCPSSLOptions
97.  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
      HttpTermOptions → HttpServerOptions → NetServerOptions → TCPSSLOptions
98.  def setPemTrustOptions(value: PemTrustOptions): HttpTermOptions

    Set the trust options in pem format

    Set the trust options in pem format

    Definition Classes
      HttpTermOptions → HttpServerOptions → NetServerOptions → TCPSSLOptions
99.  def setPfxKeyCertOptions(value: PfxOptions): HttpTermOptions

    Set the key/cert options in pfx format.

    Set the key/cert options in pfx format.

    Definition Classes
      HttpTermOptions → HttpServerOptions → NetServerOptions → TCPSSLOptions
100.  def setPfxTrustOptions(value: PfxOptions): HttpTermOptions

     Set the trust options in pfx format

     Set the trust options in pfx format

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

     Set the port

     Set the port

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

     Set the TCP receive buffer size

     Set the TCP receive buffer size

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

     Set the value of reuse address

     Set the value of reuse address

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

     Set the TCP send buffer size

     Set the TCP send buffer size

     Definition Classes
       HttpTermOptions → HttpServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
105.  def setShellHtmlResource(value: Buffer): HttpTermOptions

     Set `shell.html` resource to use.

106.  def setSni(value: Boolean): HttpTermOptions

     Set whether the server supports Server Name Indiciation

     Set whether the server supports Server Name Indiciation

     Definition Classes
       HttpTermOptions → HttpServerOptions → NetServerOptions
107.  def setSoLinger(value: Int): HttpTermOptions

     Set whether SO_linger keep alive is enabled

     Set whether SO_linger keep alive is enabled

     Definition Classes
       HttpTermOptions → HttpServerOptions → NetServerOptions → TCPSSLOptions
108.  def setSockJSHandlerOptions(value: SockJSHandlerOptions): HttpTermOptions

     The SockJS handler options.

109.  def setSockJSPath(value: String): HttpTermOptions

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

110.  def setSsl(value: Boolean): HttpTermOptions

     Set whether SSL/TLS is enabled

     Set whether SSL/TLS is enabled

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

     Set whether TCP keep alive is enabled

     Set whether TCP keep alive is enabled

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

     Set whether TCP no delay is enabled

     Set whether TCP no delay is enabled

     Definition Classes
       HttpTermOptions → HttpServerOptions → NetServerOptions → TCPSSLOptions
113.  def setTermJsResource(value: Buffer): HttpTermOptions

     Set `term.js` resource to use.

114.  def setTrafficClass(value: Int): HttpTermOptions

     Set the value of traffic class

     Set the value of traffic class

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

     Set the ALPN usage.

     Set the ALPN usage.

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

     Set whether Netty pooled buffers are enabled

     Set whether Netty pooled buffers are enabled

     Definition Classes
       HttpTermOptions → HttpServerOptions → NetServerOptions → TCPSSLOptions
118.  def setVertsShellJsResource(value: Buffer): HttpTermOptions

     Set `vertxshell.js` resource to use.

119.  def setWebsocketSubProtocols(value: String): HttpTermOptions

     Set the websocket subprotocols supported by the server.

     Set the websocket subprotocols supported by the server.

     Definition Classes
       HttpTermOptions → HttpServerOptions
120.  final def synchronized[T0](arg0: ⇒ T0): T0
     Definition Classes
       AnyRef
121.  def toString(): String
     Definition Classes
       AnyRef → Any
122.  final def wait(): Unit
     Definition Classes
       AnyRef
     Annotations
       @throws( ... )
123.  final def wait(arg0: Long, arg1: Int): Unit
     Definition Classes
       AnyRef
     Annotations
       @throws( ... )
124.  final def wait(arg0: Long): Unit
     Definition Classes
       AnyRef
     Annotations
       @throws( ... )

### Inherited from HttpServerOptions

### Inherited from NetServerOptions

### Inherited from TCPSSLOptions

### Inherited from NetworkOptions

### Inherited from AnyRef

### Inherited from Any

### Ungrouped