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

# StompServerOptions 

###
Companion object StompServerOptions

#### class StompServerOptions extends NetServerOptions

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

Linear Supertypes
NetServerOptions, TCPSSLOptions, NetworkOptions, AnyRef, Any
 
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.  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): StompServerOptions

   Add a CRL path

   Add a CRL path

   Definition Classes
     StompServerOptions → NetServerOptions → TCPSSLOptions
5.  def addCrlValue(value: Buffer): StompServerOptions

   Add a CRL value

   Add a CRL value

   Definition Classes
     StompServerOptions → NetServerOptions → TCPSSLOptions
6.  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
     StompServerOptions → NetServerOptions → TCPSSLOptions
7.  def addEnabledSecureTransportProtocol(value: String): StompServerOptions

   Sets the list of enabled SSL/TLS protocols.

   Sets the list of enabled SSL/TLS protocols.

   Definition Classes
     StompServerOptions → NetServerOptions → TCPSSLOptions
8.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
9.  def asJava: ext.stomp.StompServerOptions
   Definition Classes
     StompServerOptions → NetServerOptions
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 getAcceptBacklog: Int
    Definition Classes
      StompServerOptions → NetServerOptions
15.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
16.  def getClientAuth: ClientAuth
    Definition Classes
      StompServerOptions → NetServerOptions
17.  def getCrlPaths: Buffer[String]
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions
18.  def getCrlValues: Buffer[Buffer]
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions
19.  def getEnabledCipherSuites: Set[String]
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions
20.  def getEnabledSecureTransportProtocols: Set[String]
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions
21.  def getHeartbeat: JsonObject
22.  def getHost: String
    Definition Classes
      StompServerOptions → NetServerOptions
23.  def getIdleTimeout: Int
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions
24.  def getIdleTimeoutUnit: TimeUnit
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions
25.  def getJdkSslEngineOptions: JdkSSLEngineOptions
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions
26.  def getKeyStoreOptions: JksOptions
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions
27.  def getLogActivity: Boolean
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
28.  def getMaxBodyLength: Int
29.  def getMaxFrameInTransaction: Int
30.  def getMaxHeaderLength: Int
31.  def getMaxHeaders: Int
32.  def getMaxSubscriptionsByClient: Int
33.  def getOpenSslEngineOptions: OpenSSLEngineOptions
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions
34.  def getPemKeyCertOptions: PemKeyCertOptions
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions
35.  def getPemTrustOptions: PemTrustOptions
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions
36.  def getPfxKeyCertOptions: PfxOptions
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions
37.  def getPfxTrustOptions: PfxOptions
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions
38.  def getPort: Int
    Definition Classes
      StompServerOptions → NetServerOptions
39.  def getReceiveBufferSize: Int
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
40.  def getSendBufferSize: Int
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
41.  def getSoLinger: Int
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions
42.  def getSslHandshakeTimeout: Long
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions
43.  def getSslHandshakeTimeoutUnit: TimeUnit
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions
44.  def getSupportedVersions: Buffer[String]
45.  def getTimeFactor: Int
46.  def getTrafficClass: Int
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
47.  def getTransactionChunkSize: Int
48.  def getTrustStoreOptions: JksOptions
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions
49.  def getWebsocketPath: String
50.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
51.  def isClientAuthRequired: Boolean
    Definition Classes
      StompServerOptions → NetServerOptions
52.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
53.  def isReuseAddress: Boolean
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
54.  def isReusePort: Boolean
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
55.  def isSecured: Boolean
56.  def isSendErrorOnNoSubscriptions: Boolean
57.  def isSni: Boolean
    Definition Classes
      StompServerOptions → NetServerOptions
58.  def isSsl: Boolean
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions
59.  def isTcpCork: Boolean
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions
60.  def isTcpFastOpen: Boolean
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions
61.  def isTcpKeepAlive: Boolean
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions
62.  def isTcpNoDelay: Boolean
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions
63.  def isTcpQuickAck: Boolean
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions
64.  def isTrailingLine: Boolean
65.  def isUseAlpn: Boolean
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions
66.  def isUsePooledBuffers: Boolean
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions
67.  def isWebsocketBridge: Boolean
68.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
69.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
70.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
71.  def setAcceptBacklog(value: Int): StompServerOptions

    Set the accept back log

    Set the accept back log

    Definition Classes
      StompServerOptions → NetServerOptions
72.  def setClientAuth(value: ClientAuth): StompServerOptions

    Set whether client auth is required

    Set whether client auth is required

    Definition Classes
      StompServerOptions → NetServerOptions
73.  def setClientAuthRequired(value: Boolean): StompServerOptions

    Set whether client auth is required

    Set whether client auth is required

    Definition Classes
      StompServerOptions → NetServerOptions
74.  def setEnabledSecureTransportProtocols(value: Set[String]): StompServerOptions
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions
75.  def setHeartbeat(value: JsonObject): StompServerOptions

    Sets the heartbeat configuration.

76.  def setHost(value: String): StompServerOptions

    Set the host

    Set the host

    Definition Classes
      StompServerOptions → NetServerOptions
77.  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
      StompServerOptions → NetServerOptions → TCPSSLOptions
78.  def setIdleTimeoutUnit(value: TimeUnit): StompServerOptions

    Set the idle timeout unit.

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

    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions
79.  def setJdkSslEngineOptions(value: JdkSSLEngineOptions): StompServerOptions
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions
80.  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
      StompServerOptions → NetServerOptions → TCPSSLOptions
81.  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
      StompServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
82.  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.

83.  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.

84.  def setMaxHeaderLength(value: Int): StompServerOptions

    Sets the max header length.

85.  def setMaxHeaders(value: Int): StompServerOptions

    Sets the maximum number of headers.

    Sets the maximum number of headers. 1000 by default.

86.  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.

87.  def setOpenSslEngineOptions(value: OpenSSLEngineOptions): StompServerOptions
    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions
88.  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
      StompServerOptions → NetServerOptions → TCPSSLOptions
89.  def setPemTrustOptions(value: PemTrustOptions): StompServerOptions

    Set the trust options in pem format

    Set the trust options in pem format

    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions
90.  def setPfxKeyCertOptions(value: PfxOptions): StompServerOptions

    Set the key/cert options in pfx format.

    Set the key/cert options in pfx format.

    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions
91.  def setPfxTrustOptions(value: PfxOptions): StompServerOptions

    Set the trust options in pfx format

    Set the trust options in pfx format

    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions
92.  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
      StompServerOptions → NetServerOptions
93.  def setReceiveBufferSize(value: Int): StompServerOptions

    Set the TCP receive buffer size

    Set the TCP receive buffer size

    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
94.  def setReuseAddress(value: Boolean): StompServerOptions

    Set the value of reuse address

    Set the value of reuse address

    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
95.  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
      StompServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
96.  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.

97.  def setSendBufferSize(value: Int): StompServerOptions

    Set the TCP send buffer size

    Set the TCP send buffer size

    Definition Classes
      StompServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
98.  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).

99.  def setSni(value: Boolean): StompServerOptions

    Set whether the server supports Server Name Indiciation

    Set whether the server supports Server Name Indiciation

    Definition Classes
      StompServerOptions → NetServerOptions
100.  def setSoLinger(value: Int): StompServerOptions

     Set whether SO_linger keep alive is enabled

     Set whether SO_linger keep alive is enabled

     Definition Classes
       StompServerOptions → NetServerOptions → TCPSSLOptions
101.  def setSsl(value: Boolean): StompServerOptions

     Set whether SSL/TLS is enabled

     Set whether SSL/TLS is enabled

     Definition Classes
       StompServerOptions → NetServerOptions → TCPSSLOptions
102.  def setSslHandshakeTimeout(value: Long): StompServerOptions

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

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

     Definition Classes
       StompServerOptions → NetServerOptions → TCPSSLOptions
103.  def setSslHandshakeTimeoutUnit(value: TimeUnit): StompServerOptions

     Set the SSL handshake timeout unit.

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

     Definition Classes
       StompServerOptions → NetServerOptions → TCPSSLOptions
104.  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.

105.  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
       StompServerOptions → NetServerOptions → TCPSSLOptions
106.  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
       StompServerOptions → NetServerOptions → TCPSSLOptions
107.  def setTcpKeepAlive(value: Boolean): StompServerOptions

     Set whether TCP keep alive is enabled

     Set whether TCP keep alive is enabled

     Definition Classes
       StompServerOptions → NetServerOptions → TCPSSLOptions
108.  def setTcpNoDelay(value: Boolean): StompServerOptions

     Set whether TCP no delay is enabled

     Set whether TCP no delay is enabled

     Definition Classes
       StompServerOptions → NetServerOptions → TCPSSLOptions
109.  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
       StompServerOptions → NetServerOptions → TCPSSLOptions
110.  def setTimeFactor(value: Int): StompServerOptions

     Sets the time factor.

111.  def setTrafficClass(value: Int): StompServerOptions

     Set the value of traffic class

     Set the value of traffic class

     Definition Classes
       StompServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
112.  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.

113.  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.

114.  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
       StompServerOptions → NetServerOptions → TCPSSLOptions
115.  def setUseAlpn(value: Boolean): StompServerOptions

     Set the ALPN usage.

     Set the ALPN usage.

     Definition Classes
       StompServerOptions → NetServerOptions → TCPSSLOptions
116.  def setUsePooledBuffers(value: Boolean): StompServerOptions

     Set whether Netty pooled buffers are enabled

     Set whether Netty pooled buffers are enabled

     Definition Classes
       StompServerOptions → NetServerOptions → TCPSSLOptions
117.  def setWebsocketBridge(value: Boolean): StompServerOptions

     Enables or disables the web socket bridge.

118.  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.

119.  final def synchronized[T0](arg0: ⇒ T0): T0
     Definition Classes
       AnyRef
120.  def toString(): String
     Definition Classes
       AnyRef → Any
121.  final def wait(): Unit
     Definition Classes
       AnyRef
     Annotations
       @throws( ... )
122.  final def wait(arg0: Long, arg1: Int): Unit
     Definition Classes
       AnyRef
     Annotations
       @throws( ... )
123.  final def wait(arg0: Long): Unit
     Definition Classes
       AnyRef
     Annotations
       @native() @throws( ... )

### Inherited from NetServerOptions

### Inherited from TCPSSLOptions

### Inherited from NetworkOptions

### Inherited from AnyRef

### Inherited from Any

### Ungrouped