Packages

class WebClientOptions extends HttpClientOptions

Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WebClientOptions
  2. HttpClientOptions
  3. ClientOptionsBase
  4. TCPSSLOptions
  5. NetworkOptions
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WebClientOptions(_asJava: ext.web.client.WebClientOptions)

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

    Add a CRL path

    Add a CRL path

    Definition Classes
    WebClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  5. def addCrlValue(value: Buffer): WebClientOptions

    Add a CRL value

    Add a CRL value

    Definition Classes
    WebClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  6. def addEnabledCipherSuite(value: String): WebClientOptions

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

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

    Definition Classes
    WebClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  7. def addEnabledSecureTransportProtocol(value: String): WebClientOptions

    Sets the list of enabled SSL/TLS protocols.

    Sets the list of enabled SSL/TLS protocols.

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

    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:

    Definition Classes
    WebClientOptionsHttpClientOptions
  85. def setConnectTimeout(value: Int): WebClientOptions

    Set the connect timeout

    Set the connect timeout

    Definition Classes
    WebClientOptionsHttpClientOptionsClientOptionsBase
  86. def setDecoderInitialBufferSize(value: Int): WebClientOptions

    set to initialBufferSizeHttpDecoder the initial buffer of the HttpDecoder.

    set to initialBufferSizeHttpDecoder the initial buffer of the HttpDecoder.

    Definition Classes
    WebClientOptionsHttpClientOptions
  87. def setDefaultHost(value: String): WebClientOptions

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

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

    Definition Classes
    WebClientOptionsHttpClientOptions
  88. def setDefaultPort(value: Int): WebClientOptions

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

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

    Definition Classes
    WebClientOptionsHttpClientOptions
  89. def setEnabledSecureTransportProtocols(value: Set[String]): WebClientOptions
  90. def setFollowRedirects(value: Boolean): WebClientOptions

    Configure the default behavior of the client to follow HTTP 30x redirections.

  91. def setForceSni(value: Boolean): WebClientOptions

    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.

    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.

    Definition Classes
    WebClientOptionsHttpClientOptions
  92. def setHttp2ClearTextUpgrade(value: Boolean): WebClientOptions

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

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

    Definition Classes
    WebClientOptionsHttpClientOptions
  93. def setHttp2ConnectionWindowSize(value: Int): WebClientOptions

    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
    WebClientOptionsHttpClientOptions
  94. def setHttp2KeepAliveTimeout(value: Int): WebClientOptions

    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.

    Definition Classes
    WebClientOptionsHttpClientOptions
  95. def setHttp2MaxPoolSize(value: Int): WebClientOptions

    Set the maximum pool size for HTTP/2 connections

    Set the maximum pool size for HTTP/2 connections

    Definition Classes
    WebClientOptionsHttpClientOptions
  96. def setHttp2MultiplexingLimit(value: Int): WebClientOptions

    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.

    Definition Classes
    WebClientOptionsHttpClientOptions
  97. def setIdleTimeout(value: Int): WebClientOptions

    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
    WebClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  98. def setInitialSettings(value: Http2Settings): WebClientOptions

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

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

    Definition Classes
    WebClientOptionsHttpClientOptions
  99. def setJdkSslEngineOptions(value: JdkSSLEngineOptions): WebClientOptions
  100. def setKeepAlive(value: Boolean): WebClientOptions

    Set whether keep alive is enabled on the client

    Set whether keep alive is enabled on the client

    Definition Classes
    WebClientOptionsHttpClientOptions
  101. def setKeepAliveTimeout(value: Int): WebClientOptions

    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.

    Definition Classes
    WebClientOptionsHttpClientOptions
  102. def setKeyStoreOptions(value: JksOptions): WebClientOptions

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

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

    Definition Classes
    WebClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  103. def setLocalAddress(value: String): WebClientOptions

    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
    WebClientOptionsHttpClientOptionsClientOptionsBase
  104. def setLogActivity(value: Boolean): WebClientOptions

    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
    WebClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptionsNetworkOptions
  105. def setMaxChunkSize(value: Int): WebClientOptions

    Set the maximum HTTP chunk size

    Set the maximum HTTP chunk size

    Definition Classes
    WebClientOptionsHttpClientOptions
  106. def setMaxHeaderSize(value: Int): WebClientOptions

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

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

    Definition Classes
    WebClientOptionsHttpClientOptions
  107. def setMaxInitialLineLength(value: Int): WebClientOptions

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

    Definition Classes
    WebClientOptionsHttpClientOptions
  108. def setMaxPoolSize(value: Int): WebClientOptions

    Set the maximum pool size for connections

    Set the maximum pool size for connections

    Definition Classes
    WebClientOptionsHttpClientOptions
  109. def setMaxRedirects(value: Int): WebClientOptions

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

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

    Definition Classes
    WebClientOptionsHttpClientOptions
  110. def setMaxWaitQueueSize(value: Int): WebClientOptions

    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.

    Definition Classes
    WebClientOptionsHttpClientOptions
  111. def setMaxWebsocketFrameSize(value: Int): WebClientOptions

    Set the max websocket frame size

    Set the max websocket frame size

    Definition Classes
    WebClientOptionsHttpClientOptions
  112. def setMaxWebsocketMessageSize(value: Int): WebClientOptions

    Set the max websocket message size

    Set the max websocket message size

    Definition Classes
    WebClientOptionsHttpClientOptions
  113. def setMetricsName(value: String): WebClientOptions

    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
    WebClientOptionsHttpClientOptionsClientOptionsBase
  114. def setOpenSslEngineOptions(value: OpenSSLEngineOptions): WebClientOptions
  115. def setPemKeyCertOptions(value: PemKeyCertOptions): WebClientOptions

    Set the key/cert store options in pem format.

    Set the key/cert store options in pem format.

    Definition Classes
    WebClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  116. def setPemTrustOptions(value: PemTrustOptions): WebClientOptions

    Set the trust options in pem format

    Set the trust options in pem format

    Definition Classes
    WebClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  117. def setPfxKeyCertOptions(value: PfxOptions): WebClientOptions

    Set the key/cert options in pfx format.

    Set the key/cert options in pfx format.

    Definition Classes
    WebClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  118. def setPfxTrustOptions(value: PfxOptions): WebClientOptions

    Set the trust options in pfx format

    Set the trust options in pfx format

    Definition Classes
    WebClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  119. def setPipelining(value: Boolean): WebClientOptions

    Set whether pipe-lining is enabled on the client

    Set whether pipe-lining is enabled on the client

    Definition Classes
    WebClientOptionsHttpClientOptions
  120. def setPipeliningLimit(value: Int): WebClientOptions

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

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

    Definition Classes
    WebClientOptionsHttpClientOptions
  121. def setPoolCleanerPeriod(value: Int): WebClientOptions

    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.

    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.

    Definition Classes
    WebClientOptionsHttpClientOptions
  122. def setProtocolVersion(value: HttpVersion): WebClientOptions

    Set the protocol version.

    Set the protocol version.

    Definition Classes
    WebClientOptionsHttpClientOptions
  123. def setProxyOptions(value: ProxyOptions): WebClientOptions

    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
    WebClientOptionsHttpClientOptionsClientOptionsBase
  124. def setReceiveBufferSize(value: Int): WebClientOptions

    Set the TCP receive buffer size

    Set the TCP receive buffer size

    Definition Classes
    WebClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptionsNetworkOptions
  125. def setReuseAddress(value: Boolean): WebClientOptions

    Set the value of reuse address

    Set the value of reuse address

    Definition Classes
    WebClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptionsNetworkOptions
  126. def setReusePort(value: Boolean): WebClientOptions

    Set the value of reuse port.

    Set the value of reuse port.

    This is only supported by native transports.

    Definition Classes
    WebClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptionsNetworkOptions
  127. def setSendBufferSize(value: Int): WebClientOptions

    Set the TCP send buffer size

    Set the TCP send buffer size

    Definition Classes
    WebClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptionsNetworkOptions
  128. def setSendUnmaskedFrames(value: Boolean): WebClientOptions

    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.

    Definition Classes
    WebClientOptionsHttpClientOptions
  129. def setSoLinger(value: Int): WebClientOptions

    Set whether SO_linger keep alive is enabled

    Set whether SO_linger keep alive is enabled

    Definition Classes
    WebClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  130. def setSsl(value: Boolean): WebClientOptions

    Set whether SSL/TLS is enabled

    Set whether SSL/TLS is enabled

    Definition Classes
    WebClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  131. def setTcpCork(value: Boolean): WebClientOptions

    Enable the TCP_CORK option - only with linux native transport.

    Enable the TCP_CORK option - only with linux native transport.

    Definition Classes
    WebClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  132. def setTcpFastOpen(value: Boolean): WebClientOptions

    Enable the TCP_FASTOPEN option - only with linux native transport.

    Enable the TCP_FASTOPEN option - only with linux native transport.

    Definition Classes
    WebClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  133. def setTcpKeepAlive(value: Boolean): WebClientOptions

    Set whether TCP keep alive is enabled

    Set whether TCP keep alive is enabled

    Definition Classes
    WebClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  134. def setTcpNoDelay(value: Boolean): WebClientOptions

    Set whether TCP no delay is enabled

    Set whether TCP no delay is enabled

    Definition Classes
    WebClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  135. def setTcpQuickAck(value: Boolean): WebClientOptions

    Enable the TCP_QUICKACK option - only with linux native transport.

    Enable the TCP_QUICKACK option - only with linux native transport.

    Definition Classes
    WebClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  136. def setTrafficClass(value: Int): WebClientOptions

    Set the value of traffic class

    Set the value of traffic class

    Definition Classes
    WebClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptionsNetworkOptions
  137. def setTrustAll(value: Boolean): WebClientOptions

    Set whether all server certificates should be trusted

    Set whether all server certificates should be trusted

    Definition Classes
    WebClientOptionsHttpClientOptionsClientOptionsBase
  138. def setTrustStoreOptions(value: JksOptions): WebClientOptions

    Set the trust options in jks format, aka Java truststore

    Set the trust options in jks format, aka Java truststore

    Definition Classes
    WebClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  139. def setTryUseCompression(value: Boolean): WebClientOptions

    Set whether compression is enabled

    Set whether compression is enabled

    Definition Classes
    WebClientOptionsHttpClientOptions
  140. def setUseAlpn(value: Boolean): WebClientOptions

    Set the ALPN usage.

    Set the ALPN usage.

    Definition Classes
    WebClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  141. def setUsePooledBuffers(value: Boolean): WebClientOptions

    Set whether Netty pooled buffers are enabled

    Set whether Netty pooled buffers are enabled

    Definition Classes
    WebClientOptionsHttpClientOptionsClientOptionsBaseTCPSSLOptions
  142. def setUserAgent(value: String): WebClientOptions

    Sets the Web Client user agent header.

    Sets the Web Client user agent header. Defaults to Vert.x-WebClient/<version>.

  143. def setUserAgentEnabled(value: Boolean): WebClientOptions

    Sets whether the Web Client should send a user agent header.

    Sets whether the Web Client should send a user agent header. Defaults to true.

  144. def setVerifyHost(value: Boolean): WebClientOptions

    Set whether hostname verification is enabled

    Set whether hostname verification is enabled

    Definition Classes
    WebClientOptionsHttpClientOptions
  145. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  146. def toString(): String
    Definition Classes
    AnyRef → Any
  147. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  148. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  149. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from HttpClientOptions

Inherited from ClientOptionsBase

Inherited from TCPSSLOptions

Inherited from NetworkOptions

Inherited from AnyRef

Inherited from Any

Ungrouped