vertx-lang-scala-docs_2.12 3.4.1 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package ext
  Definition Classes
    scala
-  package stomp
  Definition Classes
    ext
- Acknowledgement
- BridgeOptions
- Destination
- DestinationFactory
- Frame
- Frames
- ServerFrame
- StompClient
- StompClientConnection
- StompClientOptions
- StompServer
- StompServerConnection
- StompServerHandler
- StompServerOptions

c

io.vertx.scala.ext.stomp

# StompClientOptions 

###
Companion object StompClientOptions

#### class StompClientOptions extends NetClientOptions

Options used to configure a STOMP client. As a STOMP client wraps a Net client, you can also configure the underlying NET client.

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

1. Alphabetic
2. By Inheritance

Inherited

1. StompClientOptions
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 StompClientOptions(_asJava: ext.stomp.StompClientOptions)

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

   Add a CRL path

   Add a CRL path

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

   Add a CRL value

   Add a CRL value

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

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

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

   Definition Classes
     StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
7.  def addEnabledSecureTransportProtocol(value: String): StompClientOptions

   Add an enabled SSL/TLS protocols, appended to the ordered protocols.

   Add an enabled SSL/TLS protocols, appended to the ordered protocols.

   Definition Classes
     StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
8.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
9.  def asJava: ext.stomp.StompClientOptions
   Definition Classes
     StompClientOptions → NetClientOptions
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 getAcceptedVersions: Buffer[String]
15.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
16.  def getConnectTimeout: Int
    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase
17.  def getCrlPaths: Buffer[String]
    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
18.  def getCrlValues: Buffer[Buffer]
    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
19.  def getEnabledCipherSuites: Set[String]
    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
20.  def getEnabledSecureTransportProtocols: Set[String]
    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
21.  def getHeartbeat: JsonObject
22.  def getHost: String
23.  def getHostnameVerificationAlgorithm: String
    Definition Classes
      StompClientOptions → NetClientOptions
24.  def getIdleTimeout: Int
    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
25.  def getJdkSslEngineOptions: JdkSSLEngineOptions
    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
26.  def getKeyStoreOptions: JksOptions
    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
27.  def getLocalAddress: String
    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase
28.  def getLogActivity: Boolean
    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
29.  def getLogin: String
30.  def getMetricsName: String
    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase
31.  def getOpenSslEngineOptions: OpenSSLEngineOptions
    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
32.  def getPasscode: String
33.  def getPemKeyCertOptions: PemKeyCertOptions
    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
34.  def getPemTrustOptions: PemTrustOptions
    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
35.  def getPfxKeyCertOptions: PfxOptions
    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
36.  def getPfxTrustOptions: PfxOptions
    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
37.  def getPort: Int
38.  def getProxyOptions: ProxyOptions
    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase
39.  def getReceiveBufferSize: Int
    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
40.  def getReconnectAttempts: Int
    Definition Classes
      StompClientOptions → NetClientOptions
41.  def getReconnectInterval: Long
    Definition Classes
      StompClientOptions → NetClientOptions
42.  def getSendBufferSize: Int
    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
43.  def getSoLinger: Int
    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
44.  def getTrafficClass: Int
    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
45.  def getTrustStoreOptions: JksOptions
    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
46.  def getVirtualHost: String
47.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
48.  def isAutoComputeContentLength: Boolean
49.  def isBypassHostHeader: Boolean
50.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
51.  def isReuseAddress: Boolean
    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
52.  def isSsl: Boolean
    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
53.  def isTcpKeepAlive: Boolean
    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
54.  def isTcpNoDelay: Boolean
    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
55.  def isTrailingLine: Boolean
56.  def isTrustAll: Boolean
    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase
57.  def isUseAlpn: Boolean
    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
58.  def isUsePooledBuffers: Boolean
    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
59.  def isUseStompFrame: Boolean
60.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
61.  final def notify(): Unit
    Definition Classes
      AnyRef
62.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
63.  def setAcceptedVersions(value: Buffer[String]): StompClientOptions

    Sets the list of STOMP protocol versions accepted by the client.

    Sets the list of STOMP protocol versions accepted by the client. The list must be ordered from the lowest version to the highest. By default the following list is used: `1.0, 1.1, 1.2`

64.  def setAutoComputeContentLength(value: Boolean): StompClientOptions

    Sets whether or not the automatic computation of the `content-length` header is enabled.

    Sets whether or not the automatic computation of the `content-length` header is enabled. If enabled, the `content-length` header is set in all frame with a body that do not explicitly set the header. The option is enabled by default.

65.  def setBypassHostHeader(value: Boolean): StompClientOptions

    Sets whether or not the `host` header must be dropped from the `CONNECT/STOMP` frame.

    Sets whether or not the `host` header must be dropped from the `CONNECT/STOMP` frame. Server may be picky about this header (such as RabbitMQ that does not support it). Options disabled by default.

