org.dromara.mica.mqtt.core.client

Class MqttClient

java.lang.Object

org.dromara.mica.mqtt.core.client.MqttClient

All Implemented Interfaces:

IMqttClient

public final class MqttClient
extends Object
implements IMqttClient

mqtt 客户端

Author:

L.cm, ChangJin Wei (魏昌进)

Method Summary

Modifier and Type	Method and Description
static MqttClientCreator	create()
boolean	disconnect() 断开 mqtt 连接
MqttClientCreator	getClientCreator() 获取配置
org.tio.client.TioClientConfig	getClientTioConfig() 获取 ClientTioConfig
org.tio.client.ClientChannelContext	getContext() 获取 ClientChannelContext
MqttClient	getMqttClient() 获取 mqtt 客户端
org.tio.client.TioClient	getTioClient() 获取 TioClient
boolean	isConnected() 判断客户端跟服务端是否连接
boolean	isDisconnected() 判断客户端跟服务端是否断开连接
boolean	publish(String topic, Object payload) 发布消息
boolean	publish(String topic, Object payload, boolean retain) 发布消息
boolean	publish(String topic, Object payload, org.dromara.mica.mqtt.codec.MqttQoS qos) 发布消息
boolean	publish(String topic, Object payload, org.dromara.mica.mqtt.codec.MqttQoS qos, boolean retain) 发布消息
boolean	publish(String topic, Object payload, org.dromara.mica.mqtt.codec.MqttQoS qos, boolean retain, org.dromara.mica.mqtt.codec.MqttProperties properties) 发布消息
boolean	publish(String topic, Object payload, org.dromara.mica.mqtt.codec.MqttQoS qos, Consumer<org.dromara.mica.mqtt.codec.MqttMessageBuilders.PublishBuilder> builder) 发布消息
void	reconnect() 重连
boolean	reconnect(org.tio.core.Node serverNode) 重连到新的服务端节点
boolean	reconnect(String ip, int port) 重连到新的服务端节点
org.tio.utils.timer.TimerTask	schedule(Runnable command, long delay) 添加定时任务，注意：如果抛出异常，会终止后续任务，请自行处理异常
org.tio.utils.timer.TimerTask	schedule(Runnable command, long delay, Executor executor) 添加定时任务，注意：如果抛出异常，会终止后续任务，请自行处理异常
org.tio.utils.timer.TimerTask	scheduleOnce(Runnable command, long delay) 添加定时任务
org.tio.utils.timer.TimerTask	scheduleOnce(Runnable command, long delay, Executor executor) 添加定时任务
boolean	stop() 停止客户端
MqttClient	subQos0(String topicFilter, IMqttClientMessageListener listener) 订阅
MqttClient	subQos1(String topicFilter, IMqttClientMessageListener listener) 订阅
MqttClient	subQos2(String topicFilter, IMqttClientMessageListener listener) 订阅
MqttClient	subscribe(List<MqttClientSubscription> subscriptionList) 批量订阅
MqttClient	subscribe(List<MqttClientSubscription> subscriptionList, org.dromara.mica.mqtt.codec.MqttProperties properties) 批量订阅
MqttClient	subscribe(org.dromara.mica.mqtt.codec.MqttQoS mqttQoS, String topicFilter, IMqttClientMessageListener listener) 订阅
MqttClient	subscribe(String[] topicFilters, org.dromara.mica.mqtt.codec.MqttQoS mqttQoS, IMqttClientMessageListener listener) 订阅
MqttClient	subscribe(String[] topicFilters, org.dromara.mica.mqtt.codec.MqttQoS mqttQoS, IMqttClientMessageListener listener, org.dromara.mica.mqtt.codec.MqttProperties properties) 订阅
MqttClient	subscribe(String topicFilter, org.dromara.mica.mqtt.codec.MqttQoS mqttQoS, IMqttClientMessageListener listener) 订阅
MqttClient	subscribe(String topicFilter, org.dromara.mica.mqtt.codec.MqttQoS mqttQoS, IMqttClientMessageListener listener, org.dromara.mica.mqtt.codec.MqttProperties properties) 订阅
MqttClient	unSubscribe(List<String> topicFilters) 取消订阅
MqttClient	unSubscribe(String... topicFilters) 取消订阅

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dromara.mica.mqtt.core.client.IMqttClient

