vertx-lang-scala-docs_2.12 3.8.0 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 net
  Definition Classes
    core
- ClientOptionsBase
- JdkSSLEngineOptions
- JksOptions
- NetClient
- NetClientOptions
- NetServer
- NetServerOptions
- NetSocket
- NetworkOptions
- OpenSSLEngineOptions
- PemKeyCertOptions
- PemTrustOptions
- PfxOptions
- ProxyOptions
- SelfSignedCertificate
- SocketAddress
- TCPSSLOptions

t

io.vertx.scala.core.net

# ClientOptionsBase 

###

#### trait ClientOptionsBase extends TCPSSLOptions

Base class for Client options

Linear Supertypes
TCPSSLOptions, NetworkOptions, AnyRef, Any
Known Subclasses
AmqpBridgeOptions, HttpClientOptions, NetClientOptions, OAuth2ClientOptions, ConsulClientOptions, StompClientOptions, WebClientOptions, MqttClientOptions, ProtonClientOptions, RedisOptions
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

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

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Abstract Value Members

1.  abstract def addCrlPath(value: String): ClientOptionsBase

   Add a CRL path

   Add a CRL path

   Definition Classes
     ClientOptionsBase → TCPSSLOptions
2.  abstract def addCrlValue(value: Buffer): ClientOptionsBase

   Add a CRL value

   Add a CRL value

   Definition Classes
     ClientOptionsBase → TCPSSLOptions
3.  abstract def addEnabledCipherSuite(value: String): ClientOptionsBase

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

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

   Definition Classes
     ClientOptionsBase → TCPSSLOptions
4.  abstract def addEnabledSecureTransportProtocol(value: String): ClientOptionsBase

   Sets the list of enabled SSL/TLS protocols.

   Sets the list of enabled SSL/TLS protocols.

   Definition Classes
     ClientOptionsBase → TCPSSLOptions
5.  abstract def getConnectTimeout: Int
6.  abstract def getCrlPaths: Buffer[String]
   Definition Classes
     ClientOptionsBase → TCPSSLOptions
7.  abstract def getCrlValues: Buffer[Buffer]
   Definition Classes
     ClientOptionsBase → TCPSSLOptions
8.  abstract def getEnabledCipherSuites: Set[String]
   Definition Classes
     ClientOptionsBase → TCPSSLOptions
9.  abstract def getEnabledSecureTransportProtocols: Set[String]
   Definition Classes
     ClientOptionsBase → TCPSSLOptions
10.  abstract def getIdleTimeout: Int
    Definition Classes
      ClientOptionsBase → TCPSSLOptions
11.  abstract def getIdleTimeoutUnit: TimeUnit
    Definition Classes
      ClientOptionsBase → TCPSSLOptions
12.  abstract def getJdkSslEngineOptions: JdkSSLEngineOptions
    Definition Classes
      ClientOptionsBase → TCPSSLOptions
13.  abstract def getKeyStoreOptions: JksOptions
    Definition Classes
      ClientOptionsBase → TCPSSLOptions
14.  abstract def getLocalAddress: String
15.  abstract def getLogActivity: Boolean
    Definition Classes
      ClientOptionsBase → TCPSSLOptions → NetworkOptions
16.  abstract def getMetricsName: String
17.  abstract def getOpenSslEngineOptions: OpenSSLEngineOptions
    Definition Classes
      ClientOptionsBase → TCPSSLOptions
18.  abstract def getPemKeyCertOptions: PemKeyCertOptions
    Definition Classes
      ClientOptionsBase → TCPSSLOptions
19.  abstract def getPemTrustOptions: PemTrustOptions
    Definition Classes
      ClientOptionsBase → TCPSSLOptions
20.  abstract def getPfxKeyCertOptions: PfxOptions
    Definition Classes
      ClientOptionsBase → TCPSSLOptions
21.  abstract def getPfxTrustOptions: PfxOptions
    Definition Classes
      ClientOptionsBase → TCPSSLOptions
22.  abstract def getProxyOptions: ProxyOptions
23.  abstract def getReceiveBufferSize: Int
    Definition Classes
      ClientOptionsBase → TCPSSLOptions → NetworkOptions
24.  abstract def getSendBufferSize: Int
    Definition Classes
      ClientOptionsBase → TCPSSLOptions → NetworkOptions
25.  abstract def getSoLinger: Int
    Definition Classes
      ClientOptionsBase → TCPSSLOptions
26.  abstract def getSslHandshakeTimeout: Long
    Definition Classes
      ClientOptionsBase → TCPSSLOptions
