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

    Add a CRL value

    Add a CRL value

    Definition Classes
    HttpClientOptionsClientOptionsBaseTCPSSLOptions
  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
    HttpClientOptionsClientOptionsBaseTCPSSLOptions
  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
    HttpClientOptionsClientOptionsBaseTCPSSLOptions
  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
    HttpClientOptionsClientOptionsBase
  17. def getCrlPaths: Buffer[String]
  18. def getCrlValues: Buffer[Buffer]
  19. def getDefaultHost: String
  20. def getDefaultPort: Int
  21. def getEnabledCipherSuites: Set[String]
  22. def getEnabledSecureTransportProtocols: Set[String]
  23. def getHttp2ConnectionWindowSize: Int
  24. def getHttp2MaxPoolSize: Int
  25. def getHttp2MultiplexingLimit: Int
  26. def getIdleTimeout: Int
  27. def getInitialSettings: Http2Settings
  28. def getJdkSslEngineOptions: JdkSSLEngineOptions
  29. def getKeyStoreOptions: JksOptions
  30. def getLocalAddress: String
    Definition Classes
    HttpClientOptionsClientOptionsBase
  31. def getLogActivity: Boolean
  32. def getMaxChunkSize: Int
  33. def getMaxHeaderSize: Int
  34. def getMaxInitialLineLength: Int
  35. def getMaxPoolSize: Int
  36. def getMaxRedirects: Int
  37. def getMaxWaitQueueSize: Int
  38. def getMaxWebsocketFrameSize: Int
  39. def getMaxWebsocketMessageSize: Int
  40. def getMetricsName: String
    Definition Classes
    HttpClientOptionsClientOptionsBase
  41. def getOpenSslEngineOptions: OpenSSLEngineOptions
  42. def getPemKeyCertOptions: PemKeyCertOptions
  43. def getPemTrustOptions: PemTrustOptions
  44. def getPfxKeyCertOptions: PfxOptions
  45. def getPfxTrustOptions: PfxOptions
  46. def getPipeliningLimit: Int
  47. def getProtocolVersion: HttpVersion
  48. def getProxyOptions: ProxyOptions
    Definition Classes
    HttpClientOptionsClientOptionsBase
  49. def getReceiveBufferSize: Int
  50. def getSendBufferSize: Int
  51. def getSoLinger: Int
  52. def getTrafficClass: Int
  53. def getTrustStoreOptions: JksOptions
  54. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  55. def isHttp2ClearTextUpgrade: Boolean
  56. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  57. def isKeepAlive: Boolean
  58. def isPipelining: Boolean
  59. def isReuseAddress: Boolean
  60. def isSendUnmaskedFrames: Boolean
  61. def isSsl: Boolean
  62. def isTcpKeepAlive: Boolean
  63. def isTcpNoDelay: Boolean
  64. def isTrustAll: Boolean
    Definition Classes
    HttpClientOptionsClientOptionsBase
  65. def isTryUseCompression: Boolean
  66. def isUseAlpn: Boolean
  67. def isUsePooledBuffers: Boolean
  68. def isVerifyHost: Boolean
  69. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  70. final def notify(): Unit
    Definition Classes
    AnyRef
  71. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  72. def 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:

  73. def setConnectTimeout(value: Int): HttpClientOptions

    Set the connect timeout

    Set the connect timeout

    Definition Classes
    HttpClientOptionsClientOptionsBase
  74. 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.

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

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

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

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

  78. def setHttp2MaxPoolSize(value: Int): HttpClientOptions

    Set the maximum pool size for HTTP/2 connections

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

  80. 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
    HttpClientOptionsClientOptionsBaseTCPSSLOptions
  81. def setInitialSettings(value: Http2Settings): HttpClientOptions

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

  82. def setJdkSslEngineOptions(value: JdkSSLEngineOptions): HttpClientOptions
  83. def setKeepAlive(value: Boolean): HttpClientOptions

    Set whether keep alive is enabled on the client

  84. 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
    HttpClientOptionsClientOptionsBaseTCPSSLOptions
  85. 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
  86. 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
    HttpClientOptionsClientOptionsBaseTCPSSLOptionsNetworkOptions
  87. def setMaxChunkSize(value: Int): HttpClientOptions

    Set the maximum HTTP chunk size

  88. def setMaxHeaderSize(value: Int): HttpClientOptions

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

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

  90. def setMaxPoolSize(value: Int): HttpClientOptions

    Set the maximum pool size for connections

  91. def setMaxRedirects(value: Int): HttpClientOptions

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

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

  93. def setMaxWebsocketFrameSize(value: Int): HttpClientOptions

    Set the max websocket frame size

  94. def setMaxWebsocketMessageSize(value: Int): HttpClientOptions

    Set the max websocket message size

  95. 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
  96. def setOpenSslEngineOptions(value: OpenSSLEngineOptions): HttpClientOptions
  97. 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
    HttpClientOptionsClientOptionsBaseTCPSSLOptions
  98. def setPemTrustOptions(value: PemTrustOptions): HttpClientOptions

    Set the trust options in pem format

    Set the trust options in pem format

    Definition Classes
    HttpClientOptionsClientOptionsBaseTCPSSLOptions
  99. def setPfxKeyCertOptions(value: PfxOptions): HttpClientOptions

    Set the key/cert options in pfx format.

    Set the key/cert options in pfx format.

    Definition Classes
    HttpClientOptionsClientOptionsBaseTCPSSLOptions
  100. def setPfxTrustOptions(value: PfxOptions): HttpClientOptions

    Set the trust options in pfx format

    Set the trust options in pfx format

    Definition Classes
    HttpClientOptionsClientOptionsBaseTCPSSLOptions
  101. def setPipelining(value: Boolean): HttpClientOptions

    Set whether pipe-lining is enabled on the client

  102. def setPipeliningLimit(value: Int): HttpClientOptions

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

  103. def setProtocolVersion(value: HttpVersion): HttpClientOptions

    Set the protocol version.

  104. 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
  105. def setReceiveBufferSize(value: Int): HttpClientOptions

    Set the TCP receive buffer size

    Set the TCP receive buffer size

    Definition Classes
    HttpClientOptionsClientOptionsBaseTCPSSLOptionsNetworkOptions
  106. def setReuseAddress(value: Boolean): HttpClientOptions

    Set the value of reuse address

    Set the value of reuse address

    Definition Classes
    HttpClientOptionsClientOptionsBaseTCPSSLOptionsNetworkOptions
  107. def setSendBufferSize(value: Int): HttpClientOptions

    Set the TCP send buffer size

    Set the TCP send buffer size

    Definition Classes
    HttpClientOptionsClientOptionsBaseTCPSSLOptionsNetworkOptions
  108. 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.

  109. def setSoLinger(value: Int): HttpClientOptions

    Set whether SO_linger keep alive is enabled

    Set whether SO_linger keep alive is enabled

    Definition Classes
    HttpClientOptionsClientOptionsBaseTCPSSLOptions
  110. def setSsl(value: Boolean): HttpClientOptions

    Set whether SSL/TLS is enabled

    Set whether SSL/TLS is enabled

    Definition Classes
    HttpClientOptionsClientOptionsBaseTCPSSLOptions
  111. def setTcpKeepAlive(value: Boolean): HttpClientOptions

    Set whether TCP keep alive is enabled

    Set whether TCP keep alive is enabled

    Definition Classes
    HttpClientOptionsClientOptionsBaseTCPSSLOptions
  112. def setTcpNoDelay(value: Boolean): HttpClientOptions

    Set whether TCP no delay is enabled

    Set whether TCP no delay is enabled

    Definition Classes
    HttpClientOptionsClientOptionsBaseTCPSSLOptions
  113. def setTrafficClass(value: Int): HttpClientOptions

    Set the value of traffic class

    Set the value of traffic class

    Definition Classes
    HttpClientOptionsClientOptionsBaseTCPSSLOptionsNetworkOptions
  114. def setTrustAll(value: Boolean): HttpClientOptions

    Set whether all server certificates should be trusted

    Set whether all server certificates should be trusted

    Definition Classes
    HttpClientOptionsClientOptionsBase
  115. 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
    HttpClientOptionsClientOptionsBaseTCPSSLOptions
  116. def setTryUseCompression(value: Boolean): HttpClientOptions

    Set whether compression is enabled

  117. def setUseAlpn(value: Boolean): HttpClientOptions

    Set the ALPN usage.

    Set the ALPN usage.

    Definition Classes
    HttpClientOptionsClientOptionsBaseTCPSSLOptions
  118. def setUsePooledBuffers(value: Boolean): HttpClientOptions

    Set whether Netty pooled buffers are enabled

    Set whether Netty pooled buffers are enabled

    Definition Classes
    HttpClientOptionsClientOptionsBaseTCPSSLOptions
  119. def setVerifyHost(value: Boolean): HttpClientOptions

    Set whether hostname verification is enabled

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

Inherited from ClientOptionsBase

Inherited from TCPSSLOptions

Inherited from NetworkOptions

Inherited from AnyRef

Inherited from Any

Ungrouped