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 mqtt
  Definition Classes
    scala
-  package messages
  Definition Classes
    mqtt
- MqttAuth
- MqttClient
- MqttClientOptions
- MqttEndpoint
- MqttServer
- MqttServerOptions
- MqttTopicSubscription
- MqttWill

c

io.vertx.scala.mqtt

# MqttServerOptions 

###
Companion object MqttServerOptions

#### class MqttServerOptions extends NetServerOptions

Represents options used by the MQTT server

Linear Supertypes
NetServerOptions, TCPSSLOptions, NetworkOptions, AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. MqttServerOptions
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 MqttServerOptions(_asJava: mqtt.MqttServerOptions)

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

   Add a CRL path

   Add a CRL path

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

   Add a CRL value

   Add a CRL value

   Definition Classes
     MqttServerOptions → NetServerOptions → TCPSSLOptions
6.  def addEnabledCipherSuite(value: String): MqttServerOptions

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

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

   Definition Classes
     MqttServerOptions → NetServerOptions → TCPSSLOptions
7.  def addEnabledSecureTransportProtocol(value: String): MqttServerOptions

   Sets the list of enabled SSL/TLS protocols.

   Sets the list of enabled SSL/TLS protocols.

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

    Set the accept back log

    Set the accept back log

    Definition Classes
      MqttServerOptions → NetServerOptions
60.  def setAutoClientId(value: Boolean): MqttServerOptions

    Set if clientid should be auto-generated when it's "zero-bytes"

61.  def setClientAuth(value: ClientAuth): MqttServerOptions

    Set whether client auth is required

    Set whether client auth is required

    Definition Classes
      MqttServerOptions → NetServerOptions
62.  def setClientAuthRequired(value: Boolean): MqttServerOptions

    Set whether client auth is required

    Set whether client auth is required

    Definition Classes
      MqttServerOptions → NetServerOptions
63.  def setEnabledSecureTransportProtocols(value: Set[String]): MqttServerOptions
    Definition Classes
      MqttServerOptions → NetServerOptions → TCPSSLOptions
64.  def setHost(value: String): MqttServerOptions

    Set the host

    Set the host

    Definition Classes
      MqttServerOptions → NetServerOptions
65.  def setIdleTimeout(value: Int): MqttServerOptions

    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
      MqttServerOptions → NetServerOptions → TCPSSLOptions
66.  def setIdleTimeoutUnit(value: TimeUnit): MqttServerOptions

    Set the idle timeout unit.

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

    Definition Classes
      MqttServerOptions → NetServerOptions → TCPSSLOptions
67.  def setJdkSslEngineOptions(value: JdkSSLEngineOptions): MqttServerOptions
    Definition Classes
      MqttServerOptions → NetServerOptions → TCPSSLOptions
68.  def setKeyStoreOptions(value: JksOptions): MqttServerOptions

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

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

    Definition Classes
      MqttServerOptions → NetServerOptions → TCPSSLOptions
69.  def setLogActivity(value: Boolean): MqttServerOptions

    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
      MqttServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
70.  def setMaxMessageSize(value: Int): MqttServerOptions

    Set max MQTT message size

71.  def setOpenSslEngineOptions(value: OpenSSLEngineOptions): MqttServerOptions
    Definition Classes
      MqttServerOptions → NetServerOptions → TCPSSLOptions
72.  def setPemKeyCertOptions(value: PemKeyCertOptions): MqttServerOptions

    Set the key/cert store options in pem format.

    Set the key/cert store options in pem format.

    Definition Classes
      MqttServerOptions → NetServerOptions → TCPSSLOptions
73.  def setPemTrustOptions(value: PemTrustOptions): MqttServerOptions

    Set the trust options in pem format

    Set the trust options in pem format

    Definition Classes
      MqttServerOptions → NetServerOptions → TCPSSLOptions
74.  def setPfxKeyCertOptions(value: PfxOptions): MqttServerOptions

    Set the key/cert options in pfx format.

    Set the key/cert options in pfx format.

    Definition Classes
      MqttServerOptions → NetServerOptions → TCPSSLOptions
75.  def setPfxTrustOptions(value: PfxOptions): MqttServerOptions

    Set the trust options in pfx format

    Set the trust options in pfx format

    Definition Classes
      MqttServerOptions → NetServerOptions → TCPSSLOptions
