vertx-lang-scala-docs_2.12 3.6.0.CR2 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
- WebSocketFrame

c

io.vertx.scala.core.http

# HttpClientOptions 

###
Companion object HttpClientOptions

#### class HttpClientOptions extends ClientOptionsBase

Options describing how an io.vertx.scala.core.http.HttpClient will make connections.

Linear Supertypes
ClientOptionsBase, TCPSSLOptions, NetworkOptions, AnyRef, Any
Known Subclasses
OAuth2ClientOptions, ConsulClientOptions, WebClientOptions
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. HttpClientOptions
2. ClientOptionsBase
3. TCPSSLOptions
4. NetworkOptions
5. AnyRef
6. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

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

### 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): HttpClientOptions

   Add a CRL path

   Add a CRL path

   Definition Classes
     HttpClientOptions → ClientOptionsBase → TCPSSLOptions
5.  def addCrlValue(value: Buffer): HttpClientOptions

   Add a CRL value

   Add a CRL value

   Definition Classes
     HttpClientOptions → ClientOptionsBase → TCPSSLOptions
6.  def addEnabledCipherSuite(value: String): HttpClientOptions

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

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

   Definition Classes
     HttpClientOptions → ClientOptionsBase → TCPSSLOptions
7.  def addEnabledSecureTransportProtocol(value: String): HttpClientOptions

   Sets the list of enabled SSL/TLS protocols.

   Sets the list of enabled SSL/TLS protocols.

   Definition Classes
     HttpClientOptions → ClientOptionsBase → TCPSSLOptions
8.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
9.  def asJava: core.http.HttpClientOptions
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 getAlpnVersions: Buffer[HttpVersion]
15.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
16.  def getConnectTimeout: Int
    Definition Classes
      HttpClientOptions → ClientOptionsBase
17.  def getCrlPaths: Buffer[String]
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
18.  def getCrlValues: Buffer[Buffer]
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
19.  def getDecoderInitialBufferSize: Int
20.  def getDefaultHost: String
21.  def getDefaultPort: Int
22.  def getEnabledCipherSuites: Set[String]
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
23.  def getEnabledSecureTransportProtocols: Set[String]
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
24.  def getHttp2ConnectionWindowSize: Int
25.  def getHttp2KeepAliveTimeout: Int
26.  def getHttp2MaxPoolSize: Int
27.  def getHttp2MultiplexingLimit: Int
28.  def getIdleTimeout: Int
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
29.  def getIdleTimeoutUnit: TimeUnit
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
30.  def getInitialSettings: Http2Settings
31.  def getJdkSslEngineOptions: JdkSSLEngineOptions
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
32.  def getKeepAliveTimeout: Int
33.  def getKeyStoreOptions: JksOptions
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
34.  def getLocalAddress: String
    Definition Classes
      HttpClientOptions → ClientOptionsBase
35.  def getLogActivity: Boolean
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
36.  def getMaxChunkSize: Int
37.  def getMaxHeaderSize: Int
38.  def getMaxInitialLineLength: Int
39.  def getMaxPoolSize: Int
40.  def getMaxRedirects: Int
41.  def getMaxWaitQueueSize: Int
42.  def getMaxWebsocketFrameSize: Int
43.  def getMaxWebsocketMessageSize: Int
44.  def getMetricsName: String
    Definition Classes
      HttpClientOptions → ClientOptionsBase
45.  def getOpenSslEngineOptions: OpenSSLEngineOptions
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
46.  def getPemKeyCertOptions: PemKeyCertOptions
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
47.  def getPemTrustOptions: PemTrustOptions
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
48.  def getPfxKeyCertOptions: PfxOptions
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
49.  def getPfxTrustOptions: PfxOptions
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
50.  def getPipeliningLimit: Int
51.  def getPoolCleanerPeriod: Int
52.  def getProtocolVersion: HttpVersion
53.  def getProxyOptions: ProxyOptions
    Definition Classes
      HttpClientOptions → ClientOptionsBase
54.  def getReceiveBufferSize: Int
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
55.  def getSendBufferSize: Int
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
56.  def getSoLinger: Int
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
57.  def getTrafficClass: Int
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
58.  def getTrustStoreOptions: JksOptions
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
59.  def getWebsocketCompressionAllowClientNoContext: Boolean
60.  def getWebsocketCompressionLevel: Int
61.  def getWebsocketCompressionRequestServerNoContext: Boolean
62.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
63.  def isForceSni: Boolean
64.  def isHttp2ClearTextUpgrade: Boolean
65.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
66.  def isKeepAlive: Boolean
67.  def isPipelining: Boolean
68.  def isReuseAddress: Boolean
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
69.  def isReusePort: Boolean
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
70.  def isSendUnmaskedFrames: Boolean
71.  def isSsl: Boolean
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
72.  def isTcpCork: Boolean
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
73.  def isTcpFastOpen: Boolean
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
74.  def isTcpKeepAlive: Boolean
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
75.  def isTcpNoDelay: Boolean
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
76.  def isTcpQuickAck: Boolean
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
77.  def isTrustAll: Boolean
    Definition Classes
      HttpClientOptions → ClientOptionsBase
