Class MqttClient
java.lang.Object
org.dromara.mica.mqtt.core.client.MqttClient
mqtt 客户端
- Author:
- L.cm
-
Method Summary
Modifier and TypeMethodDescriptionstatic MqttClientCreatorcreate()boolean断开 mqtt 连接获取配置org.tio.client.TioClientConfig获取 ClientTioConfigorg.tio.client.ClientChannelContext获取 ClientChannelContextorg.tio.client.TioClient获取 TioClientboolean判断客户端跟服务端是否连接boolean判断客户端跟服务端是否断开连接boolean发布消息boolean发布消息boolean发布消息boolean发布消息booleanpublish(String topic, byte[] payload, org.dromara.mica.mqtt.codec.MqttQoS qos, boolean retain, org.dromara.mica.mqtt.codec.MqttProperties properties) 发布消息booleanpublish(String topic, byte[] payload, org.dromara.mica.mqtt.codec.MqttQoS qos, Consumer<org.dromara.mica.mqtt.codec.MqttMessageBuilders.PublishBuilder> builder) 发布消息void重连boolean重连到新的服务端节点booleanreconnect(org.tio.core.Node serverNode) 重连到新的服务端节点org.tio.utils.timer.TimerTask添加定时任务,注意:如果抛出异常,会终止后续任务,请自行处理异常org.tio.utils.timer.TimerTask添加定时任务,注意:如果抛出异常,会终止后续任务,请自行处理异常org.tio.utils.timer.TimerTaskscheduleOnce(Runnable command, long delay) 添加定时任务org.tio.utils.timer.TimerTaskscheduleOnce(Runnable command, long delay, Executor executor) 添加定时任务booleanstop()停止客户端subQos0(String topicFilter, IMqttClientMessageListener listener) 订阅subQos1(String topicFilter, IMqttClientMessageListener listener) 订阅subQos2(String topicFilter, IMqttClientMessageListener listener) 订阅subscribe(String[] topicFilters, org.dromara.mica.mqtt.codec.MqttQoS mqttQoS, IMqttClientMessageListener listener) 订阅subscribe(String[] topicFilters, org.dromara.mica.mqtt.codec.MqttQoS mqttQoS, IMqttClientMessageListener listener, org.dromara.mica.mqtt.codec.MqttProperties properties) 订阅subscribe(String topicFilter, org.dromara.mica.mqtt.codec.MqttQoS mqttQoS, IMqttClientMessageListener listener) 订阅subscribe(String topicFilter, org.dromara.mica.mqtt.codec.MqttQoS mqttQoS, IMqttClientMessageListener listener, org.dromara.mica.mqtt.codec.MqttProperties properties) 订阅subscribe(List<MqttClientSubscription> subscriptionList) 批量订阅subscribe(List<MqttClientSubscription> subscriptionList, org.dromara.mica.mqtt.codec.MqttProperties properties) 批量订阅subscribe(org.dromara.mica.mqtt.codec.MqttQoS mqttQoS, String topicFilter, IMqttClientMessageListener listener) 订阅unSubscribe(String... topicFilters) 取消订阅unSubscribe(List<String> topicFilters) 取消订阅
-
Method Details
-
create
-
subQos0
订阅- Parameters:
topicFilter- topicFilterlistener- MqttMessageListener- Returns:
- MqttClient
-
subQos1
订阅- Parameters:
topicFilter- topicFilterlistener- MqttMessageListener- Returns:
- MqttClient
-
subQos2
订阅- Parameters:
topicFilter- topicFilterlistener- MqttMessageListener- Returns:
- MqttClient
-
subscribe
public MqttClient subscribe(org.dromara.mica.mqtt.codec.MqttQoS mqttQoS, String topicFilter, IMqttClientMessageListener listener) 订阅- Parameters:
mqttQoS- MqttQoStopicFilter- topicFilterlistener- MqttMessageListener- Returns:
- MqttClient
-
subscribe
public MqttClient subscribe(String topicFilter, org.dromara.mica.mqtt.codec.MqttQoS mqttQoS, IMqttClientMessageListener listener) 订阅- Parameters:
mqttQoS- MqttQoStopicFilter- topicFilterlistener- 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- MqttQoStopicFilter- topicFilterlistener- MqttMessageListenerproperties- MqttProperties- Returns:
- MqttClient
-
subscribe
public MqttClient subscribe(String[] topicFilters, org.dromara.mica.mqtt.codec.MqttQoS mqttQoS, IMqttClientMessageListener listener) 订阅- Parameters:
topicFilters- topicFilter 数组mqttQoS- MqttQoSlistener- 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- MqttQoSlistener- MqttMessageListenerproperties- MqttProperties- Returns:
- MqttClient
-
subscribe
批量订阅- 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
取消订阅- Parameters:
topicFilters- topicFilter 集合- Returns:
- MqttClient
-
unSubscribe
取消订阅- Parameters:
topicFilters- topicFilter 集合- Returns:
- MqttClient
-
publish
发布消息- Parameters:
topic- topicpayload- 消息内容- Returns:
- 是否发送成功
-
publish
发布消息- Parameters:
topic- topicpayload- 消息内容qos- MqttQoS- Returns:
- 是否发送成功
-
publish
发布消息- Parameters:
topic- topicpayload- 消息内容retain- 是否在服务器上保留消息- Returns:
- 是否发送成功
-
publish
public boolean publish(String topic, byte[] payload, org.dromara.mica.mqtt.codec.MqttQoS qos, boolean retain) 发布消息- Parameters:
topic- topicpayload- 消息体qos- MqttQoSretain- 是否在服务器上保留消息- Returns:
- 是否发送成功
-
publish
public boolean publish(String topic, byte[] payload, org.dromara.mica.mqtt.codec.MqttQoS qos, boolean retain, org.dromara.mica.mqtt.codec.MqttProperties properties) 发布消息- Parameters:
topic- topicpayload- 消息体qos- MqttQoSretain- 是否在服务器上保留消息properties- MqttProperties- Returns:
- 是否发送成功
-
publish
public boolean publish(String topic, byte[] payload, org.dromara.mica.mqtt.codec.MqttQoS qos, Consumer<org.dromara.mica.mqtt.codec.MqttMessageBuilders.PublishBuilder> builder) 发布消息- Parameters:
topic- topicpayload- 消息体qos- MqttQoSbuilder- PublishBuilder- Returns:
- 是否发送成功
-
schedule
添加定时任务,注意:如果抛出异常,会终止后续任务,请自行处理异常- Parameters:
command- runnabledelay- delay- Returns:
- TimerTask
-
schedule
添加定时任务,注意:如果抛出异常,会终止后续任务,请自行处理异常- Parameters:
command- runnabledelay- delayexecutor- 用于自定义线程池,处理耗时业务- Returns:
- TimerTask
-
scheduleOnce
添加定时任务- Parameters:
command- runnabledelay- delay- Returns:
- TimerTask
-
scheduleOnce
添加定时任务- Parameters:
command- runnabledelay- delayexecutor- 用于自定义线程池,处理耗时业务- Returns:
- TimerTask
-
reconnect
public void reconnect()重连 -
reconnect
重连到新的服务端节点- Parameters:
ip- ipport- 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
获取配置- 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:
- 是否断连
-