getInterface

Method Detail

create

public static MqttClientCreator create()

subQos0

public MqttClient subQos0(String topicFilter,
                          IMqttClientMessageListener listener)

订阅

Parameters:

topicFilter - topicFilter

listener - MqttMessageListener

Returns:

MqttClient

subQos1

public MqttClient subQos1(String topicFilter,
                          IMqttClientMessageListener listener)

订阅

Parameters:

topicFilter - topicFilter

listener - MqttMessageListener

Returns:

MqttClient

subQos2

public MqttClient subQos2(String topicFilter,
                          IMqttClientMessageListener listener)

订阅

Parameters:

topicFilter - topicFilter

listener - MqttMessageListener

Returns:

MqttClient

subscribe

public MqttClient subscribe(org.dromara.mica.mqtt.codec.MqttQoS mqttQoS,
                            String topicFilter,
                            IMqttClientMessageListener listener)

订阅

Parameters:

mqttQoS - MqttQoS

topicFilter - topicFilter

listener - MqttMessageListener

Returns:

MqttClient

subscribe

public MqttClient subscribe(String topicFilter,
                            org.dromara.mica.mqtt.codec.MqttQoS mqttQoS,
                            IMqttClientMessageListener listener)

订阅

Parameters:

mqttQoS - MqttQoS

topicFilter - topicFilter

listener - MqttMessageListener

Returns:

MqttClient

subscribe

public MqttClient subscribe(String topicFilter,
                            org.dromara.mica.mqtt.codec.MqttQoS mqttQoS,
                            IMqttClientMessageListener listener,
                            org.dromara.mica.mqtt.codec.MqttProperties properties)

订阅

Parameters:

mqttQoS - MqttQoS

topicFilter - topicFilter

listener - MqttMessageListener

properties - MqttProperties

Returns:

MqttClient

subscribe

public MqttClient subscribe(String[] topicFilters,
                            org.dromara.mica.mqtt.codec.MqttQoS mqttQoS,
                            IMqttClientMessageListener listener)

订阅

Parameters:

topicFilters - topicFilter 数组

mqttQoS - MqttQoS

listener - MqttMessageListener

Returns:

MqttClient

subscribe

public MqttClient subscribe(String[] topicFilters,
                            org.dromara.mica.mqtt.codec.MqttQoS mqttQoS,
                            IMqttClientMessageListener listener,
                            org.dromara.mica.mqtt.codec.MqttProperties properties)

订阅

Parameters:

topicFilters - topicFilter 数组

mqttQoS - MqttQoS

listener - MqttMessageListener

properties - MqttProperties

Returns:

MqttClient

subscribe

public MqttClient subscribe(List<MqttClientSubscription> subscriptionList)

批量订阅

Parameters:

subscriptionList - 订阅集合

Returns:

MqttClient

subscribe

public MqttClient subscribe(List<MqttClientSubscription> subscriptionList,
                            org.dromara.mica.mqtt.codec.MqttProperties properties)

批量订阅

Parameters:

subscriptionList - 订阅集合

properties - MqttProperties

Returns:

MqttClient

unSubscribe

public MqttClient unSubscribe(String... topicFilters)

取消订阅

Parameters:

topicFilters - topicFilter 集合

Returns:

MqttClient

unSubscribe

public MqttClient unSubscribe(List<String> topicFilters)

取消订阅

Parameters:

topicFilters - topicFilter 集合

Returns:

MqttClient

publish

public boolean publish(String topic,
                       Object payload)

发布消息

Parameters:

topic - topic

payload - 消息内容

Returns:

是否发送成功

publish

public boolean publish(String topic,
                       Object payload,
                       org.dromara.mica.mqtt.codec.MqttQoS qos)

