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

# 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, 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

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

   Add an enabled SSL/TLS protocols, appended to the ordered 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
      @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
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 getHttp2MaxPoolSize: Int
26.  def getHttp2MultiplexingLimit: Int
27.  def getIdleTimeout: Int
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
28.  def getInitialSettings: Http2Settings
29.  def getJdkSslEngineOptions: JdkSSLEngineOptions
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
30.  def getKeyStoreOptions: JksOptions
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
31.  def getLocalAddress: String
    Definition Classes
      HttpClientOptions → ClientOptionsBase
32.  def getLogActivity: Boolean
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
33.  def getMaxChunkSize: Int
34.  def getMaxHeaderSize: Int
35.  def getMaxInitialLineLength: Int
36.  def getMaxPoolSize: Int
37.  def getMaxRedirects: Int
38.  def getMaxWaitQueueSize: Int
39.  def getMaxWebsocketFrameSize: Int
40.  def getMaxWebsocketMessageSize: Int
41.  def getMetricsName: String
    Definition Classes
      HttpClientOptions → ClientOptionsBase
42.  def getOpenSslEngineOptions: OpenSSLEngineOptions
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
43.  def getPemKeyCertOptions: PemKeyCertOptions
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
44.  def getPemTrustOptions: PemTrustOptions
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
45.  def getPfxKeyCertOptions: PfxOptions
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
46.  def getPfxTrustOptions: PfxOptions
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
47.  def getPipeliningLimit: Int
48.  def getProtocolVersion: HttpVersion
49.  def getProxyOptions: ProxyOptions
    Definition Classes
      HttpClientOptions → ClientOptionsBase
50.  def getReceiveBufferSize: Int
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
51.  def getSendBufferSize: Int
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
52.  def getSoLinger: Int
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
53.  def getTrafficClass: Int
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
54.  def getTrustStoreOptions: JksOptions
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
55.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
56.  def isForceSni: Boolean
57.  def isHttp2ClearTextUpgrade: Boolean
58.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
59.  def isKeepAlive: Boolean
60.  def isPipelining: Boolean
61.  def isReuseAddress: Boolean
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
62.  def isSendUnmaskedFrames: Boolean
63.  def isSsl: Boolean
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
64.  def isTcpKeepAlive: Boolean
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
65.  def isTcpNoDelay: Boolean
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
66.  def isTrustAll: Boolean
    Definition Classes
      HttpClientOptions → ClientOptionsBase
67.  def isTryUseCompression: Boolean
68.  def isUseAlpn: Boolean
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
69.  def isUsePooledBuffers: Boolean
    Definition Classes
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
70.  def isVerifyHost: Boolean
71.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
72.  final def notify(): Unit
    Definition Classes
      AnyRef
73.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
74.  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]
75.  def setConnectTimeout(value: Int): HttpClientOptions

    Set the connect timeout

    Set the connect timeout

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

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

77.  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.

78.  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.

79.  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.

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

81.  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.

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

    Set the maximum pool size for HTTP/2 connections

83.  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.

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

    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
      HttpClientOptions → ClientOptionsBase → TCPSSLOptions
85.  def setInitialSettings(value: Http2Settings): HttpClientOptions

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

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

    Set whether keep alive is enabled on the client

88.  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
89.  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
90.  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
91.  def setMaxChunkSize(value: Int): HttpClientOptions

    Set the maximum HTTP chunk size

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

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

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

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

    Set the maximum pool size for connections

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

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

96.  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.

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

    Set the max websocket frame size

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

    Set the max websocket message size

99.  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
100.  def setOpenSslEngineOptions(value: OpenSSLEngineOptions): HttpClientOptions
     Definition Classes
       HttpClientOptions → ClientOptionsBase → TCPSSLOptions
101.  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
102.  def setPemTrustOptions(value: PemTrustOptions): HttpClientOptions

     Set the trust options in pem format

     Set the trust options in pem format

     Definition Classes
       HttpClientOptions → ClientOptionsBase → TCPSSLOptions
103.  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
104.  def setPfxTrustOptions(value: PfxOptions): HttpClientOptions

     Set the trust options in pfx format

     Set the trust options in pfx format

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

     Set whether pipe-lining is enabled on the client

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

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

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

     Set the protocol version.

108.  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
109.  def setReceiveBufferSize(value: Int): HttpClientOptions

     Set the TCP receive buffer size

     Set the TCP receive buffer size

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

     Set the value of reuse address

     Set the value of reuse address

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

     Set the TCP send buffer size

     Set the TCP send buffer size

     Definition Classes
       HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
112.  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.

113.  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
114.  def setSsl(value: Boolean): HttpClientOptions

     Set whether SSL/TLS is enabled

     Set whether SSL/TLS is enabled

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

     Set whether TCP keep alive is enabled

     Set whether TCP keep alive is enabled

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

     Set whether TCP no delay is enabled

     Set whether TCP no delay is enabled

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

     Set the value of traffic class

     Set the value of traffic class

     Definition Classes
       HttpClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
118.  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
119.  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
120.  def setTryUseCompression(value: Boolean): HttpClientOptions

     Set whether compression is enabled

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

     Set the ALPN usage.

     Set the ALPN usage.

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

     Set whether Netty pooled buffers are enabled

     Set whether Netty pooled buffers are enabled

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

     Set whether hostname verification is enabled

124.  final def synchronized[T0](arg0: ⇒ T0): T0
     Definition Classes
       AnyRef
125.  def toString(): String
     Definition Classes
       AnyRef → Any
126.  final def wait(): Unit
     Definition Classes
       AnyRef
     Annotations
       @throws( ... )
127.  final def wait(arg0: Long, arg1: Int): Unit
     Definition Classes
       AnyRef
     Annotations
       @throws( ... )
128.  final def wait(arg0: Long): Unit
     Definition Classes
       AnyRef
     Annotations
       @throws( ... )

### Inherited from ClientOptionsBase

### Inherited from TCPSSLOptions

### Inherited from NetworkOptions

### Inherited from AnyRef

### Inherited from Any

### Ungrouped