public class MqttServerOptions extends NetServerOptions
| Modifier and Type | Field and Description |
|---|---|
static int |
DEFAULT_MAX_MESSAGE_SIZE |
static int |
DEFAULT_PORT |
static int |
DEFAULT_TIMEOUT_ON_CONNECT |
static int |
DEFAULT_TLS_PORT |
static String |
MQTT_SUBPROTOCOL_CSV_LIST |
DEFAULT_ACCEPT_BACKLOG, DEFAULT_CLIENT_AUTH, DEFAULT_HOST, DEFAULT_PROXY_PROTOCOL_TIMEOUT, DEFAULT_PROXY_PROTOCOL_TIMEOUT_TIME_UNIT, DEFAULT_SNI, DEFAULT_USE_PROXY_PROTOCOLDEFAULT_ENABLED_SECURE_TRANSPORT_PROTOCOLS, DEFAULT_IDLE_TIMEOUT, DEFAULT_IDLE_TIMEOUT_TIME_UNIT, DEFAULT_SO_LINGER, DEFAULT_SSL, DEFAULT_SSL_ENGINE, DEFAULT_SSL_HANDSHAKE_TIMEOUT, DEFAULT_SSL_HANDSHAKE_TIMEOUT_TIME_UNIT, DEFAULT_TCP_CORK, DEFAULT_TCP_FAST_OPEN, DEFAULT_TCP_KEEP_ALIVE, DEFAULT_TCP_NO_DELAY, DEFAULT_TCP_QUICKACK, DEFAULT_USE_ALPNDEFAULT_LOG_ENABLED, DEFAULT_RECEIVE_BUFFER_SIZE, DEFAULT_REUSE_ADDRESS, DEFAULT_REUSE_PORT, DEFAULT_SEND_BUFFER_SIZE, DEFAULT_TRAFFIC_CLASS| Constructor and Description |
|---|
MqttServerOptions()
Default constructor
|
MqttServerOptions(JsonObject json)
Create an options from JSON
|
MqttServerOptions(MqttServerOptions other)
Copy constructor
|
| Modifier and Type | Method and Description |
|---|---|
MqttServerOptions |
addCrlPath(String crlPath)
Add a CRL path
|
MqttServerOptions |
addCrlValue(Buffer crlValue)
Add a CRL value
|
MqttServerOptions |
addEnabledCipherSuite(String suite)
Add an enabled cipher suite, appended to the ordered suites.
|
MqttServerOptions |
addEnabledSecureTransportProtocol(String protocol)
Add an enabled SSL/TLS protocols, appended to the ordered protocols.
|
int |
getMaxMessageSize() |
boolean |
isAutoClientId() |
boolean |
isUseWebSocket() |
MqttServerOptions |
setAutoClientId(boolean isAutoClientId)
Set if clientid should be auto-generated when it's "zero-bytes"
|
MqttServerOptions |
setClientAuth(ClientAuth clientAuth)
Set whether client auth is required
|
MqttServerOptions |
setHost(String host)
Set the host
|
MqttServerOptions |
setKeyCertOptions(KeyCertOptions options)
Set the key/cert options.
|
MqttServerOptions |
setKeyStoreOptions(JksOptions options)
Set the key/cert options in jks format, aka Java keystore.
|
MqttServerOptions |
setMaxMessageSize(int maxMessageSize)
Set max MQTT message size
|
MqttServerOptions |
setPemKeyCertOptions(PemKeyCertOptions options)
Set the key/cert store options in pem format.
|
MqttServerOptions |
setPemTrustOptions(PemTrustOptions options)
Set the trust options in pem format
|
MqttServerOptions |
setPfxKeyCertOptions(PfxOptions options)
Set the key/cert options in pfx format.
|
MqttServerOptions |
setPfxTrustOptions(PfxOptions options)
Set the trust options in pfx format
|
MqttServerOptions |
setPort(int port)
Set the port
|
MqttServerOptions |
setReceiveBufferSize(int receiveBufferSize)
Set the TCP receive buffer size
|
MqttServerOptions |
setSni(boolean sni)
Set whether the server supports Server Name Indiciation
|
MqttServerOptions |
setSsl(boolean ssl)
Set whether SSL/TLS is enabled
|
MqttServerOptions |
setTimeoutOnConnect(int timeoutOnConnect)
Set the timeout on CONNECT packet
|
MqttServerOptions |
setTrustOptions(TrustOptions options)
Set the trust options.
|
MqttServerOptions |
setTrustStoreOptions(JksOptions options)
Set the trust options in jks format, aka Java truststore
|
MqttServerOptions |
setUseWebSocket(boolean useWebSocket)
enable mqtt over websocket
|
int |
timeoutOnConnect() |
getAcceptBacklog, getClientAuth, getHost, getPort, getProxyProtocolTimeout, getProxyProtocolTimeoutUnit, isSni, isUseProxyProtocol, removeEnabledSecureTransportProtocol, setAcceptBacklog, setEnabledSecureTransportProtocols, setIdleTimeout, setIdleTimeoutUnit, setJdkSslEngineOptions, setLogActivity, setOpenSslEngineOptions, setProxyProtocolTimeout, setProxyProtocolTimeoutUnit, setReuseAddress, setReusePort, setSendBufferSize, setSoLinger, setSslEngineOptions, setSslHandshakeTimeout, setSslHandshakeTimeoutUnit, setTcpCork, setTcpFastOpen, setTcpKeepAlive, setTcpNoDelay, setTcpQuickAck, setTrafficClass, setUseAlpn, setUseProxyProtocol, toJsongetCrlPaths, getCrlValues, getEnabledCipherSuites, getEnabledSecureTransportProtocols, getIdleTimeout, getIdleTimeoutUnit, getJdkSslEngineOptions, getKeyCertOptions, getKeyStoreOptions, getOpenSslEngineOptions, getPemKeyCertOptions, getPemTrustOptions, getPfxKeyCertOptions, getPfxTrustOptions, getSoLinger, getSslEngineOptions, getSslHandshakeTimeout, getSslHandshakeTimeoutUnit, getTrustOptions, getTrustStoreOptions, isSsl, isTcpCork, isTcpFastOpen, isTcpKeepAlive, isTcpNoDelay, isTcpQuickAck, isUseAlpngetLogActivity, getReceiveBufferSize, getSendBufferSize, getTrafficClass, isReuseAddress, isReusePortpublic static final int DEFAULT_PORT
public static final int DEFAULT_TLS_PORT
public static final int DEFAULT_MAX_MESSAGE_SIZE
public static final int DEFAULT_TIMEOUT_ON_CONNECT
public static final String MQTT_SUBPROTOCOL_CSV_LIST
public MqttServerOptions()
public MqttServerOptions(JsonObject json)
json - the JSONpublic MqttServerOptions(MqttServerOptions other)
other - the options to copypublic MqttServerOptions setPort(int port)
NetServerOptionssetPort in class NetServerOptionsport - the portpublic MqttServerOptions setHost(String host)
NetServerOptionssetHost in class NetServerOptionshost - the hostpublic MqttServerOptions setClientAuth(ClientAuth clientAuth)
NetServerOptionssetClientAuth in class NetServerOptionsclientAuth - One of "NONE, REQUEST, REQUIRED". If it's set to "REQUIRED" then server will require the
SSL cert to be presented otherwise it won't accept the request. If it's set to "REQUEST" then
it won't mandate the certificate to be presented, basically make it optional.public MqttServerOptions setSsl(boolean ssl)
TCPSSLOptionssetSsl in class NetServerOptionsssl - true if enabledpublic MqttServerOptions setKeyCertOptions(KeyCertOptions options)
TCPSSLOptionssetKeyCertOptions in class NetServerOptionsoptions - the key store optionspublic MqttServerOptions setKeyStoreOptions(JksOptions options)
TCPSSLOptionssetKeyStoreOptions in class NetServerOptionsoptions - the key store in jks formatpublic MqttServerOptions setPfxKeyCertOptions(PfxOptions options)
TCPSSLOptionssetPfxKeyCertOptions in class NetServerOptionsoptions - the key cert options in pfx formatpublic MqttServerOptions setPemKeyCertOptions(PemKeyCertOptions options)
TCPSSLOptionssetPemKeyCertOptions in class NetServerOptionsoptions - the options in pem formatpublic MqttServerOptions setTrustOptions(TrustOptions options)
TCPSSLOptionssetTrustOptions in class NetServerOptionsoptions - the trust optionspublic MqttServerOptions setTrustStoreOptions(JksOptions options)
TCPSSLOptionssetTrustStoreOptions in class NetServerOptionsoptions - the trust options in jks formatpublic MqttServerOptions setPemTrustOptions(PemTrustOptions options)
TCPSSLOptionssetPemTrustOptions in class NetServerOptionsoptions - the trust options in pem formatpublic MqttServerOptions setPfxTrustOptions(PfxOptions options)
TCPSSLOptionssetPfxTrustOptions in class NetServerOptionsoptions - the trust options in pfx formatpublic MqttServerOptions addEnabledCipherSuite(String suite)
TCPSSLOptionsaddEnabledCipherSuite in class NetServerOptionssuite - the suitepublic MqttServerOptions addEnabledSecureTransportProtocol(String protocol)
TCPSSLOptionsaddEnabledSecureTransportProtocol in class NetServerOptionsprotocol - the SSL/TLS protocol to enablepublic MqttServerOptions addCrlPath(String crlPath) throws NullPointerException
TCPSSLOptionsaddCrlPath in class NetServerOptionscrlPath - the pathNullPointerExceptionpublic MqttServerOptions addCrlValue(Buffer crlValue) throws NullPointerException
TCPSSLOptionsaddCrlValue in class NetServerOptionscrlValue - the valueNullPointerExceptionpublic MqttServerOptions setReceiveBufferSize(int receiveBufferSize)
NetworkOptionssetReceiveBufferSize in class NetServerOptionsreceiveBufferSize - the buffers size, in bytespublic MqttServerOptions setSni(boolean sni)
NetServerOptionssetSni in class NetServerOptionspublic MqttServerOptions setMaxMessageSize(int maxMessageSize)
maxMessageSize - max MQTT message size (variable header + payload)public int getMaxMessageSize()
public MqttServerOptions setAutoClientId(boolean isAutoClientId)
isAutoClientId - public boolean isAutoClientId()
public MqttServerOptions setTimeoutOnConnect(int timeoutOnConnect)
timeoutOnConnect - timeout on CONNECT before closing connectionpublic int timeoutOnConnect()
public MqttServerOptions setUseWebSocket(boolean useWebSocket)
useWebSocket - use mqtt over websocketpublic boolean isUseWebSocket()
Copyright © 2021 Eclipse. All rights reserved.