78.  def isTryUseCompression: Boolean
79.  def isUseAlpn: Boolean
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
80.  def isUsePooledBuffers: Boolean
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
81.  def isVerifyHost: Boolean
82.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
83.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
84.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
85.  def setAlpnVersions(value: Buffer[HttpVersion]): HttpClientOptions

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

    Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiation. When the list is empty, the client provides a best effort list according to HttpClientOptions:

    - : [ "h2", "http/1.1" ]
    - otherwise: [HttpClientOptions]
86.  def setConnectTimeout(value: Int): HttpClientOptions

    Set the connect timeout

    Set the connect timeout

    Definition Classes
      HttpClientOptions → ClientOptionsBase
87.  def setDecoderInitialBufferSize(value: Int): HttpClientOptions

    set to `initialBufferSizeHttpDecoder` the initial buffer of the HttpDecoder.

88.  def setDefaultHost(value: String): HttpClientOptions

    Set the default host name to be used by this client in requests if none is provided when making the request.

89.  def setDefaultPort(value: Int): HttpClientOptions

    Set the default port to be used by this client in requests if none is provided when making the request.

90.  def setEnabledSecureTransportProtocols(value: Set[String]): HttpClientOptions
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
91.  def setForceSni(value: Boolean): HttpClientOptions

    By default, the server name is only sent for Fully Qualified Domain Name (FQDN), setting this property to `true` forces the server name to be always sent.

92.  def setHttp2ClearTextUpgrade(value: Boolean): HttpClientOptions

    Set to `true` when an h2c connection is established using an HTTP/1.1 upgrade request, and `false` when an h2c connection is established directly (with prior knowledge).

93.  def setHttp2ConnectionWindowSize(value: Int): HttpClientOptions

    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.

94.  def setHttp2KeepAliveTimeout(value: Int): HttpClientOptions

    Set the keep alive timeout for HTTP/2 connections, in seconds.

    Set the keep alive timeout for HTTP/2 connections, in seconds.

    This value determines how long a connection remains unused in the pool before being evicted and closed.

95.  def setHttp2MaxPoolSize(value: Int): HttpClientOptions

    Set the maximum pool size for HTTP/2 connections

96.  def setHttp2MultiplexingLimit(value: Int): HttpClientOptions

    Set a client limit of the number concurrent streams for each HTTP/2 connection, this limits the number of streams the client can create for a connection.

    Set a client limit of the number concurrent streams for each HTTP/2 connection, this limits the number of streams the client can create for a connection. The effective number of streams for a connection is the min of this value and the server's initial settings.

    Setting the value to `-1` means to use the value sent by the server's initial settings. `-1` is the default value.

97.  def setIdleTimeout(value: Int): HttpClientOptions

    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 HttpClientOptions

    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
98.  def setIdleTimeoutUnit(value: TimeUnit): HttpClientOptions

    Set the idle timeout unit.

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

    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
99.  def setInitialSettings(value: Http2Settings): HttpClientOptions

    Set the HTTP/2 connection settings immediately sent by to the server when the client connects.

100.  def setJdkSslEngineOptions(value: JdkSSLEngineOptions): HttpClientOptions
     Definition Classes
       HttpClientOptions → ClientOptionsBase → TCPSSLOptions
101.  def setKeepAlive(value: Boolean): HttpClientOptions

     Set whether keep alive is enabled on the client

102.  def setKeepAliveTimeout(value: Int): HttpClientOptions

     Set the keep alive timeout for HTTP/1.x, in seconds.

     Set the keep alive timeout for HTTP/1.x, in seconds.

     This value determines how long a connection remains unused in the pool before being evicted and closed.

103.  def setKeyStoreOptions(value: JksOptions): HttpClientOptions

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

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

     Definition Classes
       HttpClientOptions → ClientOptionsBase → TCPSSLOptions
104.  def setLocalAddress(value: String): HttpClientOptions

     Set the local interface to bind for network connections.

     Set the local interface to bind for network connections. When the local address is null, it will pick any local address, the default local address is null.

     Definition Classes
       HttpClientOptions → ClientOptionsBase