发布消息

Parameters:

topic - topic

payload - 消息内容

qos - MqttQoS

Returns:

是否发送成功

publish

public boolean publish(String topic,
                       Object payload,
                       boolean retain)

发布消息

Parameters:

topic - topic

payload - 消息内容

retain - 是否在服务器上保留消息

Returns:

是否发送成功

publish

public boolean publish(String topic,
                       Object payload,
                       org.dromara.mica.mqtt.codec.MqttQoS qos,
                       boolean retain)

发布消息

Parameters:

topic - topic

payload - 消息体

qos - MqttQoS

retain - 是否在服务器上保留消息

Returns:

是否发送成功

publish

public boolean publish(String topic,
                       Object payload,
                       org.dromara.mica.mqtt.codec.MqttQoS qos,
                       boolean retain,
                       org.dromara.mica.mqtt.codec.MqttProperties properties)

发布消息

Parameters:

topic - topic

payload - 消息体

qos - MqttQoS

retain - 是否在服务器上保留消息

properties - MqttProperties

Returns:

是否发送成功

publish

public boolean publish(String topic,
                       Object payload,
                       org.dromara.mica.mqtt.codec.MqttQoS qos,
                       Consumer<org.dromara.mica.mqtt.codec.MqttMessageBuilders.PublishBuilder> builder)

发布消息

Parameters:

topic - topic

payload - 消息体

qos - MqttQoS

builder - PublishBuilder

Returns:

是否发送成功

schedule

public org.tio.utils.timer.TimerTask schedule(Runnable command,
                                              long delay)

添加定时任务，注意：如果抛出异常，会终止后续任务，请自行处理异常

Parameters:

command - runnable

delay - delay

Returns:

TimerTask

schedule

public org.tio.utils.timer.TimerTask schedule(Runnable command,
                                              long delay,
                                              Executor executor)

添加定时任务，注意：如果抛出异常，会终止后续任务，请自行处理异常

Parameters:

command - runnable

delay - delay

executor - 用于自定义线程池，处理耗时业务

Returns:

TimerTask

scheduleOnce

public org.tio.utils.timer.TimerTask scheduleOnce(Runnable command,
                                                  long delay)

添加定时任务

Parameters:

command - runnable

delay - delay

Returns:

TimerTask

scheduleOnce

public org.tio.utils.timer.TimerTask scheduleOnce(Runnable command,
                                                  long delay,
                                                  Executor executor)

添加定时任务

Parameters:

command - runnable

delay - delay

executor - 用于自定义线程池，处理耗时业务

Returns:

TimerTask

reconnect

public void reconnect()

重连

reconnect

public boolean reconnect(String ip,
                         int port)

重连到新的服务端节点

Parameters:

ip - ip

port - port

Returns:

是否成功

reconnect

public boolean reconnect(org.tio.core.Node serverNode)

重连到新的服务端节点

Parameters:

serverNode - Node

Returns:

是否成功

disconnect

public boolean disconnect()

断开 mqtt 连接

Returns:

是否成功

stop

public boolean stop()

停止客户端

Returns:

是否停止成功

getTioClient

public org.tio.client.TioClient getTioClient()

获取 TioClient

Returns:

TioClient

getClientCreator

public MqttClientCreator getClientCreator()

获取配置

Returns:

MqttClientCreator

getClientTioConfig

public org.tio.client.TioClientConfig getClientTioConfig()

获取 ClientTioConfig

Returns:

ClientTioConfig

getContext

public org.tio.client.ClientChannelContext getContext()

获取 ClientChannelContext

Returns:

ClientChannelContext

isConnected

public boolean isConnected()

判断客户端跟服务端是否连接

Returns:

是否已经连接成功

isDisconnected

public boolean isDisconnected()

判断客户端跟服务端是否断开连接

Returns:

是否断连

getMqttClient

public MqttClient getMqttClient()

Description copied from interface: IMqttClient

获取 mqtt 客户端

Specified by:

getMqttClient in interface IMqttClient

Returns:

MqttClient