net.dreamlu.iot.mqtt.spring.client

类 MqttClientTemplate

java.lang.Object

net.dreamlu.iot.mqtt.spring.client.MqttClientTemplate

所有已实现的接口:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.SmartInitializingSingleton, org.springframework.context.ApplicationContextAware, org.springframework.core.Ordered

public class MqttClientTemplate
extends Object
implements org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.SmartInitializingSingleton, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean, org.springframework.core.Ordered

mqtt client 模板

作者:

wsq（冷月宫主）

字段概要

字段

限定符和类型	字段和说明
static String	DEFAULT_CLIENT_TEMPLATE_BEAN

从接口继承的字段 org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

构造器概要

构造器

构造器和说明
MqttClientTemplate(MqttClientCreator clientCreator)

方法概要

限定符和类型	方法和说明
void	afterPropertiesSet()
void	afterSingletonsInstantiated()
void	destroy()
boolean	disconnect() 断开 mqtt 连接
org.tio.client.TioClientConfig	getClientTioConfig() 获取 ClientTioConfig
org.tio.client.ClientChannelContext	getContext() 获取 ClientChannelContext
MqttClient	getMqttClient() 获取 MqttClient
int	getOrder()
org.tio.client.TioClient	getTioClient() 获取 TioClient
boolean	isConnected() 判断客户端跟服务端是否连接
boolean	isDisconnected() 判断客户端跟服务端是否断开连接
boolean	publish(String topic, byte[] payload) 发布消息
boolean	publish(String topic, byte[] payload, boolean retain) 发布消息
boolean	publish(String topic, byte[] payload, net.dreamlu.iot.mqtt.codec.MqttQoS qos) 发布消息
boolean	publish(String topic, byte[] payload, net.dreamlu.iot.mqtt.codec.MqttQoS qos, boolean retain) 发布消息
boolean	publish(String topic, byte[] payload, net.dreamlu.iot.mqtt.codec.MqttQoS qos, boolean retain, net.dreamlu.iot.mqtt.codec.MqttProperties properties) 发布消息
boolean	publish(String topic, byte[] payload, net.dreamlu.iot.mqtt.codec.MqttQoS qos, Consumer<net.dreamlu.iot.mqtt.codec.MqttMessageBuilders.PublishBuilder> builder) 发布消息
void	reconnect() 重连
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) 添加定时任务
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
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, net.dreamlu.iot.mqtt.codec.MqttProperties properties) 批量订阅
MqttClient	subscribe(net.dreamlu.iot.mqtt.codec.MqttQoS mqttQoS, String topicFilter, IMqttClientMessageListener listener) 订阅
MqttClient	subscribe(String[] topicFilters, net.dreamlu.iot.mqtt.codec.MqttQoS mqttQoS, IMqttClientMessageListener listener) 订阅
MqttClient	subscribe(String[] topicFilters, net.dreamlu.iot.mqtt.codec.MqttQoS mqttQoS, IMqttClientMessageListener listener, net.dreamlu.iot.mqtt.codec.MqttProperties properties) 订阅
MqttClient	subscribe(String topicFilter, net.dreamlu.iot.mqtt.codec.MqttQoS mqttQoS, IMqttClientMessageListener listener) 订阅
MqttClient	subscribe(String topicFilter, net.dreamlu.iot.mqtt.codec.MqttQoS mqttQoS, IMqttClientMessageListener listener, net.dreamlu.iot.mqtt.codec.MqttProperties properties) 订阅
MqttClient	unSubscribe(List<String> topicFilters) 取消订阅
MqttClient	unSubscribe(String... topicFilters) 取消订阅

从类继承的方法 java.lang.Object

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

字段详细资料

DEFAULT_CLIENT_TEMPLATE_BEAN

public static final String DEFAULT_CLIENT_TEMPLATE_BEAN

另请参阅:

常量字段值

构造器详细资料

MqttClientTemplate

public MqttClientTemplate(MqttClientCreator clientCreator)

方法详细资料

subQos0

public MqttClient subQos0(String topicFilter,
                          IMqttClientMessageListener listener)

订阅

参数:

topicFilter - topicFilter

listener - MqttMessageListener

返回:

MqttClient

subQos1

public MqttClient subQos1(String topicFilter,
                          IMqttClientMessageListener listener)

订阅

参数:

topicFilter - topicFilter

listener - MqttMessageListener

返回:

MqttClient

subQos2

public MqttClient subQos2(String topicFilter,
                          IMqttClientMessageListener listener)

订阅

参数:

topicFilter - topicFilter

listener - MqttMessageListener

返回:

MqttClient

subscribe

public MqttClient subscribe(net.dreamlu.iot.mqtt.codec.MqttQoS mqttQoS,
                            String topicFilter,
                            IMqttClientMessageListener listener)

订阅

参数:

mqttQoS - MqttQoS

topicFilter - topicFilter

listener - MqttMessageListener

返回:

MqttClient

subscribe

public MqttClient subscribe(String topicFilter,
                            net.dreamlu.iot.mqtt.codec.MqttQoS mqttQoS,
                            IMqttClientMessageListener listener)

订阅

参数:

mqttQoS - MqttQoS

topicFilter - topicFilter

listener - MqttMessageListener

返回:

MqttClient

subscribe

public MqttClient subscribe(String topicFilter,
                            net.dreamlu.iot.mqtt.codec.MqttQoS mqttQoS,
                            IMqttClientMessageListener listener,
                            net.dreamlu.iot.mqtt.codec.MqttProperties properties)

