io.vertx.mqtt

Class MqttServerOptions

java.lang.Object

io.vertx.core.net.NetworkOptions

io.vertx.core.net.TCPSSLOptions

io.vertx.core.net.NetServerOptions

io.vertx.mqtt.MqttServerOptions

public class MqttServerOptions
extends NetServerOptions

Represents options used by the MQTT server

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_MESSAGE_SIZE
static int	DEFAULT_PORT
static int	DEFAULT_TLS_PORT

Fields inherited from class io.vertx.core.net.NetServerOptions

DEFAULT_ACCEPT_BACKLOG, DEFAULT_CLIENT_AUTH, DEFAULT_HOST

Fields inherited from class io.vertx.core.net.TCPSSLOptions

DEFAULT_IDLE_TIMEOUT, DEFAULT_SO_LINGER, DEFAULT_SSL, DEFAULT_SSL_ENGINE, DEFAULT_TCP_KEEP_ALIVE, DEFAULT_TCP_NO_DELAY, DEFAULT_USE_ALPN, DEFAULT_USE_POOLED_BUFFERS

Fields inherited from class io.vertx.core.net.NetworkOptions

DEFAULT_LOG_ENABLED, DEFAULT_RECEIVE_BUFFER_SIZE, DEFAULT_REUSE_ADDRESS, DEFAULT_SEND_BUFFER_SIZE, DEFAULT_TRAFFIC_CLASS

Constructor Summary

Constructors

Constructor and Description
MqttServerOptions() Default constructor
MqttServerOptions(JsonObject json) Create an options from JSON
MqttServerOptions(MqttServerOptions other) Copy constructor

Method Summary

Modifier and Type	Method and Description
MqttServerOptions	addCrlPath(String crlPath)
MqttServerOptions	addCrlValue(Buffer crlValue)
MqttServerOptions	addEnabledCipherSuite(String suite)
MqttServerOptions	addEnabledSecureTransportProtocol(String protocol)
int	getMaxMessageSize()
boolean	isAutoClientId()
MqttServerOptions	setAutoClientId(boolean isAutoClientId) Set if clientid should be auto-generated when it's "zero-bytes"
MqttServerOptions	setHost(String host)
MqttServerOptions	setKeyCertOptions(KeyCertOptions options)
MqttServerOptions	setKeyStoreOptions(JksOptions options)
MqttServerOptions	setMaxMessageSize(int maxMessageSize) Set max MQTT message size
MqttServerOptions	setPemKeyCertOptions(PemKeyCertOptions options)
MqttServerOptions	setPemTrustOptions(PemTrustOptions options)
MqttServerOptions	setPfxKeyCertOptions(PfxOptions options)
MqttServerOptions	setPfxTrustOptions(PfxOptions options)
MqttServerOptions	setPort(int port)
MqttServerOptions	setReceiveBufferSize(int receiveBufferSize)
MqttServerOptions	setSsl(boolean ssl)
MqttServerOptions	setTrustOptions(TrustOptions options)
MqttServerOptions	setTrustStoreOptions(JksOptions options)

Methods inherited from class io.vertx.core.net.NetServerOptions

equals, getAcceptBacklog, getClientAuth, getHost, getPort, hashCode, isClientAuthRequired, setAcceptBacklog, setClientAuth, setClientAuthRequired, setIdleTimeout, setJdkSslEngineOptions, setLogActivity, setOpenSslEngineOptions, setReuseAddress, setSendBufferSize, setSoLinger, setSslEngineOptions, setTcpKeepAlive, setTcpNoDelay, setTrafficClass, setUseAlpn, setUsePooledBuffers, toJson

Methods inherited from class io.vertx.core.net.TCPSSLOptions

getCrlPaths, getCrlValues, getEnabledCipherSuites, getEnabledSecureTransportProtocols, getIdleTimeout, getJdkSslEngineOptions, getKeyCertOptions, getKeyStoreOptions, getOpenSslEngineOptions, getPemKeyCertOptions, getPemTrustOptions, getPfxKeyCertOptions, getPfxTrustOptions, getSoLinger, getSslEngineOptions, getTrustOptions, getTrustStoreOptions, isSsl, isTcpKeepAlive, isTcpNoDelay, isUseAlpn, isUsePooledBuffers

