org.dromara.mica.mqtt.core.client

Class MqttClientCreator

java.lang.Object

org.dromara.mica.mqtt.core.client.MqttClientCreator

public final class MqttClientCreator
extends Object

mqtt 客户端构造器

Author:

L.cm, ChangJin Wei (魏昌进)

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_KEEP_ALIVE_SECS 默认的心跳超时

Constructor Summary

Constructors

Constructor and Description
MqttClientCreator()

Method Summary

Modifier and Type	Method and Description
MqttClientCreator	bindIp(String bindIp)
MqttClientCreator	bindNetworkInterface(String networkInterfaceName)
MqttClientCreator	bizThreadPoolSize(int poolSize)
MqttClientCreator	cleanStart(boolean cleanStart)
MqttClientCreator	clientId(String clientId)
MqttClientCreator	clientSession(IMqttClientSession clientSession)
MqttClient	connect() 默认异步连接
MqttClientCreator	connectListener(IMqttClientConnectListener connectListener)
MqttClient	connectSync() 同步连接
org.dromara.mica.mqtt.codec.MqttConnectReasonCode	connectTest() 连接测试
org.dromara.mica.mqtt.codec.MqttConnectReasonCode	connectTest(long timeout, TimeUnit timeUnit) 连接测试
MqttClientCreator	debug()
MqttClientCreator	debug(boolean debug)
String	getBindIp()
String	getClientId()
IMqttClientSession	getClientSession()
IMqttClientConnectListener	getConnectListener()
IMqttClientGlobalMessageListener	getGlobalMessageListener()
Set<org.dromara.mica.mqtt.codec.MqttTopicSubscription>	getGlobalSubscribe()
ExecutorService	getGroupExecutor()
org.tio.core.task.HeartbeatMode	getHeartbeatMode()
org.tio.client.task.HeartbeatTimeoutStrategy	getHeartbeatTimeoutStrategy()
String	getIp()
int	getKeepAliveSecs()
int	getMaxBytesInMessage()
int	getMaxClientIdLength()
ExecutorService	getMqttExecutor()
MqttSerializer	getMqttSerializer()
String	getName()
String	getPassword()
int	getPort()
org.dromara.mica.mqtt.codec.MqttProperties	getProperties()
int	getReadBufferSize()
long	getReInterval()
int	getReSubscribeBatchSize()
int	getRetryCount()
Integer	getSessionExpiryIntervalSecs()
org.tio.core.ssl.SslConfig	getSslConfig()
org.tio.utils.timer.TimerTaskService	getTaskService()
Integer	getTimeout()
org.tio.utils.thread.pool.SynThreadPoolExecutor	getTioExecutor()
String	getUsername()
org.dromara.mica.mqtt.codec.MqttVersion	getVersion()
MqttWillMessage	getWillMessage()
MqttClientCreator	globalMessageListener(IMqttClientGlobalMessageListener globalMessageListener)
MqttClientCreator	globalSubscribe(List<org.dromara.mica.mqtt.codec.MqttTopicSubscription> topicList)
MqttClientCreator	globalSubscribe(org.dromara.mica.mqtt.codec.MqttTopicSubscription... topics)
MqttClientCreator	globalSubscribe(String... topics)
MqttClientCreator	groupExecutor(ExecutorService groupExecutor)
MqttClientCreator	heartbeatMode(org.tio.core.task.HeartbeatMode heartbeatMode)
MqttClientCreator	heartbeatTimeoutStrategy(org.tio.client.task.HeartbeatTimeoutStrategy heartbeatTimeoutStrategy)
MqttClientCreator	ip(String ip)
boolean	isCleanStart()
boolean	isDebug()
boolean	isReconnect()
boolean	isStatEnable()
MqttClientCreator	keepAliveSecs(int keepAliveSecs)
MqttClientCreator	maxBytesInMessage(int maxBytesInMessage)
MqttClientCreator	maxClientIdLength(int maxClientIdLength)
MqttClientCreator	mqttExecutor(ExecutorService mqttExecutor)
MqttClientCreator	mqttJsonSerializer(MqttSerializer mqttSerializer)
MqttClientCreator	name(String name)
MqttClientCreator	newCreator()
MqttClientCreator	password(String password)
MqttClientCreator	port(int port)
MqttClientCreator	properties(org.dromara.mica.mqtt.codec.MqttProperties properties)
MqttClientCreator	readBufferSize(int readBufferSize)
MqttClientCreator	reconnect(boolean reconnect)
MqttClientCreator	reInterval(long reInterval)
MqttClientCreator	reSubscribeBatchSize(int reSubscribeBatchSize)
MqttClientCreator	retryCount(int retryCount)
MqttClientCreator	sessionExpiryIntervalSecs(Integer sessionExpiryIntervalSecs)
MqttClientCreator	sslConfig(org.tio.core.ssl.SslConfig sslConfig)
MqttClientCreator	statEnable()
MqttClientCreator	statEnable(boolean enable)
MqttClientCreator	taskService(org.tio.utils.timer.TimerTaskService taskService)
MqttClientCreator	timeout(int timeout)
MqttClientCreator	tioConfigCustomize(Consumer<org.tio.core.TioConfig> tioConfigCustomize)
MqttClientCreator	tioExecutor(org.tio.utils.thread.pool.SynThreadPoolExecutor tioExecutor)
MqttClientCreator	username(String username)
MqttClientCreator	useSsl()
MqttClientCreator	useSsl(InputStream trustStoreInputStream, String trustPassword)
MqttClientCreator	useSsl(InputStream keyStoreInputStream, String keyPasswd, InputStream trustStoreInputStream, String trustPassword)
MqttClientCreator	useSsl(String trustStoreFile, String trustPassword)
MqttClientCreator	useSsl(String keyStoreFile, String keyPasswd, String trustStoreFile, String trustPassword)
MqttClientCreator	version(org.dromara.mica.mqtt.codec.MqttVersion version)
MqttClientCreator	willMessage(Consumer<MqttWillMessage.Builder> consumer)
MqttClientCreator	willMessage(MqttWillMessage willMessage)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_KEEP_ALIVE_SECS