订阅

参数:

mqttQoS - MqttQoS

topicFilter - topicFilter

listener - MqttMessageListener

properties - MqttProperties

返回:

MqttClient

subscribe

public MqttClient subscribe(String[] topicFilters,
                            net.dreamlu.iot.mqtt.codec.MqttQoS mqttQoS,
                            IMqttClientMessageListener listener)

订阅

参数:

topicFilters - topicFilter 数组

mqttQoS - MqttQoS

listener - MqttMessageListener

返回:

MqttClient

subscribe

public MqttClient subscribe(String[] topicFilters,
                            net.dreamlu.iot.mqtt.codec.MqttQoS mqttQoS,
                            IMqttClientMessageListener listener,
                            net.dreamlu.iot.mqtt.codec.MqttProperties properties)

订阅

参数:

topicFilters - topicFilter 数组

mqttQoS - MqttQoS

listener - MqttMessageListener

properties - MqttProperties

返回:

MqttClient

subscribe

public MqttClient subscribe(List<MqttClientSubscription> subscriptionList)

批量订阅

参数:

subscriptionList - 订阅集合

返回:

MqttClient

subscribe

public MqttClient subscribe(List<MqttClientSubscription> subscriptionList,
                            net.dreamlu.iot.mqtt.codec.MqttProperties properties)

批量订阅

参数:

subscriptionList - 订阅集合

properties - MqttProperties

返回:

MqttClient

unSubscribe

public MqttClient unSubscribe(String... topicFilters)

取消订阅

参数:

topicFilters - topicFilter 集合

返回:

MqttClient

unSubscribe

public MqttClient unSubscribe(List<String> topicFilters)

取消订阅

参数:

topicFilters - topicFilter 集合

返回:

MqttClient

publish

public boolean publish(String topic,
                       byte[] payload)

发布消息

参数:

topic - topic

payload - 消息内容

返回:

是否发送成功

publish

public boolean publish(String topic,
                       byte[] payload,
                       net.dreamlu.iot.mqtt.codec.MqttQoS qos)

发布消息

参数:

topic - topic

payload - 消息内容

qos - MqttQoS

返回:

是否发送成功

publish

public boolean publish(String topic,
                       byte[] payload,
                       boolean retain)

发布消息

参数:

topic - topic

payload - 消息内容

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

返回:

是否发送成功

publish

public boolean publish(String topic,
                       byte[] payload,
                       net.dreamlu.iot.mqtt.codec.MqttQoS qos,
                       boolean retain)

发布消息

参数:

topic - topic

payload - 消息体

qos - MqttQoS

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

返回:

是否发送成功

publish

public boolean publish(String topic,
                       byte[] payload,
                       net.dreamlu.iot.mqtt.codec.MqttQoS qos,
                       boolean retain,
                       net.dreamlu.iot.mqtt.codec.MqttProperties properties)

发布消息

参数:

topic - topic

payload - 消息体

qos - MqttQoS

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

properties - MqttProperties

返回:

是否发送成功

publish

public boolean publish(String topic,
                       byte[] payload,
                       net.dreamlu.iot.mqtt.codec.MqttQoS qos,
                       Consumer<net.dreamlu.iot.mqtt.codec.MqttMessageBuilders.PublishBuilder> builder)

发布消息

参数:

topic - topic

payload - 消息体

qos - MqttQoS

builder - PublishBuilder

返回:

是否发送成功

schedule

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

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

参数:

command - runnable

delay - delay

返回:

TimerTask

schedule

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

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

参数:

command - runnable

delay - delay

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

返回:

TimerTask

scheduleOnce

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

添加定时任务

参数:

command - runnable

delay - delay

返回:

TimerTask

scheduleOnce

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

添加定时任务

参数:

command - runnable

delay - delay

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

返回:

TimerTask

reconnect

public void reconnect()

重连

reconnect

public boolean reconnect(String ip,
                         int port)

重连到新的服务端节点

参数:

ip - ip

port - port

返回:

是否成功

disconnect

public boolean disconnect()

断开 mqtt 连接

返回:

是否成功

getTioClient

public org.tio.client.TioClient getTioClient()

获取 TioClient

返回:

TioClient

getClientTioConfig

public org.tio.client.TioClientConfig getClientTioConfig()

获取 ClientTioConfig

返回:

ClientTioConfig

getContext

public org.tio.client.ClientChannelContext getContext()

获取 ClientChannelContext

返回:

ClientChannelContext

isConnected

public boolean isConnected()

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

返回:

是否已经连接成功

isDisconnected

public boolean isDisconnected()

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

返回:

是否断连

getMqttClient

public MqttClient getMqttClient()

获取 MqttClient

返回:

MqttClient

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

指定者:

setApplicationContext 在接口中 org.springframework.context.ApplicationContextAware

抛出:

org.springframework.beans.BeansException

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

指定者:

afterPropertiesSet 在接口中 org.springframework.beans.factory.InitializingBean

抛出:

Exception

afterSingletonsInstantiated

public void afterSingletonsInstantiated()

指定者:

afterSingletonsInstantiated 在接口中 org.springframework.beans.factory.SmartInitializingSingleton

destroy

public void destroy()

指定者:

destroy 在接口中 org.springframework.beans.factory.DisposableBean

getOrder

public int getOrder()

指定者:

getOrder 在接口中 org.springframework.core.Ordered