vertx-lang-scala-docs_2.12 3.6.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 proton
  Definition Classes
    scala
- ProtonClientOptions
- ProtonLinkOptions
- ProtonServerOptions
- ProtonTransportOptions

c

io.vertx.scala.proton

# ProtonClientOptions 

###
Companion object ProtonClientOptions

#### class ProtonClientOptions extends NetClientOptions

Options for configuring io.vertx.scala.proton.ProtonClient connect operations.

Linear Supertypes
NetClientOptions, ClientOptionsBase, TCPSSLOptions, NetworkOptions, AnyRef, Any
Known Subclasses
AmqpBridgeOptions
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. ProtonClientOptions
2. NetClientOptions
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 ProtonClientOptions(_asJava: proton.ProtonClientOptions)

### 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): ProtonClientOptions

   Add a CRL path

   Add a CRL path

   Definition Classes
     ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
5.  def addCrlValue(value: Buffer): ProtonClientOptions

   Add a CRL value

   Add a CRL value

   Definition Classes
     ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
6.  def addEnabledCipherSuite(value: String): ProtonClientOptions

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

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

   Definition Classes
     ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
7.  def addEnabledSaslMechanism(value: String): ProtonClientOptions

   Adds a mechanism name that the client may use during SASL negotiation.

8.  def addEnabledSecureTransportProtocol(value: String): ProtonClientOptions

   Sets the list of enabled SSL/TLS protocols.

   Sets the list of enabled SSL/TLS protocols.

   Definition Classes
     ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
9.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
10.  def asJava: proton.ProtonClientOptions
    Definition Classes
      ProtonClientOptions → NetClientOptions
11.  def clone(): AnyRef
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @native() @throws( ... )
12.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
13.  def equals(arg0: Any): Boolean
    Definition Classes
      AnyRef → Any
14.  def finalize(): Unit
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )
15.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
16.  def getConnectTimeout: Int
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase
17.  def getCrlPaths: Buffer[String]
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
18.  def getCrlValues: Buffer[Buffer]
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
19.  def getEnabledCipherSuites: Set[String]
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
20.  def getEnabledSaslMechanisms: Set[String]
21.  def getEnabledSecureTransportProtocols: Set[String]
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
22.  def getHeartbeat: Int
23.  def getHostnameVerificationAlgorithm: String
    Definition Classes
      ProtonClientOptions → NetClientOptions
24.  def getIdleTimeout: Int
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
25.  def getIdleTimeoutUnit: TimeUnit
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
26.  def getJdkSslEngineOptions: JdkSSLEngineOptions
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
27.  def getKeyStoreOptions: JksOptions
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
28.  def getLocalAddress: String
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase
29.  def getLogActivity: Boolean
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
30.  def getMaxFrameSize: Int
31.  def getMetricsName: String
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase
32.  def getOpenSslEngineOptions: OpenSSLEngineOptions
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
33.  def getPemKeyCertOptions: PemKeyCertOptions
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
34.  def getPemTrustOptions: PemTrustOptions
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
35.  def getPfxKeyCertOptions: PfxOptions
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
36.  def getPfxTrustOptions: PfxOptions
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
37.  def getProxyOptions: ProxyOptions
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase
38.  def getReceiveBufferSize: Int
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
39.  def getReconnectAttempts: Int
    Definition Classes
      ProtonClientOptions → NetClientOptions
40.  def getReconnectInterval: Long
    Definition Classes
      ProtonClientOptions → NetClientOptions