76.  def setPort(value: Int): MqttServerOptions

    Set the port

    Set the port

    Definition Classes
      MqttServerOptions → NetServerOptions
77.  def setReceiveBufferSize(value: Int): MqttServerOptions

    Set the TCP receive buffer size

    Set the TCP receive buffer size

    Definition Classes
      MqttServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
78.  def setReuseAddress(value: Boolean): MqttServerOptions

    Set the value of reuse address

    Set the value of reuse address

    Definition Classes
      MqttServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
79.  def setReusePort(value: Boolean): MqttServerOptions

    Set the value of reuse port.

    Set the value of reuse port.

    This is only supported by native transports.

    Definition Classes
      MqttServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
80.  def setSendBufferSize(value: Int): MqttServerOptions

    Set the TCP send buffer size

    Set the TCP send buffer size

    Definition Classes
      MqttServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
81.  def setSni(value: Boolean): MqttServerOptions

    Set whether the server supports Server Name Indiciation

    Set whether the server supports Server Name Indiciation

    Definition Classes
      MqttServerOptions → NetServerOptions
82.  def setSoLinger(value: Int): MqttServerOptions

    Set whether SO_linger keep alive is enabled

    Set whether SO_linger keep alive is enabled

    Definition Classes
      MqttServerOptions → NetServerOptions → TCPSSLOptions
83.  def setSsl(value: Boolean): MqttServerOptions

    Set whether SSL/TLS is enabled

    Set whether SSL/TLS is enabled

    Definition Classes
      MqttServerOptions → NetServerOptions → TCPSSLOptions
84.  def setSslHandshakeTimeout(value: Long): MqttServerOptions

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

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

    Definition Classes
      MqttServerOptions → NetServerOptions → TCPSSLOptions
85.  def setSslHandshakeTimeoutUnit(value: TimeUnit): MqttServerOptions

    Set the SSL handshake timeout unit.

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

    Definition Classes
      MqttServerOptions → NetServerOptions → TCPSSLOptions
86.  def setTcpCork(value: Boolean): MqttServerOptions

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

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

    Definition Classes
      MqttServerOptions → NetServerOptions → TCPSSLOptions
87.  def setTcpFastOpen(value: Boolean): MqttServerOptions

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

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

    Definition Classes
      MqttServerOptions → NetServerOptions → TCPSSLOptions
88.  def setTcpKeepAlive(value: Boolean): MqttServerOptions

    Set whether TCP keep alive is enabled

    Set whether TCP keep alive is enabled

    Definition Classes
      MqttServerOptions → NetServerOptions → TCPSSLOptions
89.  def setTcpNoDelay(value: Boolean): MqttServerOptions

    Set whether TCP no delay is enabled

    Set whether TCP no delay is enabled

    Definition Classes
      MqttServerOptions → NetServerOptions → TCPSSLOptions
90.  def setTcpQuickAck(value: Boolean): MqttServerOptions

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

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

    Definition Classes
      MqttServerOptions → NetServerOptions → TCPSSLOptions
91.  def setTimeoutOnConnect(value: Int): MqttServerOptions

    Set the timeout on CONNECT packet

92.  def setTrafficClass(value: Int): MqttServerOptions

    Set the value of traffic class

    Set the value of traffic class

    Definition Classes
      MqttServerOptions → NetServerOptions → TCPSSLOptions → NetworkOptions
93.  def setTrustStoreOptions(value: JksOptions): MqttServerOptions

    Set the trust options in jks format, aka Java truststore

    Set the trust options in jks format, aka Java truststore

    Definition Classes
      MqttServerOptions → NetServerOptions → TCPSSLOptions
94.  def setUseAlpn(value: Boolean): MqttServerOptions

    Set the ALPN usage.

    Set the ALPN usage.

    Definition Classes
      MqttServerOptions → NetServerOptions → TCPSSLOptions
95.  def setUsePooledBuffers(value: Boolean): MqttServerOptions

    Set whether Netty pooled buffers are enabled

    Set whether Netty pooled buffers are enabled

    Definition Classes
      MqttServerOptions → NetServerOptions → TCPSSLOptions
96.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
97.  def toString(): String
    Definition Classes
      AnyRef → Any
98.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
99.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
100.  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