27.  abstract def getSslHandshakeTimeoutUnit: TimeUnit
    Definition Classes
      ClientOptionsBase → TCPSSLOptions
28.  abstract def getTrafficClass: Int
    Definition Classes
      ClientOptionsBase → TCPSSLOptions → NetworkOptions
29.  abstract def getTrustStoreOptions: JksOptions
    Definition Classes
      ClientOptionsBase → TCPSSLOptions
30.  abstract def isReuseAddress: Boolean
    Definition Classes
      ClientOptionsBase → TCPSSLOptions → NetworkOptions
31.  abstract def isReusePort: Boolean
    Definition Classes
      ClientOptionsBase → TCPSSLOptions → NetworkOptions
32.  abstract def isSsl: Boolean
    Definition Classes
      ClientOptionsBase → TCPSSLOptions
33.  abstract def isTcpCork: Boolean
    Definition Classes
      ClientOptionsBase → TCPSSLOptions
34.  abstract def isTcpFastOpen: Boolean
    Definition Classes
      ClientOptionsBase → TCPSSLOptions
35.  abstract def isTcpKeepAlive: Boolean
    Definition Classes
      ClientOptionsBase → TCPSSLOptions
36.  abstract def isTcpNoDelay: Boolean
    Definition Classes
      ClientOptionsBase → TCPSSLOptions
37.  abstract def isTcpQuickAck: Boolean
    Definition Classes
      ClientOptionsBase → TCPSSLOptions
38.  abstract def isTrustAll: Boolean
39.  abstract def isUseAlpn: Boolean
    Definition Classes
      ClientOptionsBase → TCPSSLOptions
40.  abstract def isUsePooledBuffers: Boolean
    Definition Classes
      ClientOptionsBase → TCPSSLOptions
41.  abstract def setConnectTimeout(value: Int): ClientOptionsBase

    Set the connect timeout

42.  abstract def setEnabledSecureTransportProtocols(value: Set[String]): ClientOptionsBase
    Definition Classes
      ClientOptionsBase → TCPSSLOptions
43.  abstract def setIdleTimeout(value: Int): ClientOptionsBase

    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 ClientOptionsBase

    Definition Classes
      ClientOptionsBase → TCPSSLOptions
44.  abstract def setIdleTimeoutUnit(value: TimeUnit): ClientOptionsBase

    Set the idle timeout unit.

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

    Definition Classes
      ClientOptionsBase → TCPSSLOptions
45.  abstract def setJdkSslEngineOptions(value: JdkSSLEngineOptions): ClientOptionsBase
    Definition Classes
      ClientOptionsBase → TCPSSLOptions
46.  abstract def setKeyStoreOptions(value: JksOptions): ClientOptionsBase

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

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

    Definition Classes
      ClientOptionsBase → TCPSSLOptions
47.  abstract def setLocalAddress(value: String): ClientOptionsBase

    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.

48.  abstract def setLogActivity(value: Boolean): ClientOptionsBase

    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
      ClientOptionsBase → TCPSSLOptions → NetworkOptions
49.  abstract def setMetricsName(value: String): ClientOptionsBase

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

50.  abstract def setOpenSslEngineOptions(value: OpenSSLEngineOptions): ClientOptionsBase
    Definition Classes
      ClientOptionsBase → TCPSSLOptions
51.  abstract def setPemKeyCertOptions(value: PemKeyCertOptions): ClientOptionsBase

    Set the key/cert store options in pem format.

    Set the key/cert store options in pem format.

    Definition Classes
      ClientOptionsBase → TCPSSLOptions
52.  abstract def setPemTrustOptions(value: PemTrustOptions): ClientOptionsBase

    Set the trust options in pem format

    Set the trust options in pem format

    Definition Classes
      ClientOptionsBase → TCPSSLOptions
53.  abstract def setPfxKeyCertOptions(value: PfxOptions): ClientOptionsBase

    Set the key/cert options in pfx format.

    Set the key/cert options in pfx format.

    Definition Classes
      ClientOptionsBase → TCPSSLOptions
54.  abstract def setPfxTrustOptions(value: PfxOptions): ClientOptionsBase

    Set the trust options in pfx format

    Set the trust options in pfx format

    Definition Classes
      ClientOptionsBase → TCPSSLOptions
55.  abstract def setProxyOptions(value: ProxyOptions): ClientOptionsBase

    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.