41.  def getSendBufferSize: Int
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
42.  def getSniServerName: String
43.  def getSoLinger: Int
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
44.  def getTrafficClass: Int
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
45.  def getTrustStoreOptions: JksOptions
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
46.  def getVirtualHost: String
47.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
48.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
49.  def isReuseAddress: Boolean
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
50.  def isReusePort: Boolean
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
51.  def isSsl: Boolean
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
52.  def isTcpCork: Boolean
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
53.  def isTcpFastOpen: Boolean
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
54.  def isTcpKeepAlive: Boolean
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
55.  def isTcpNoDelay: Boolean
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
56.  def isTcpQuickAck: Boolean
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
57.  def isTrustAll: Boolean
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase
58.  def isUseAlpn: Boolean
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
59.  def isUsePooledBuffers: Boolean
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
60.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
61.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
62.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
63.  def setConnectTimeout(value: Int): ProtonClientOptions

    Set the connect timeout

    Set the connect timeout

    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase
64.  def setEnabledSecureTransportProtocols(value: Set[String]): ProtonClientOptions
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
65.  def setHeartbeat(value: Int): ProtonClientOptions

    Set the heartbeat (in milliseconds) as maximum delay between sending frames for the remote peers.

    Set the heartbeat (in milliseconds) as maximum delay between sending frames for the remote peers. If no frames are received within 2*heartbeat, the connection is closed

66.  def setHostnameVerificationAlgorithm(value: String): ProtonClientOptions

    Set the hostname verification algorithm interval To disable hostname verification, set hostnameVerificationAlgorithm to an empty String

    Set the hostname verification algorithm interval To disable hostname verification, set hostnameVerificationAlgorithm to an empty String

    Definition Classes
      ProtonClientOptions → NetClientOptions
67.  def setIdleTimeout(value: Int): ProtonClientOptions

    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 NetClientOptions

    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
68.  def setIdleTimeoutUnit(value: TimeUnit): ProtonClientOptions

    Set the idle timeout unit.

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

    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
69.  def setJdkSslEngineOptions(value: JdkSSLEngineOptions): ProtonClientOptions
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
70.  def setKeyStoreOptions(value: JksOptions): ProtonClientOptions

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

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

    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
71.  def setLocalAddress(value: String): ProtonClientOptions

    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
      ProtonClientOptions → NetClientOptions → ClientOptionsBase
72.  def setLogActivity(value: Boolean): ProtonClientOptions

    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
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
73.  def setMaxFrameSize(value: Int): ProtonClientOptions

    Sets the maximum frame size for the connection.

    Sets the maximum frame size for the connection.

    If this property is not set explicitly, a reasonable default value is used.

    Setting this property to a negative value will result in no maximum frame size being announced at all.

74.  def setMetricsName(value: String): ProtonClientOptions

    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
      ProtonClientOptions → NetClientOptions → ClientOptionsBase
75.  def setOpenSslEngineOptions(value: OpenSSLEngineOptions): ProtonClientOptions
    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
76.  def setPemKeyCertOptions(value: PemKeyCertOptions): ProtonClientOptions

    Set the key/cert store options in pem format.

    Set the key/cert store options in pem format.

    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
77.  def setPemTrustOptions(value: PemTrustOptions): ProtonClientOptions

    Set the trust options in pem format

    Set the trust options in pem format

    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
78.  def setPfxKeyCertOptions(value: PfxOptions): ProtonClientOptions

    Set the key/cert options in pfx format.

    Set the key/cert options in pfx format.

    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
79.  def setPfxTrustOptions(value: PfxOptions): ProtonClientOptions

    Set the trust options in pfx format

    Set the trust options in pfx format

    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
80.  def setProxyOptions(value: ProxyOptions): ProtonClientOptions

    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
      ProtonClientOptions → NetClientOptions → ClientOptionsBase
81.  def setReceiveBufferSize(value: Int): ProtonClientOptions

    Set the TCP receive buffer size

    Set the TCP receive buffer size

    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
82.  def setReconnectAttempts(value: Int): ProtonClientOptions

    Set the value of reconnect attempts

    Set the value of reconnect attempts

    Definition Classes
      ProtonClientOptions → NetClientOptions
83.  def setReconnectInterval(value: Long): ProtonClientOptions

    Set the reconnect interval

    Set the reconnect interval

    Definition Classes
      ProtonClientOptions → NetClientOptions