66.  def setConnectTimeout(value: Int): StompClientOptions

    Set the connect timeout

    Set the connect timeout

    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase
67.  def setHeartbeat(value: JsonObject): StompClientOptions

    Sets the heartbeat configuration.

68.  def setHost(value: String): StompClientOptions

    Sets the STOMP server host.

    Sets the STOMP server host. `0.0.0.0` by default.

69.  def setHostnameVerificationAlgorithm(value: String): StompClientOptions

    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
      StompClientOptions → NetClientOptions
70.  def setIdleTimeout(value: Int): StompClientOptions

    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
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
71.  def setJdkSslEngineOptions(value: JdkSSLEngineOptions): StompClientOptions
    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
72.  def setKeyStoreOptions(value: JksOptions): StompClientOptions

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

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

    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
73.  def setLocalAddress(value: String): StompClientOptions

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

    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
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
75.  def setLogin(value: String): StompClientOptions

    Sets the login to use if the STOMP server is secured.

76.  def setMetricsName(value: String): StompClientOptions

    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
      StompClientOptions → NetClientOptions → ClientOptionsBase
77.  def setOpenSslEngineOptions(value: OpenSSLEngineOptions): StompClientOptions
    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
78.  def setPasscode(value: String): StompClientOptions

    Sets the passcode to use if the STOMP server is secured.

79.  def setPemKeyCertOptions(value: PemKeyCertOptions): StompClientOptions

    Set the key/cert store options in pem format.

    Set the key/cert store options in pem format.

    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
80.  def setPemTrustOptions(value: PemTrustOptions): StompClientOptions

    Set the trust options in pem format

    Set the trust options in pem format

    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
81.  def setPfxKeyCertOptions(value: PfxOptions): StompClientOptions

    Set the key/cert options in pfx format.

    Set the key/cert options in pfx format.

    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
82.  def setPfxTrustOptions(value: PfxOptions): StompClientOptions

    Set the trust options in pfx format

    Set the trust options in pfx format

    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
83.  def setPort(value: Int): StompClientOptions

    Sets the STOMP server port.

    Sets the STOMP server port. `61613` by default.

84.  def setProxyOptions(value: ProxyOptions): StompClientOptions

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

    Set the TCP receive buffer size

    Set the TCP receive buffer size

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

    Set the value of reconnect attempts

    Set the value of reconnect attempts

    Definition Classes
      StompClientOptions → NetClientOptions
87.  def setReconnectInterval(value: Long): StompClientOptions

    Set the reconnect interval

    Set the reconnect interval

    Definition Classes
      StompClientOptions → NetClientOptions
88.  def setReuseAddress(value: Boolean): StompClientOptions

    Set the value of reuse address

    Set the value of reuse address

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

    Set the TCP send buffer size

    Set the TCP send buffer size

    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
90.  def setSoLinger(value: Int): StompClientOptions

    Set whether SO_linger keep alive is enabled

    Set whether SO_linger keep alive is enabled

    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
91.  def setSsl(value: Boolean): StompClientOptions

    Set whether SSL/TLS is enabled

    Set whether SSL/TLS is enabled

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

    Set whether TCP keep alive is enabled

    Set whether TCP keep alive is enabled

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

    Set whether TCP no delay is enabled

    Set whether TCP no delay is enabled

    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
94.  def setTrafficClass(value: Int): StompClientOptions

    Set the value of traffic class

    Set the value of traffic class

    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
95.  def setTrailingLine(value: Boolean): StompClientOptions

    Sets whether or not an empty line should be appended to the written STOMP frame.

    Sets whether or not an empty line should be appended to the written STOMP frame. This option is disabled by default. This option is not compliant with the STOMP specification, and so is not documented on purpose.

96.  def setTrustAll(value: Boolean): StompClientOptions

    Set whether all server certificates should be trusted

    Set whether all server certificates should be trusted

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

    Set the trust options in jks format, aka Java truststore

    Set the trust options in jks format, aka Java truststore

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

    Set the ALPN usage.

    Set the ALPN usage.

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

    Set whether Netty pooled buffers are enabled

    Set whether Netty pooled buffers are enabled

    Definition Classes
      StompClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
100.  def setUseStompFrame(value: Boolean): StompClientOptions

     Sets whether or not the connection is made using the `STOMP` command instead of the `CONNECT` command.

     Sets whether or not the connection is made using the `STOMP` command instead of the `CONNECT` command. The `STOMP` command has been introduced in the 1.2 version of the protocol to ease the network analysis (as `CONNECT` is also used by HTTP. To be compliant with server not implementing the 1.2 specification, this option should be disabled. This option is disabled by default.

101.  def setVirtualHost(value: String): StompClientOptions

     Sets the virtual host that will be used as "host" header value in the `CONNECT` frame.

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

### Inherited from NetClientOptions

### Inherited from ClientOptionsBase

### Inherited from TCPSSLOptions

### Inherited from NetworkOptions

### Inherited from AnyRef

### Inherited from Any

### Ungrouped