class HttpClientOptions extends ClientOptionsBase

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

Linear Supertypes
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
    HttpClientOptionsTCPSSLOptions
  5. def addCrlValue(value: Buffer): HttpClientOptions

    Add a CRL value

    Add a CRL value

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

    Sets the list of enabled SSL/TLS protocols.

    Sets the list of enabled SSL/TLS protocols.

    Definition Classes
    HttpClientOptionsTCPSSLOptions
  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
    HttpClientOptionsClientOptionsBase
  17. def getCrlPaths: Buffer[String]
    Definition Classes
    HttpClientOptionsTCPSSLOptions
  18. def getCrlValues: Buffer[Buffer]
    Definition Classes
    HttpClientOptionsTCPSSLOptions
  19. def getDecoderInitialBufferSize: Int
  20. def getDefaultHost: String
  21. def getDefaultPort: Int
  22. def getEnabledCipherSuites: Set[String]
    Definition Classes
    HttpClientOptionsTCPSSLOptions
  23. def getEnabledSecureTransportProtocols: Set[String]
    Definition Classes
    HttpClientOptionsTCPSSLOptions
  24. def getHttp2ConnectionWindowSize: Int
  25. def getHttp2KeepAliveTimeout: Int
  26. def getHttp2MaxPoolSize: Int
  27. def getHttp2MultiplexingLimit: Int
  28. def getIdleTimeout: Int
    Definition Classes
    HttpClientOptionsTCPSSLOptions
  29. def getIdleTimeoutUnit: TimeUnit
    Definition Classes
    HttpClientOptionsTCPSSLOptions
  30. def getInitialSettings: Http2Settings
  31. def getJdkSslEngineOptions: JdkSSLEngineOptions
    Definition Classes
    HttpClientOptionsTCPSSLOptions
  32. def getKeepAliveTimeout: Int
  33. def getKeyStoreOptions: JksOptions
    Definition Classes
    HttpClientOptionsTCPSSLOptions
  34. def getLocalAddress: String
    Definition Classes
    HttpClientOptionsClientOptionsBase
  35. def getLogActivity: Boolean
    Definition Classes
    HttpClientOptionsNetworkOptions
  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 getMaxWebsocketFrameSize: Int
  45. def getMaxWebsocketMessageSize: Int
  46. def getMetricsName: String
    Definition Classes
    HttpClientOptionsClientOptionsBase
  47. def getOpenSslEngineOptions: OpenSSLEngineOptions
    Definition Classes
    HttpClientOptionsTCPSSLOptions
  48. def getPemKeyCertOptions: PemKeyCertOptions
    Definition Classes
    HttpClientOptionsTCPSSLOptions
  49. def getPemTrustOptions: PemTrustOptions
    Definition Classes
    HttpClientOptionsTCPSSLOptions
  50. def getPfxKeyCertOptions: PfxOptions
    Definition Classes
    HttpClientOptionsTCPSSLOptions
  51. def getPfxTrustOptions: PfxOptions
    Definition Classes
    HttpClientOptionsTCPSSLOptions
  52. def getPipeliningLimit: Int
  53. def getPoolCleanerPeriod: Int
  54. def getProtocolVersion: HttpVersion
  55. def getProxyOptions: ProxyOptions
    Definition Classes
    HttpClientOptionsClientOptionsBase
  56. def getReceiveBufferSize: Int
    Definition Classes
    HttpClientOptionsNetworkOptions
  57. def getSendBufferSize: Int
    Definition Classes
    HttpClientOptionsNetworkOptions
  58. def getSoLinger: Int
    Definition Classes
    HttpClientOptionsTCPSSLOptions
  59. def getSslHandshakeTimeout: Long
    Definition Classes
    HttpClientOptionsTCPSSLOptions
  60. def getSslHandshakeTimeoutUnit: TimeUnit
    Definition Classes
    HttpClientOptionsTCPSSLOptions
  61. def getTrafficClass: Int
    Definition Classes
    HttpClientOptionsNetworkOptions
  62. def getTrustStoreOptions: JksOptions
    Definition Classes
    HttpClientOptionsTCPSSLOptions
  63. def getTryUsePerMessageWebSocketCompression: Boolean
  64. def getTryUsePerMessageWebsocketCompression: Boolean
  65. def getWebSocketCompressionAllowClientNoContext: Boolean
  66. def getWebSocketCompressionLevel: Int
  67. def getWebSocketCompressionRequestServerNoContext: Boolean
  68. def getWebsocketCompressionAllowClientNoContext: Boolean
  69. def getWebsocketCompressionLevel: Int
  70. def getWebsocketCompressionRequestServerNoContext: Boolean
  71. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  72. def isForceSni: Boolean
  73. def isHttp2ClearTextUpgrade: Boolean
  74. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  75. def isKeepAlive: Boolean
  76. def isPipelining: Boolean
  77. def isReuseAddress: Boolean
    Definition Classes
    HttpClientOptionsNetworkOptions
  78. def isReusePort: Boolean
    Definition Classes
    HttpClientOptionsNetworkOptions
  79. def isSendUnmaskedFrames: Boolean
  80. def isSsl: Boolean
    Definition Classes
    HttpClientOptionsTCPSSLOptions
  81. def isTcpCork: Boolean
    Definition Classes
    HttpClientOptionsTCPSSLOptions
  82. def isTcpFastOpen: Boolean
    Definition Classes
    HttpClientOptionsTCPSSLOptions
  83. def isTcpKeepAlive: Boolean
    Definition Classes
    HttpClientOptionsTCPSSLOptions
  84. def isTcpNoDelay: Boolean
    Definition Classes
    HttpClientOptionsTCPSSLOptions
  85. def isTcpQuickAck: Boolean
    Definition Classes
    HttpClientOptionsTCPSSLOptions
  86. def isTrustAll: Boolean
    Definition Classes
    HttpClientOptionsClientOptionsBase
  87. def isTryUseCompression: Boolean
  88. def isUseAlpn: Boolean
    Definition Classes
    HttpClientOptionsTCPSSLOptions
  89. def isUsePooledBuffers: Boolean
    Definition Classes
    HttpClientOptionsTCPSSLOptions
  90. def isVerifyHost: Boolean
  91. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  92. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  93. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  94. 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:

  95. def setConnectTimeout(value: Int): HttpClientOptions

    Set the connect timeout

    Set the connect timeout

    Definition Classes
    HttpClientOptionsClientOptionsBase
  96. def setDecoderInitialBufferSize(value: Int): HttpClientOptions

    set to initialBufferSizeHttpDecoder the initial buffer of the HttpDecoder.

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

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

  99. def setEnabledSecureTransportProtocols(value: Set[String]): HttpClientOptions
    Definition Classes
    HttpClientOptionsTCPSSLOptions
  100. 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.

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

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

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

  104. def setHttp2MaxPoolSize(value: Int): HttpClientOptions

    Set the maximum pool size for HTTP/2 connections

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

  106. 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
    HttpClientOptionsTCPSSLOptions
  107. def setIdleTimeoutUnit(value: TimeUnit): HttpClientOptions

    Set the idle timeout unit.

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

    Definition Classes
    HttpClientOptionsTCPSSLOptions
  108. def setInitialSettings(value: Http2Settings): HttpClientOptions

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

  109. def setJdkSslEngineOptions(value: JdkSSLEngineOptions): HttpClientOptions
    Definition Classes
    HttpClientOptionsTCPSSLOptions
  110. def setKeepAlive(value: Boolean): HttpClientOptions

    Set whether keep alive is enabled on the client

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

  112. 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
    HttpClientOptionsTCPSSLOptions
  113. 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
    HttpClientOptionsClientOptionsBase
  114. 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
    HttpClientOptionsNetworkOptions
  115. def setMaxChunkSize(value: Int): HttpClientOptions

    Set the maximum HTTP chunk size

  116. def setMaxHeaderSize(value: Int): HttpClientOptions

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

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

  118. def setMaxPoolSize(value: Int): HttpClientOptions

    Set the maximum pool size for connections

  119. def setMaxRedirects(value: Int): HttpClientOptions

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

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

  121. def setMaxWebSocketFrameSize(value: Int): HttpClientOptions

    Set the max WebSocket frame size

  122. def setMaxWebSocketMessageSize(value: Int): HttpClientOptions

    Set the max WebSocket message size

  123. def setMaxWebsocketFrameSize(value: Int): HttpClientOptions

    Set the max WebSocket frame size

  124. def setMaxWebsocketMessageSize(value: Int): HttpClientOptions

    Set the max WebSocket message size

  125. 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
    HttpClientOptionsClientOptionsBase
  126. def setOpenSslEngineOptions(value: OpenSSLEngineOptions): HttpClientOptions
    Definition Classes
    HttpClientOptionsTCPSSLOptions
  127. 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
    HttpClientOptionsTCPSSLOptions
  128. def setPemTrustOptions(value: PemTrustOptions): HttpClientOptions

    Set the trust options in pem format

    Set the trust options in pem format

    Definition Classes
    HttpClientOptionsTCPSSLOptions
  129. def setPfxKeyCertOptions(value: PfxOptions): HttpClientOptions

    Set the key/cert options in pfx format.

    Set the key/cert options in pfx format.

    Definition Classes
    HttpClientOptionsTCPSSLOptions
  130. def setPfxTrustOptions(value: PfxOptions): HttpClientOptions

    Set the trust options in pfx format

    Set the trust options in pfx format

    Definition Classes
    HttpClientOptionsTCPSSLOptions
  131. def setPipelining(value: Boolean): HttpClientOptions

    Set whether pipe-lining is enabled on the client

  132. def setPipeliningLimit(value: Int): HttpClientOptions

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

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

  134. def setProtocolVersion(value: HttpVersion): HttpClientOptions

    Set the protocol version.

  135. 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
    HttpClientOptionsClientOptionsBase
  136. def setReceiveBufferSize(value: Int): HttpClientOptions

    Set the TCP receive buffer size

    Set the TCP receive buffer size

    Definition Classes
    HttpClientOptionsNetworkOptions
  137. def setReuseAddress(value: Boolean): HttpClientOptions

    Set the value of reuse address

    Set the value of reuse address

    Definition Classes
    HttpClientOptionsNetworkOptions
  138. 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
    HttpClientOptionsNetworkOptions
  139. def setSendBufferSize(value: Int): HttpClientOptions

    Set the TCP send buffer size

    Set the TCP send buffer size

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

  141. def setSoLinger(value: Int): HttpClientOptions

    Set whether SO_linger keep alive is enabled

    Set whether SO_linger keep alive is enabled

    Definition Classes
    HttpClientOptionsTCPSSLOptions
  142. def setSsl(value: Boolean): HttpClientOptions

    Set whether SSL/TLS is enabled

    Set whether SSL/TLS is enabled

    Definition Classes
    HttpClientOptionsTCPSSLOptions
  143. def setSslHandshakeTimeout(value: Long): HttpClientOptions

    Set the SSL handshake timeout, default time unit is seconds.

    Set the SSL handshake timeout, default time unit is seconds.

    Definition Classes
    HttpClientOptionsTCPSSLOptions
  144. def setSslHandshakeTimeoutUnit(value: TimeUnit): HttpClientOptions

    Set the SSL handshake timeout unit.

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

    Definition Classes
    HttpClientOptionsTCPSSLOptions
  145. 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
    HttpClientOptionsTCPSSLOptions
  146. 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
    HttpClientOptionsTCPSSLOptions
  147. def setTcpKeepAlive(value: Boolean): HttpClientOptions

    Set whether TCP keep alive is enabled

    Set whether TCP keep alive is enabled

    Definition Classes
    HttpClientOptionsTCPSSLOptions
  148. def setTcpNoDelay(value: Boolean): HttpClientOptions

    Set whether TCP no delay is enabled

    Set whether TCP no delay is enabled

    Definition Classes
    HttpClientOptionsTCPSSLOptions
  149. 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
    HttpClientOptionsTCPSSLOptions
  150. def setTrafficClass(value: Int): HttpClientOptions

    Set the value of traffic class

    Set the value of traffic class

    Definition Classes
    HttpClientOptionsNetworkOptions
  151. def setTrustAll(value: Boolean): HttpClientOptions

    Set whether all server certificates should be trusted

    Set whether all server certificates should be trusted

    Definition Classes
    HttpClientOptionsClientOptionsBase
  152. 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
    HttpClientOptionsTCPSSLOptions
  153. def setTryUseCompression(value: Boolean): HttpClientOptions

    Set whether compression is enabled

  154. def setTryUsePerFrameWebSocketCompression(value: Boolean): HttpClientOptions

    Set whether the client will offer the WebSocket per-frame deflate compression extension.

  155. def setTryUsePerFrameWebsocketCompression(value: Boolean): HttpClientOptions

    Set whether the client will offer the WebSocket per-frame deflate compression extension.

  156. def setTryUsePerMessageWebSocketCompression(value: Boolean): HttpClientOptions

    Set whether the client will offer the WebSocket per-message deflate compression extension.

  157. def setTryUsePerMessageWebsocketCompression(value: Boolean): HttpClientOptions

    Set whether the client will offer the WebSocket per-message deflate compression extension.

  158. def setUseAlpn(value: Boolean): HttpClientOptions

    Set the ALPN usage.

    Set the ALPN usage.

    Definition Classes
    HttpClientOptionsTCPSSLOptions
  159. def setUsePooledBuffers(value: Boolean): HttpClientOptions

    Set whether Netty pooled buffers are enabled

    Set whether Netty pooled buffers are enabled

    Definition Classes
    HttpClientOptionsTCPSSLOptions
  160. def setVerifyHost(value: Boolean): HttpClientOptions

    Set whether hostname verification is enabled

  161. def setWebSocketCompressionAllowClientNoContext(value: Boolean): HttpClientOptions

    Set whether the client_no_context_takeover parameter of the WebSocket per-message deflate compression extension will be offered.

  162. def setWebSocketCompressionLevel(value: Int): HttpClientOptions

    Set the WebSocket deflate compression level.

  163. def setWebSocketCompressionRequestServerNoContext(value: Boolean): HttpClientOptions

    Set whether the server_no_context_takeover parameter of the WebSocket per-message deflate compression extension will be offered.

  164. def setWebsocketCompressionAllowClientNoContext(value: Boolean): HttpClientOptions

    Set whether the client_no_context_takeover parameter of the WebSocket per-message deflate compression extension will be offered.

  165. def setWebsocketCompressionLevel(value: Int): HttpClientOptions

    Set the WebSocket deflate compression level.

  166. def setWebsocketCompressionRequestServerNoContext(value: Boolean): HttpClientOptions

    Set whether the server_no_context_takeover parameter of the WebSocket per-message deflate compression extension will be offered.

  167. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  168. def toString(): String
    Definition Classes
    AnyRef → Any
  169. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  170. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  171. 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