Packages

class StompServerOptions extends NetServerOptions

STOMP Server options. You can also configure the Net Server used by the STOMP server from these options.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StompServerOptions
  2. NetServerOptions
  3. TCPSSLOptions
  4. NetworkOptions
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new StompServerOptions(_asJava: ext.stomp.StompServerOptions)

Value Members

  1. def addCrlPath(value: String): StompServerOptions

    Add a CRL path

    Add a CRL path

    Definition Classes
    StompServerOptionsNetServerOptionsTCPSSLOptions
  2. def addCrlValue(value: Buffer): StompServerOptions

    Add a CRL value

    Add a CRL value

    Definition Classes
    StompServerOptionsNetServerOptionsTCPSSLOptions
  3. def addEnabledCipherSuite(value: String): StompServerOptions

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

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

    Definition Classes
    StompServerOptionsNetServerOptionsTCPSSLOptions
  4. def addEnabledSecureTransportProtocol(value: String): StompServerOptions

    Sets the list of enabled SSL/TLS protocols.

    Sets the list of enabled SSL/TLS protocols.

    Definition Classes
    StompServerOptionsNetServerOptionsTCPSSLOptions
  5. def asJava: ext.stomp.StompServerOptions
    Definition Classes
    StompServerOptionsNetServerOptions
  6. def getAcceptBacklog: Int
    Definition Classes
    StompServerOptionsNetServerOptions
  7. def getClientAuth: ClientAuth
    Definition Classes
    StompServerOptionsNetServerOptions
  8. def getCrlPaths: Buffer[String]
  9. def getCrlValues: Buffer[Buffer]
  10. def getEnabledCipherSuites: Set[String]
  11. def getEnabledSecureTransportProtocols: Set[String]
  12. def getHeartbeat: JsonObject
  13. def getHost: String
    Definition Classes
    StompServerOptionsNetServerOptions
  14. def getIdleTimeout: Int
  15. def getIdleTimeoutUnit: TimeUnit
  16. def getJdkSslEngineOptions: JdkSSLEngineOptions
  17. def getKeyStoreOptions: JksOptions
  18. def getLogActivity: Boolean
  19. def getMaxBodyLength: Int
  20. def getMaxFrameInTransaction: Int
  21. def getMaxHeaderLength: Int
  22. def getMaxHeaders: Int
  23. def getMaxSubscriptionsByClient: Int
  24. def getOpenSslEngineOptions: OpenSSLEngineOptions
  25. def getPemKeyCertOptions: PemKeyCertOptions
  26. def getPemTrustOptions: PemTrustOptions
  27. def getPfxKeyCertOptions: PfxOptions
  28. def getPfxTrustOptions: PfxOptions
  29. def getPort: Int
    Definition Classes
    StompServerOptionsNetServerOptions
  30. def getReceiveBufferSize: Int
  31. def getSendBufferSize: Int
  32. def getSoLinger: Int
  33. def getSupportedVersions: Buffer[String]
  34. def getTimeFactor: Int
  35. def getTrafficClass: Int
  36. def getTransactionChunkSize: Int
  37. def getTrustStoreOptions: JksOptions
  38. def getWebsocketPath: String
  39. def isClientAuthRequired: Boolean
    Definition Classes
    StompServerOptionsNetServerOptions
  40. def isReuseAddress: Boolean
  41. def isReusePort: Boolean
  42. def isSecured: Boolean
  43. def isSendErrorOnNoSubscriptions: Boolean
  44. def isSni: Boolean
    Definition Classes
    StompServerOptionsNetServerOptions
  45. def isSsl: Boolean
  46. def isTcpCork: Boolean
  47. def isTcpFastOpen: Boolean
  48. def isTcpKeepAlive: Boolean
  49. def isTcpNoDelay: Boolean
  50. def isTcpQuickAck: Boolean
  51. def isTrailingLine: Boolean
  52. def isUseAlpn: Boolean
  53. def isUsePooledBuffers: Boolean
  54. def isWebsocketBridge: Boolean
  55. def setAcceptBacklog(value: Int): StompServerOptions

    Set the accept back log

    Set the accept back log

    Definition Classes
    StompServerOptionsNetServerOptions
  56. def setClientAuth(value: ClientAuth): StompServerOptions

    Set whether client auth is required

    Set whether client auth is required

    Definition Classes
    StompServerOptionsNetServerOptions
  57. def setClientAuthRequired(value: Boolean): StompServerOptions

    Set whether client auth is required

    Set whether client auth is required

    Definition Classes
    StompServerOptionsNetServerOptions
  58. def setEnabledSecureTransportProtocols(value: Set[String]): StompServerOptions
  59. def setHeartbeat(value: JsonObject): StompServerOptions

    Sets the heartbeat configuration.

  60. def setHost(value: String): StompServerOptions

    Set the host

    Set the host

    Definition Classes
    StompServerOptionsNetServerOptions
  61. def setIdleTimeout(value: Int): StompServerOptions

    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 NetServerOptions

    Definition Classes
    StompServerOptionsNetServerOptionsTCPSSLOptions
  62. def setIdleTimeoutUnit(value: TimeUnit): StompServerOptions

    Set the idle timeout unit.

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

    Definition Classes
    StompServerOptionsNetServerOptionsTCPSSLOptions
  63. def setJdkSslEngineOptions(value: JdkSSLEngineOptions): StompServerOptions
  64. def setKeyStoreOptions(value: JksOptions): StompServerOptions

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

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

    Definition Classes
    StompServerOptionsNetServerOptionsTCPSSLOptions
  65. def setLogActivity(value: Boolean): StompServerOptions

    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
    StompServerOptionsNetServerOptionsTCPSSLOptionsNetworkOptions
  66. def setMaxBodyLength(value: Int): StompServerOptions

    Sets the max body length accepted by the server.

    Sets the max body length accepted by the server. 10 Mb by default.

  67. def setMaxFrameInTransaction(value: Int): StompServerOptions

    Sets the maximum number of frame that can be added in a transaction.

    Sets the maximum number of frame that can be added in a transaction. If the number of frame added to a transaction exceeds this threshold, the client receives an ERROR frame and is disconnected. The default is 1000.

  68. def setMaxHeaderLength(value: Int): StompServerOptions

    Sets the max header length.

  69. def setMaxHeaders(value: Int): StompServerOptions

    Sets the maximum number of headers.

    Sets the maximum number of headers. 1000 by default.

  70. def setMaxSubscriptionsByClient(value: Int): StompServerOptions

    Sets the maximum of subscriptions a client is allowed to register.

    Sets the maximum of subscriptions a client is allowed to register. If a client exceeds this number, it receives an error and the connection is closed.

  71. def setOpenSslEngineOptions(value: OpenSSLEngineOptions): StompServerOptions
  72. def setPemKeyCertOptions(value: PemKeyCertOptions): StompServerOptions

    Set the key/cert store options in pem format.

    Set the key/cert store options in pem format.

    Definition Classes
    StompServerOptionsNetServerOptionsTCPSSLOptions
  73. def setPemTrustOptions(value: PemTrustOptions): StompServerOptions

    Set the trust options in pem format

    Set the trust options in pem format

    Definition Classes
    StompServerOptionsNetServerOptionsTCPSSLOptions
  74. def setPfxKeyCertOptions(value: PfxOptions): StompServerOptions

    Set the key/cert options in pfx format.

    Set the key/cert options in pfx format.

    Definition Classes
    StompServerOptionsNetServerOptionsTCPSSLOptions
  75. def setPfxTrustOptions(value: PfxOptions): StompServerOptions

    Set the trust options in pfx format

    Set the trust options in pfx format

    Definition Classes
    StompServerOptionsNetServerOptionsTCPSSLOptions
  76. def setPort(value: Int): StompServerOptions

    Sets the port on which the server is going to listen for TCP connection.

    Sets the port on which the server is going to listen for TCP connection.

    Definition Classes
    StompServerOptionsNetServerOptions
  77. def setReceiveBufferSize(value: Int): StompServerOptions

    Set the TCP receive buffer size

    Set the TCP receive buffer size

    Definition Classes
    StompServerOptionsNetServerOptionsTCPSSLOptionsNetworkOptions
  78. def setReuseAddress(value: Boolean): StompServerOptions

    Set the value of reuse address

    Set the value of reuse address

    Definition Classes
    StompServerOptionsNetServerOptionsTCPSSLOptionsNetworkOptions
  79. def setReusePort(value: Boolean): StompServerOptions

    Set the value of reuse port.

    Set the value of reuse port.

    This is only supported by native transports.

    Definition Classes
    StompServerOptionsNetServerOptionsTCPSSLOptionsNetworkOptions
  80. def setSecured(value: Boolean): StompServerOptions

    Enables or disables the server security feature.

    Enables or disables the server security feature. It requires an io.vertx.scala.ext.auth.AuthProvider handler.

  81. def setSendBufferSize(value: Int): StompServerOptions

    Set the TCP send buffer size

    Set the TCP send buffer size

    Definition Classes
    StompServerOptionsNetServerOptionsTCPSSLOptionsNetworkOptions
  82. def setSendErrorOnNoSubscriptions(value: Boolean): StompServerOptions

    Sets whether or not an error is sent to the client when this client sends a message to an not subscribed destinations (no subscriptions on this destination).

  83. def setSni(value: Boolean): StompServerOptions

    Set whether the server supports Server Name Indiciation

    Set whether the server supports Server Name Indiciation

    Definition Classes
    StompServerOptionsNetServerOptions
  84. def setSoLinger(value: Int): StompServerOptions

    Set whether SO_linger keep alive is enabled

    Set whether SO_linger keep alive is enabled

    Definition Classes
    StompServerOptionsNetServerOptionsTCPSSLOptions
  85. def setSsl(value: Boolean): StompServerOptions

    Set whether SSL/TLS is enabled

    Set whether SSL/TLS is enabled

    Definition Classes
    StompServerOptionsNetServerOptionsTCPSSLOptions
  86. def setSupportedVersions(value: Buffer[String]): StompServerOptions

    Sets the STOMP protocol versions supported by the server.

    Sets the STOMP protocol versions supported by the server. Versions must be given in the decreasing order.

  87. def setTcpCork(value: Boolean): StompServerOptions

    Enable the TCP_CORK option - only with linux native transport.

    Enable the TCP_CORK option - only with linux native transport.

    Definition Classes
    StompServerOptionsNetServerOptionsTCPSSLOptions
  88. def setTcpFastOpen(value: Boolean): StompServerOptions

    Enable the TCP_FASTOPEN option - only with linux native transport.

    Enable the TCP_FASTOPEN option - only with linux native transport.

    Definition Classes
    StompServerOptionsNetServerOptionsTCPSSLOptions
  89. def setTcpKeepAlive(value: Boolean): StompServerOptions

    Set whether TCP keep alive is enabled

    Set whether TCP keep alive is enabled

    Definition Classes
    StompServerOptionsNetServerOptionsTCPSSLOptions
  90. def setTcpNoDelay(value: Boolean): StompServerOptions

    Set whether TCP no delay is enabled

    Set whether TCP no delay is enabled

    Definition Classes
    StompServerOptionsNetServerOptionsTCPSSLOptions
  91. def setTcpQuickAck(value: Boolean): StompServerOptions

    Enable the TCP_QUICKACK option - only with linux native transport.

    Enable the TCP_QUICKACK option - only with linux native transport.

    Definition Classes
    StompServerOptionsNetServerOptionsTCPSSLOptions
  92. def setTimeFactor(value: Int): StompServerOptions

    Sets the time factor.

  93. def setTrafficClass(value: Int): StompServerOptions

    Set the value of traffic class

    Set the value of traffic class

    Definition Classes
    StompServerOptionsNetServerOptionsTCPSSLOptionsNetworkOptions
  94. def setTrailingLine(value: Boolean): StompServerOptions

    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.

  95. def setTransactionChunkSize(value: Int): StompServerOptions

    Sets the chunk size when replaying a transaction.

    Sets the chunk size when replaying a transaction. To avoid blocking the event loop for too long, large transactions are split into chunks, replayed one by one. This settings sets the chunk size.

  96. def setTrustStoreOptions(value: JksOptions): StompServerOptions

    Set the trust options in jks format, aka Java truststore

    Set the trust options in jks format, aka Java truststore

    Definition Classes
    StompServerOptionsNetServerOptionsTCPSSLOptions
  97. def setUseAlpn(value: Boolean): StompServerOptions

    Set the ALPN usage.

    Set the ALPN usage.

    Definition Classes
    StompServerOptionsNetServerOptionsTCPSSLOptions
  98. def setUsePooledBuffers(value: Boolean): StompServerOptions

    Set whether Netty pooled buffers are enabled

    Set whether Netty pooled buffers are enabled

    Definition Classes
    StompServerOptionsNetServerOptionsTCPSSLOptions
  99. def setWebsocketBridge(value: Boolean): StompServerOptions

    Enables or disables the web socket bridge.

  100. def setWebsocketPath(value: String): StompServerOptions

    Sets the websocket path.

    Sets the websocket path. Only frames received on this path would be considered as STOMP frame.