Methods inherited from class io.vertx.core.net.NetworkOptions

getLogActivity, getReceiveBufferSize, getSendBufferSize, getTrafficClass, isReuseAddress

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

Constant Field Values

DEFAULT_TLS_PORT

public static final int DEFAULT_TLS_PORT

See Also:

Constant Field Values

DEFAULT_MAX_MESSAGE_SIZE

public static final int DEFAULT_MAX_MESSAGE_SIZE

See Also:

Constant Field Values

Constructor Detail

MqttServerOptions

public MqttServerOptions()

Default constructor

MqttServerOptions

public MqttServerOptions(JsonObject json)

Create an options from JSON

Parameters:

json - the JSON

MqttServerOptions

public MqttServerOptions(MqttServerOptions other)

Copy constructor

Parameters:

other - the options to copy

Method Detail

setPort

public MqttServerOptions setPort(int port)

Overrides:

setPort in class NetServerOptions

setHost

public MqttServerOptions setHost(String host)

Overrides:

setHost in class NetServerOptions

setSsl

public MqttServerOptions setSsl(boolean ssl)

Overrides:

setSsl in class NetServerOptions

setKeyCertOptions

public MqttServerOptions setKeyCertOptions(KeyCertOptions options)

Overrides:

setKeyCertOptions in class NetServerOptions

setKeyStoreOptions

public MqttServerOptions setKeyStoreOptions(JksOptions options)

Overrides:

setKeyStoreOptions in class NetServerOptions

setPfxKeyCertOptions

public MqttServerOptions setPfxKeyCertOptions(PfxOptions options)

Overrides:

setPfxKeyCertOptions in class NetServerOptions

setPemKeyCertOptions

public MqttServerOptions setPemKeyCertOptions(PemKeyCertOptions options)

Overrides:

setPemKeyCertOptions in class NetServerOptions

setTrustOptions

public MqttServerOptions setTrustOptions(TrustOptions options)

Overrides:

setTrustOptions in class NetServerOptions

setTrustStoreOptions

public MqttServerOptions setTrustStoreOptions(JksOptions options)

Overrides:

setTrustStoreOptions in class NetServerOptions

setPemTrustOptions

public MqttServerOptions setPemTrustOptions(PemTrustOptions options)

Overrides:

setPemTrustOptions in class NetServerOptions

setPfxTrustOptions

public MqttServerOptions setPfxTrustOptions(PfxOptions options)

Overrides:

setPfxTrustOptions in class NetServerOptions

addEnabledCipherSuite

public MqttServerOptions addEnabledCipherSuite(String suite)

Overrides:

addEnabledCipherSuite in class NetServerOptions

addEnabledSecureTransportProtocol

public MqttServerOptions addEnabledSecureTransportProtocol(String protocol)

Overrides:

addEnabledSecureTransportProtocol in class NetServerOptions

addCrlPath

public MqttServerOptions addCrlPath(String crlPath)
                             throws NullPointerException

Overrides:

addCrlPath in class NetServerOptions

Throws:

NullPointerException

addCrlValue

public MqttServerOptions addCrlValue(Buffer crlValue)
                              throws NullPointerException

Overrides:

addCrlValue in class NetServerOptions

Throws:

NullPointerException

setReceiveBufferSize

public MqttServerOptions setReceiveBufferSize(int receiveBufferSize)

Overrides:

setReceiveBufferSize in class NetServerOptions

setMaxMessageSize

public MqttServerOptions setMaxMessageSize(int maxMessageSize)

Set max MQTT message size

Parameters:

maxMessageSize - max MQTT message size (variable header + payload)

Returns:

MQTT server options instance

getMaxMessageSize

public int getMaxMessageSize()

Returns:

max MQTT message size (variable header + payload)

setAutoClientId

public MqttServerOptions setAutoClientId(boolean isAutoClientId)

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

Parameters:

isAutoClientId -

Returns:

MQTT server options instance

isAutoClientId

public boolean isAutoClientId()

Returns:

if clientid should be auto-generated when it's "zero-bytes" (default is true)