56.  abstract def setReceiveBufferSize(value: Int): ClientOptionsBase

    Set the TCP receive buffer size

    Set the TCP receive buffer size

    Definition Classes
      ClientOptionsBase → TCPSSLOptions → NetworkOptions
57.  abstract def setReuseAddress(value: Boolean): ClientOptionsBase

    Set the value of reuse address

    Set the value of reuse address

    Definition Classes
      ClientOptionsBase → TCPSSLOptions → NetworkOptions
58.  abstract def setReusePort(value: Boolean): ClientOptionsBase

    Set the value of reuse port.

    Set the value of reuse port.

    This is only supported by native transports.

    Definition Classes
      ClientOptionsBase → TCPSSLOptions → NetworkOptions
59.  abstract def setSendBufferSize(value: Int): ClientOptionsBase

    Set the TCP send buffer size

    Set the TCP send buffer size

    Definition Classes
      ClientOptionsBase → TCPSSLOptions → NetworkOptions
60.  abstract def setSoLinger(value: Int): ClientOptionsBase

    Set whether SO_linger keep alive is enabled

    Set whether SO_linger keep alive is enabled

    Definition Classes
      ClientOptionsBase → TCPSSLOptions
61.  abstract def setSsl(value: Boolean): ClientOptionsBase

    Set whether SSL/TLS is enabled

    Set whether SSL/TLS is enabled

    Definition Classes
      ClientOptionsBase → TCPSSLOptions
62.  abstract def setSslHandshakeTimeout(value: Long): ClientOptionsBase

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

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

    Definition Classes
      ClientOptionsBase → TCPSSLOptions
63.  abstract def setSslHandshakeTimeoutUnit(value: TimeUnit): ClientOptionsBase

    Set the SSL handshake timeout unit.

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

    Definition Classes
      ClientOptionsBase → TCPSSLOptions
64.  abstract def setTcpCork(value: Boolean): ClientOptionsBase

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

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

    Definition Classes
      ClientOptionsBase → TCPSSLOptions
65.  abstract def setTcpFastOpen(value: Boolean): ClientOptionsBase

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

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

    Definition Classes
      ClientOptionsBase → TCPSSLOptions
66.  abstract def setTcpKeepAlive(value: Boolean): ClientOptionsBase

    Set whether TCP keep alive is enabled

    Set whether TCP keep alive is enabled

    Definition Classes
      ClientOptionsBase → TCPSSLOptions
67.  abstract def setTcpNoDelay(value: Boolean): ClientOptionsBase

    Set whether TCP no delay is enabled

    Set whether TCP no delay is enabled

    Definition Classes
      ClientOptionsBase → TCPSSLOptions
68.  abstract def setTcpQuickAck(value: Boolean): ClientOptionsBase

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

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

    Definition Classes
      ClientOptionsBase → TCPSSLOptions
69.  abstract def setTrafficClass(value: Int): ClientOptionsBase

    Set the value of traffic class

    Set the value of traffic class

    Definition Classes
      ClientOptionsBase → TCPSSLOptions → NetworkOptions
70.  abstract def setTrustAll(value: Boolean): ClientOptionsBase

    Set whether all server certificates should be trusted

71.  abstract def setTrustStoreOptions(value: JksOptions): ClientOptionsBase

    Set the trust options in jks format, aka Java truststore

    Set the trust options in jks format, aka Java truststore

    Definition Classes
      ClientOptionsBase → TCPSSLOptions
72.  abstract def setUseAlpn(value: Boolean): ClientOptionsBase

    Set the ALPN usage.

    Set the ALPN usage.

    Definition Classes
      ClientOptionsBase → TCPSSLOptions
73.  abstract def setUsePooledBuffers(value: Boolean): ClientOptionsBase

    Set whether Netty pooled buffers are enabled

    Set whether Netty pooled buffers are enabled

    Definition Classes
      ClientOptionsBase → TCPSSLOptions

### Concrete 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.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
5.  def clone(): AnyRef
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @native() @throws( ... )
6.  final def eq(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef
7.  def equals(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
8.  def finalize(): Unit
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @throws( classOf[java.lang.Throwable] )
9.  final def getClass(): Class[_]
   Definition Classes
     AnyRef → Any
   Annotations
     @native()
10.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
11.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
12.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
13.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
14.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
15.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
16.  def toString(): String
    Definition Classes
      AnyRef → Any
17.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
18.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
19.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @native() @throws( ... )

### Inherited from TCPSSLOptions

### Inherited from NetworkOptions

### Inherited from AnyRef

### Inherited from Any

### Ungrouped