Packages

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.

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

    Add a CRL value

    Add a CRL value

    Definition Classes
    StompClientOptionsNetClientOptionsTCPSSLOptions
  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
    StompClientOptionsNetClientOptionsTCPSSLOptions
  7. def addEnabledSecureTransportProtocol(value: String): StompClientOptions

    Sets the list of enabled SSL/TLS protocols.

    Sets the list of enabled SSL/TLS protocols.

    Definition Classes
    StompClientOptionsNetClientOptionsTCPSSLOptions
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def asJava: ext.stomp.StompClientOptions
    Definition Classes
    StompClientOptionsNetClientOptions
  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 getAcceptedVersions: Buffer[String]
  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 getEnabledCipherSuites: Set[String]
  20. def getEnabledSecureTransportProtocols: Set[String]
  21. def getHeartbeat: JsonObject
  22. def getHost: String
  23. def getHostnameVerificationAlgorithm: String
    Definition Classes
    StompClientOptionsNetClientOptions
  24. def getIdleTimeout: Int
  25. def getIdleTimeoutUnit: TimeUnit
  26. def getJdkSslEngineOptions: JdkSSLEngineOptions
  27. def getKeyStoreOptions: JksOptions
  28. def getLocalAddress: String
  29. def getLogActivity: Boolean
  30. def getLogin: String
  31. def getMetricsName: String
  32. def getOpenSslEngineOptions: OpenSSLEngineOptions
  33. def getPasscode: String
  34. def getPemKeyCertOptions: PemKeyCertOptions
  35. def getPemTrustOptions: PemTrustOptions
  36. def getPfxKeyCertOptions: PfxOptions
  37. def getPfxTrustOptions: PfxOptions
  38. def getPort: Int
  39. def getProxyOptions: ProxyOptions
  40. def getReceiveBufferSize: Int
  41. def getReconnectAttempts: Int
    Definition Classes
    StompClientOptionsNetClientOptions
  42. def getReconnectInterval: Long
    Definition Classes
    StompClientOptionsNetClientOptions
  43. def getSendBufferSize: Int
  44. def getSoLinger: Int
  45. def getSslHandshakeTimeout: Long
  46. def getSslHandshakeTimeoutUnit: TimeUnit
  47. def getTrafficClass: Int
  48. def getTrustStoreOptions: JksOptions
  49. def getVirtualHost: String
  50. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  51. def isAutoComputeContentLength: Boolean
  52. def isBypassHostHeader: Boolean
  53. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  54. def isReuseAddress: Boolean
  55. def isReusePort: Boolean
  56. def isSsl: Boolean
  57. def isTcpCork: Boolean
  58. def isTcpFastOpen: Boolean
  59. def isTcpKeepAlive: Boolean
  60. def isTcpNoDelay: Boolean
  61. def isTcpQuickAck: Boolean
  62. def isTrailingLine: Boolean
  63. def isTrustAll: Boolean
  64. def isUseAlpn: Boolean
  65. def isUsePooledBuffers: Boolean
  66. def isUseStompFrame: Boolean
  67. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  68. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  69. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  70. 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

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

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

  73. def setConnectTimeout(value: Int): StompClientOptions

    Set the connect timeout

    Set the connect timeout

    Definition Classes
    StompClientOptionsNetClientOptionsClientOptionsBase
  74. def setEnabledSecureTransportProtocols(value: Set[String]): StompClientOptions
  75. def setHeartbeat(value: JsonObject): StompClientOptions

    Sets the heartbeat configuration.

  76. def setHost(value: String): StompClientOptions

    Sets the STOMP server host.

    Sets the STOMP server host. 0.0.0.0 by default.

  77. 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
    StompClientOptionsNetClientOptions
  78. def setIdleTimeout(value: Int): StompClientOptions

    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
    StompClientOptionsNetClientOptionsTCPSSLOptions
  79. def setIdleTimeoutUnit(value: TimeUnit): StompClientOptions

    Set the idle timeout unit.

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

    Definition Classes
    StompClientOptionsNetClientOptionsTCPSSLOptions
  80. def setJdkSslEngineOptions(value: JdkSSLEngineOptions): StompClientOptions
  81. 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
    StompClientOptionsNetClientOptionsTCPSSLOptions
  82. 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
    StompClientOptionsNetClientOptionsClientOptionsBase
  83. 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
    StompClientOptionsNetClientOptionsNetworkOptions
  84. def setLogin(value: String): StompClientOptions

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

  85. 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
    StompClientOptionsNetClientOptionsClientOptionsBase
  86. def setOpenSslEngineOptions(value: OpenSSLEngineOptions): StompClientOptions
  87. def setPasscode(value: String): StompClientOptions

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

  88. 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
    StompClientOptionsNetClientOptionsTCPSSLOptions
  89. def setPemTrustOptions(value: PemTrustOptions): StompClientOptions

    Set the trust options in pem format

    Set the trust options in pem format

    Definition Classes
    StompClientOptionsNetClientOptionsTCPSSLOptions
  90. def setPfxKeyCertOptions(value: PfxOptions): StompClientOptions

    Set the key/cert options in pfx format.

    Set the key/cert options in pfx format.

    Definition Classes
    StompClientOptionsNetClientOptionsTCPSSLOptions
  91. def setPfxTrustOptions(value: PfxOptions): StompClientOptions

    Set the trust options in pfx format

    Set the trust options in pfx format

    Definition Classes
    StompClientOptionsNetClientOptionsTCPSSLOptions
  92. def setPort(value: Int): StompClientOptions

    Sets the STOMP server port.

    Sets the STOMP server port. 61613 by default.

  93. 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
    StompClientOptionsNetClientOptionsClientOptionsBase
  94. def setReceiveBufferSize(value: Int): StompClientOptions

    Set the TCP receive buffer size

    Set the TCP receive buffer size

    Definition Classes
    StompClientOptionsNetClientOptionsNetworkOptions
  95. def setReconnectAttempts(value: Int): StompClientOptions

    Set the value of reconnect attempts

    Set the value of reconnect attempts

    Definition Classes
    StompClientOptionsNetClientOptions
  96. def setReconnectInterval(value: Long): StompClientOptions

    Set the reconnect interval

    Set the reconnect interval

    Definition Classes
    StompClientOptionsNetClientOptions
  97. def setReuseAddress(value: Boolean): StompClientOptions

    Set the value of reuse address

    Set the value of reuse address

    Definition Classes
    StompClientOptionsNetClientOptionsNetworkOptions
  98. def setReusePort(value: Boolean): StompClientOptions

    Set the value of reuse port.

    Set the value of reuse port.

    This is only supported by native transports.

    Definition Classes
    StompClientOptionsNetClientOptionsNetworkOptions
  99. def setSendBufferSize(value: Int): StompClientOptions

    Set the TCP send buffer size

    Set the TCP send buffer size

    Definition Classes
    StompClientOptionsNetClientOptionsNetworkOptions
  100. def setSoLinger(value: Int): StompClientOptions

    Set whether SO_linger keep alive is enabled

    Set whether SO_linger keep alive is enabled

    Definition Classes
    StompClientOptionsNetClientOptionsTCPSSLOptions
  101. def setSsl(value: Boolean): StompClientOptions

    Set whether SSL/TLS is enabled

    Set whether SSL/TLS is enabled

    Definition Classes
    StompClientOptionsNetClientOptionsTCPSSLOptions
  102. def setSslHandshakeTimeout(value: Long): StompClientOptions

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

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

    Definition Classes
    StompClientOptionsNetClientOptionsTCPSSLOptions
  103. def setSslHandshakeTimeoutUnit(value: TimeUnit): StompClientOptions

    Set the SSL handshake timeout unit.

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

    Definition Classes
    StompClientOptionsNetClientOptionsTCPSSLOptions
  104. def setTcpCork(value: Boolean): StompClientOptions

    Enable the TCP_CORK option - only with linux native transport.

    Enable the TCP_CORK option - only with linux native transport.

    Definition Classes
    StompClientOptionsNetClientOptionsTCPSSLOptions
  105. def setTcpFastOpen(value: Boolean): StompClientOptions

    Enable the TCP_FASTOPEN option - only with linux native transport.

    Enable the TCP_FASTOPEN option - only with linux native transport.

    Definition Classes
    StompClientOptionsNetClientOptionsTCPSSLOptions
  106. def setTcpKeepAlive(value: Boolean): StompClientOptions

    Set whether TCP keep alive is enabled

    Set whether TCP keep alive is enabled

    Definition Classes
    StompClientOptionsNetClientOptionsTCPSSLOptions
  107. def setTcpNoDelay(value: Boolean): StompClientOptions

    Set whether TCP no delay is enabled

    Set whether TCP no delay is enabled

    Definition Classes
    StompClientOptionsNetClientOptionsTCPSSLOptions
  108. def setTcpQuickAck(value: Boolean): StompClientOptions

    Enable the TCP_QUICKACK option - only with linux native transport.

    Enable the TCP_QUICKACK option - only with linux native transport.

    Definition Classes
    StompClientOptionsNetClientOptionsTCPSSLOptions
  109. def setTrafficClass(value: Int): StompClientOptions

    Set the value of traffic class

    Set the value of traffic class

    Definition Classes
    StompClientOptionsNetClientOptionsNetworkOptions
  110. 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.

  111. def setTrustAll(value: Boolean): StompClientOptions

    Set whether all server certificates should be trusted

    Set whether all server certificates should be trusted

    Definition Classes
    StompClientOptionsNetClientOptionsClientOptionsBase
  112. 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
    StompClientOptionsNetClientOptionsTCPSSLOptions
  113. def setUseAlpn(value: Boolean): StompClientOptions

    Set the ALPN usage.

    Set the ALPN usage.

    Definition Classes
    StompClientOptionsNetClientOptionsTCPSSLOptions
  114. def setUsePooledBuffers(value: Boolean): StompClientOptions

    Set whether Netty pooled buffers are enabled

    Set whether Netty pooled buffers are enabled

    Definition Classes
    StompClientOptionsNetClientOptionsTCPSSLOptions
  115. 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.

  116. def setVirtualHost(value: String): StompClientOptions

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

  117. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  118. def toString(): String
    Definition Classes
    AnyRef → Any
  119. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  120. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  121. 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