public static final int DEFAULT_KEEP_ALIVE_SECS

默认的心跳超时

See Also:

Constant Field Values

Constructor Detail

MqttClientCreator

public MqttClientCreator()

Method Detail

getName

public String getName()

getIp

public String getIp()

getPort

public int getPort()

getTimeout

public Integer getTimeout()

getBindIp

public String getBindIp()

getReadBufferSize

public int getReadBufferSize()

getMaxBytesInMessage

public int getMaxBytesInMessage()

getMaxClientIdLength

public int getMaxClientIdLength()

getKeepAliveSecs

public int getKeepAliveSecs()

getHeartbeatMode

public org.tio.core.task.HeartbeatMode getHeartbeatMode()

getHeartbeatTimeoutStrategy

public org.tio.client.task.HeartbeatTimeoutStrategy getHeartbeatTimeoutStrategy()

getSslConfig

public org.tio.core.ssl.SslConfig getSslConfig()

isReconnect

public boolean isReconnect()

getRetryCount

public int getRetryCount()

getReInterval

public long getReInterval()

getReSubscribeBatchSize

public int getReSubscribeBatchSize()

getClientId

public String getClientId()

getVersion

public org.dromara.mica.mqtt.codec.MqttVersion getVersion()

getUsername

public String getUsername()

getPassword

public String getPassword()

isCleanStart

public boolean isCleanStart()

getSessionExpiryIntervalSecs

public Integer getSessionExpiryIntervalSecs()

getWillMessage

public MqttWillMessage getWillMessage()

getProperties

public org.dromara.mica.mqtt.codec.MqttProperties getProperties()

getConnectListener

public IMqttClientConnectListener getConnectListener()

getGlobalSubscribe

public Set<org.dromara.mica.mqtt.codec.MqttTopicSubscription> getGlobalSubscribe()

getGlobalMessageListener

public IMqttClientGlobalMessageListener getGlobalMessageListener()

getClientSession

public IMqttClientSession getClientSession()

isStatEnable

public boolean isStatEnable()

isDebug

public boolean isDebug()

getTioExecutor

public org.tio.utils.thread.pool.SynThreadPoolExecutor getTioExecutor()

getGroupExecutor

public ExecutorService getGroupExecutor()

getMqttExecutor

public ExecutorService getMqttExecutor()

getTaskService

public org.tio.utils.timer.TimerTaskService getTaskService()

getMqttSerializer

public MqttSerializer getMqttSerializer()

name

public MqttClientCreator name(String name)

ip

public MqttClientCreator ip(String ip)

port

public MqttClientCreator port(int port)

timeout

public MqttClientCreator timeout(int timeout)

bindIp

public MqttClientCreator bindIp(String bindIp)

bindNetworkInterface

public MqttClientCreator bindNetworkInterface(String networkInterfaceName)

readBufferSize

public MqttClientCreator readBufferSize(int readBufferSize)

maxBytesInMessage

public MqttClientCreator maxBytesInMessage(int maxBytesInMessage)

maxClientIdLength