84.  def setReuseAddress(value: Boolean): ProtonClientOptions

    Set the value of reuse address

    Set the value of reuse address

    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
85.  def setReusePort(value: Boolean): ProtonClientOptions

    Set the value of reuse port.

    Set the value of reuse port.

    This is only supported by native transports.

    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
86.  def setSendBufferSize(value: Int): ProtonClientOptions

    Set the TCP send buffer size

    Set the TCP send buffer size

    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
87.  def setSniServerName(value: String): ProtonClientOptions

    Explicitly override the hostname to use for the TLS SNI server name.

    Explicitly override the hostname to use for the TLS SNI server name.

    If neither the ProtonClientOptions or SNI server name is explicitly overridden, the hostname specified in io.vertx.scala.proton.ProtonClient will be used, with SNI performed implicitly where a FQDN was specified.

    This method should typically only be needed to set different values for the [virtual] hostname and SNI server name.

88.  def setSoLinger(value: Int): ProtonClientOptions

    Set whether SO_linger keep alive is enabled

    Set whether SO_linger keep alive is enabled

    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
89.  def setSsl(value: Boolean): ProtonClientOptions

    Set whether SSL/TLS is enabled

    Set whether SSL/TLS is enabled

    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
90.  def setTcpCork(value: Boolean): ProtonClientOptions

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

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

    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
91.  def setTcpFastOpen(value: Boolean): ProtonClientOptions

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

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

    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
92.  def setTcpKeepAlive(value: Boolean): ProtonClientOptions

    Set whether TCP keep alive is enabled

    Set whether TCP keep alive is enabled

    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
93.  def setTcpNoDelay(value: Boolean): ProtonClientOptions

    Set whether TCP no delay is enabled

    Set whether TCP no delay is enabled

    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
94.  def setTcpQuickAck(value: Boolean): ProtonClientOptions

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

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

    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
95.  def setTrafficClass(value: Int): ProtonClientOptions

    Set the value of traffic class

    Set the value of traffic class

    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
96.  def setTrustAll(value: Boolean): ProtonClientOptions

    Set whether all server certificates should be trusted

    Set whether all server certificates should be trusted

    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase
97.  def setTrustStoreOptions(value: JksOptions): ProtonClientOptions

    Set the trust options in jks format, aka Java truststore

    Set the trust options in jks format, aka Java truststore

    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
98.  def setUseAlpn(value: Boolean): ProtonClientOptions

    Set the ALPN usage.

    Set the ALPN usage.

    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
99.  def setUsePooledBuffers(value: Boolean): ProtonClientOptions

    Set whether Netty pooled buffers are enabled

    Set whether Netty pooled buffers are enabled

    Definition Classes
      ProtonClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
100.  def setVirtualHost(value: String): ProtonClientOptions

     Override the hostname value used in the connection AMQP Open frame and TLS SNI server name (if TLS is in use).

     Override the hostname value used in the connection AMQP Open frame and TLS SNI server name (if TLS is in use). By default, the hostname specified in io.vertx.scala.proton.ProtonClient will be used for both, with SNI performed implicit where a FQDN was specified.

     The SNI server name can also be overridden explicitly using ProtonClientOptions.

101.  final def synchronized[T0](arg0: ⇒ T0): T0
     Definition Classes
       AnyRef
102.  def toString(): String
     Definition Classes
       AnyRef → Any
103.  final def wait(): Unit
     Definition Classes
       AnyRef
     Annotations
       @throws( ... )
104.  final def wait(arg0: Long, arg1: Int): Unit
     Definition Classes
       AnyRef
     Annotations
       @throws( ... )
105.  final def wait(arg0: Long): Unit
     Definition Classes
       AnyRef
     Annotations
       @native() @throws( ... )

### Inherited from NetClientOptions

### Inherited from ClientOptionsBase

### Inherited from TCPSSLOptions

### Inherited from NetworkOptions

### Inherited from AnyRef

### Inherited from Any

### Ungrouped