105.  def setLogActivity(value: Boolean): HttpClientOptions

     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
       HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
106.  def setMaxChunkSize(value: Int): HttpClientOptions

     Set the maximum HTTP chunk size

107.  def setMaxHeaderSize(value: Int): HttpClientOptions

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

108.  def setMaxInitialLineLength(value: Int): HttpClientOptions

     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. `"HTTP/1.1 200 OK"`)

109.  def setMaxPoolSize(value: Int): HttpClientOptions

     Set the maximum pool size for connections

110.  def setMaxRedirects(value: Int): HttpClientOptions

     Set to `maxRedirects` the maximum number of redirection a request can follow.

111.  def setMaxWaitQueueSize(value: Int): HttpClientOptions

     Set the maximum requests allowed in the wait queue, any requests beyond the max size will result in a ConnectionPoolTooBusyException.

     Set the maximum requests allowed in the wait queue, any requests beyond the max size will result in a ConnectionPoolTooBusyException. If the value is set to a negative number then the queue will be unbounded.

112.  def setMaxWebsocketFrameSize(value: Int): HttpClientOptions

     Set the max websocket frame size

113.  def setMaxWebsocketMessageSize(value: Int): HttpClientOptions

     Set the max websocket message size

114.  def setMetricsName(value: String): HttpClientOptions

     Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name.

     Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name.

     Definition Classes
       HttpClientOptions → ClientOptionsBase
115.  def setOpenSslEngineOptions(value: OpenSSLEngineOptions): HttpClientOptions
     Definition Classes
       HttpClientOptions → ClientOptionsBase → TCPSSLOptions
116.  def setPemKeyCertOptions(value: PemKeyCertOptions): HttpClientOptions

     Set the key/cert store options in pem format.

     Set the key/cert store options in pem format.

     Definition Classes
       HttpClientOptions → ClientOptionsBase → TCPSSLOptions
117.  def setPemTrustOptions(value: PemTrustOptions): HttpClientOptions

     Set the trust options in pem format

     Set the trust options in pem format

     Definition Classes
       HttpClientOptions → ClientOptionsBase → TCPSSLOptions
118.  def setPfxKeyCertOptions(value: PfxOptions): HttpClientOptions

     Set the key/cert options in pfx format.

     Set the key/cert options in pfx format.

     Definition Classes
       HttpClientOptions → ClientOptionsBase → TCPSSLOptions
119.  def setPfxTrustOptions(value: PfxOptions): HttpClientOptions

     Set the trust options in pfx format

     Set the trust options in pfx format

     Definition Classes
       HttpClientOptions → ClientOptionsBase → TCPSSLOptions
120.  def setPipelining(value: Boolean): HttpClientOptions

     Set whether pipe-lining is enabled on the client

121.  def setPipeliningLimit(value: Int): HttpClientOptions

     Set the limit of pending requests a pipe-lined HTTP/1 connection can send.

122.  def setPoolCleanerPeriod(value: Int): HttpClientOptions

     Set the connection pool cleaner period in milli seconds, a non positive value disables expiration checks and connections will remain in the pool until they are closed.

123.  def setProtocolVersion(value: HttpVersion): HttpClientOptions

     Set the protocol version.