public MqttClientCreator maxClientIdLength(int maxClientIdLength)

keepAliveSecs

public MqttClientCreator keepAliveSecs(int keepAliveSecs)

heartbeatMode

public MqttClientCreator heartbeatMode(org.tio.core.task.HeartbeatMode heartbeatMode)

heartbeatTimeoutStrategy

public MqttClientCreator heartbeatTimeoutStrategy(org.tio.client.task.HeartbeatTimeoutStrategy heartbeatTimeoutStrategy)

useSsl

public MqttClientCreator useSsl()

useSsl

public MqttClientCreator useSsl(String trustStoreFile,
                                String trustPassword)

useSsl

public MqttClientCreator useSsl(String keyStoreFile,
                                String keyPasswd,
                                String trustStoreFile,
                                String trustPassword)

useSsl

public MqttClientCreator useSsl(InputStream trustStoreInputStream,
                                String trustPassword)

useSsl

public MqttClientCreator useSsl(InputStream keyStoreInputStream,
                                String keyPasswd,
                                InputStream trustStoreInputStream,
                                String trustPassword)

sslConfig

public MqttClientCreator sslConfig(org.tio.core.ssl.SslConfig sslConfig)

reconnect

public MqttClientCreator reconnect(boolean reconnect)

retryCount

public MqttClientCreator retryCount(int retryCount)

reInterval

public MqttClientCreator reInterval(long reInterval)

reSubscribeBatchSize

public MqttClientCreator reSubscribeBatchSize(int reSubscribeBatchSize)

clientId

public MqttClientCreator clientId(String clientId)

version

public MqttClientCreator version(org.dromara.mica.mqtt.codec.MqttVersion version)

username

public MqttClientCreator username(String username)

password

public MqttClientCreator password(String password)

cleanStart

public MqttClientCreator cleanStart(boolean cleanStart)

sessionExpiryIntervalSecs

public MqttClientCreator sessionExpiryIntervalSecs(Integer sessionExpiryIntervalSecs)

willMessage

public MqttClientCreator willMessage(MqttWillMessage willMessage)

willMessage

public MqttClientCreator willMessage(Consumer<MqttWillMessage.Builder> consumer)

properties

public MqttClientCreator properties(org.dromara.mica.mqtt.codec.MqttProperties properties)

connectListener

public MqttClientCreator connectListener(IMqttClientConnectListener connectListener)

globalSubscribe

public MqttClientCreator globalSubscribe(String... topics)

globalSubscribe

public MqttClientCreator globalSubscribe(org.dromara.mica.mqtt.codec.MqttTopicSubscription... topics)

globalSubscribe

public MqttClientCreator globalSubscribe(List<org.dromara.mica.mqtt.codec.MqttTopicSubscription> topicList)

globalMessageListener

public MqttClientCreator globalMessageListener(IMqttClientGlobalMessageListener globalMessageListener)

clientSession

public MqttClientCreator clientSession(IMqttClientSession clientSession)

statEnable

public MqttClientCreator statEnable()

statEnable

public MqttClientCreator statEnable(boolean enable)

debug

public MqttClientCreator debug()

debug

public MqttClientCreator debug(boolean debug)

tioExecutor

public MqttClientCreator tioExecutor(org.tio.utils.thread.pool.SynThreadPoolExecutor tioExecutor)

groupExecutor

public MqttClientCreator groupExecutor(ExecutorService groupExecutor)

mqttExecutor

public MqttClientCreator mqttExecutor(ExecutorService mqttExecutor)

bizThreadPoolSize

public MqttClientCreator bizThreadPoolSize(int poolSize)

taskService

public MqttClientCreator taskService(org.tio.utils.timer.TimerTaskService taskService)

tioConfigCustomize

public MqttClientCreator tioConfigCustomize(Consumer<org.tio.core.TioConfig> tioConfigCustomize)

mqttJsonSerializer

public MqttClientCreator mqttJsonSerializer(MqttSerializer mqttSerializer)

newCreator

public MqttClientCreator newCreator()

connect

public MqttClient connect()

默认异步连接

Returns:

TioClient

connectSync

public MqttClient connectSync()

同步连接

Returns:

TioClient

connectTest

public org.dromara.mica.mqtt.codec.MqttConnectReasonCode connectTest()

连接测试

Returns:

MqttConnectReasonCode

connectTest

public org.dromara.mica.mqtt.codec.MqttConnectReasonCode connectTest(long timeout,
                                                                     TimeUnit timeUnit)

连接测试

Parameters:

timeout - timeout

timeUnit - TimeUnit

Returns:

MqttConnectReasonCode