124.  def setProxyOptions(value: ProxyOptions): HttpClientOptions

     Set proxy options for connections via CONNECT proxy (e.g.

     Set proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy.

     Definition Classes
       HttpClientOptions → ClientOptionsBase
125.  def setReceiveBufferSize(value: Int): HttpClientOptions

     Set the TCP receive buffer size

     Set the TCP receive buffer size

     Definition Classes
       HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
126.  def setReuseAddress(value: Boolean): HttpClientOptions

     Set the value of reuse address

     Set the value of reuse address

     Definition Classes
       HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
127.  def setReusePort(value: Boolean): HttpClientOptions

     Set the value of reuse port.

     Set the value of reuse port.

     This is only supported by native transports.

     Definition Classes
       HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
128.  def setSendBufferSize(value: Int): HttpClientOptions

     Set the TCP send buffer size

     Set the TCP send buffer size

     Definition Classes
       HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
129.  def setSendUnmaskedFrames(value: Boolean): HttpClientOptions

     Set true when the client wants to skip frame masking.

     Set true when the client wants to skip frame masking. You may want to set it true on server by server websocket communication: In this case you are by passing RFC6455 protocol. It's false as default.

130.  def setSoLinger(value: Int): HttpClientOptions

     Set whether SO_linger keep alive is enabled

     Set whether SO_linger keep alive is enabled

     Definition Classes
       HttpClientOptions → ClientOptionsBase → TCPSSLOptions
131.  def setSsl(value: Boolean): HttpClientOptions

     Set whether SSL/TLS is enabled

     Set whether SSL/TLS is enabled

     Definition Classes
       HttpClientOptions → ClientOptionsBase → TCPSSLOptions
132.  def setTcpCork(value: Boolean): HttpClientOptions

     Enable the `TCP_CORK` option - only with linux native transport.

     Enable the `TCP_CORK` option - only with linux native transport.

     Definition Classes
       HttpClientOptions → ClientOptionsBase → TCPSSLOptions
133.  def setTcpFastOpen(value: Boolean): HttpClientOptions

     Enable the `TCP_FASTOPEN` option - only with linux native transport.

     Enable the `TCP_FASTOPEN` option - only with linux native transport.

     Definition Classes
       HttpClientOptions → ClientOptionsBase → TCPSSLOptions
134.  def setTcpKeepAlive(value: Boolean): HttpClientOptions

     Set whether TCP keep alive is enabled

     Set whether TCP keep alive is enabled

     Definition Classes
       HttpClientOptions → ClientOptionsBase → TCPSSLOptions
135.  def setTcpNoDelay(value: Boolean): HttpClientOptions

     Set whether TCP no delay is enabled

     Set whether TCP no delay is enabled

     Definition Classes
       HttpClientOptions → ClientOptionsBase → TCPSSLOptions
136.  def setTcpQuickAck(value: Boolean): HttpClientOptions

     Enable the `TCP_QUICKACK` option - only with linux native transport.

     Enable the `TCP_QUICKACK` option - only with linux native transport.

     Definition Classes
       HttpClientOptions → ClientOptionsBase → TCPSSLOptions
137.  def setTrafficClass(value: Int): HttpClientOptions

     Set the value of traffic class

     Set the value of traffic class

     Definition Classes
       HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
138.  def setTrustAll(value: Boolean): HttpClientOptions

     Set whether all server certificates should be trusted

     Set whether all server certificates should be trusted

     Definition Classes
       HttpClientOptions → ClientOptionsBase
139.  def setTrustStoreOptions(value: JksOptions): HttpClientOptions

     Set the trust options in jks format, aka Java truststore

     Set the trust options in jks format, aka Java truststore

     Definition Classes
       HttpClientOptions → ClientOptionsBase → TCPSSLOptions
140.  def setTryUseCompression(value: Boolean): HttpClientOptions

     Set whether compression is enabled

141.  def setTryUsePerFrameWebsocketCompression(value: Boolean): HttpClientOptions

     Set option to offer per frame WebSocket compression.

142.  def setTryUsePerMessageWebsocketCompression(value: Boolean): HttpClientOptions

     Set option to offer per message WebSocket compression.

143.  def setUseAlpn(value: Boolean): HttpClientOptions

     Set the ALPN usage.

     Set the ALPN usage.

     Definition Classes
       HttpClientOptions → ClientOptionsBase → TCPSSLOptions
144.  def setUsePooledBuffers(value: Boolean): HttpClientOptions

     Set whether Netty pooled buffers are enabled

     Set whether Netty pooled buffers are enabled

     Definition Classes
       HttpClientOptions → ClientOptionsBase → TCPSSLOptions
145.  def setVerifyHost(value: Boolean): HttpClientOptions

     Set whether hostname verification is enabled

146.  def setWebsocketCompressionAllowClientNoContext(value: Boolean): HttpClientOptions

     Set the WebSocket compression allow client no context option.

147.  def setWebsocketCompressionLevel(value: Int): HttpClientOptions

     Set WebSocket compression level

148.  def setWebsocketCompressionRequestServerNoContext(value: Boolean): HttpClientOptions

     Set the WebSocket compression server no context option

149.  final def synchronized[T0](arg0: ⇒ T0): T0
     Definition Classes
       AnyRef
150.  def toString(): String
     Definition Classes
       AnyRef → Any
151.  final def wait(): Unit
     Definition Classes
       AnyRef
     Annotations
       @throws( ... )
152.  final def wait(arg0: Long, arg1: Int): Unit
     Definition Classes
       AnyRef
     Annotations
       @throws( ... )
153.  final def wait(arg0: Long): Unit
     Definition Classes
       AnyRef
     Annotations
       @native() @throws( ... )

### Inherited from ClientOptionsBase

### Inherited from TCPSSLOptions

### Inherited from NetworkOptions

### Inherited from AnyRef

### Inherited from Any

### Ungrouped