net.dreamlu.iot.mqtt.spring.client

Class MqttClientTemplate

java.lang.Object

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

All Implemented Interfaces:

org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.core.Ordered

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

mqtt client 模板

Author:

wsq（冷月宫主）

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CLIENT_TEMPLATE_BEAN

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
MqttClientTemplate()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	destroy()
boolean	disconnect() 断开 mqtt 连接
MqttClientCreator	getClientCreator() 获取配置
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, 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, ByteBuffer payload) 发布消息
boolean	publish(String topic, ByteBuffer payload, boolean retain) 发布消息
boolean	publish(String topic, ByteBuffer payload, net.dreamlu.iot.mqtt.codec.MqttQoS qos) 发布消息
boolean	publish(String topic, ByteBuffer payload, net.dreamlu.iot.mqtt.codec.MqttQoS qos, boolean retain) 发布消息
void	reconnect() 重连
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(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	unSubscribe(List<String> topicFilters) 取消订阅
MqttClient	unSubscribe(String... topicFilter) 取消订阅

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CLIENT_TEMPLATE_BEAN

public static final String DEFAULT_CLIENT_TEMPLATE_BEAN

See Also:

Constant Field Values

Constructor Detail

MqttClientTemplate

public MqttClientTemplate()

Method Detail

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(net.dreamlu.iot.mqtt.codec.MqttQoS mqttQoS,
                            String topicFilter,
                            IMqttClientMessageListener listener)

订阅

Parameters:

mqttQoS - MqttQoS

topicFilter - topicFilter

listener - MqttMessageListener

Returns:

MqttClient

subscribe

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

订阅

Parameters:

topicFilters - topicFilter 数组

mqttQoS - MqttQoS

listener - MqttMessageListener

Returns:

MqttClient

subscribe

public MqttClient subscribe(List<MqttClientSubscription> subscriptionList)

批量订阅

Parameters:

subscriptionList - 订阅集合

Returns:

MqttClient

unSubscribe

public MqttClient unSubscribe(String... topicFilter)

取消订阅

Parameters:

topicFilter - topicFilter

Returns:

MqttClient

unSubscribe

public MqttClient unSubscribe(List<String> topicFilters)

取消订阅

Parameters:

topicFilters - topicFilter 集合

Returns:

MqttClient

publish

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

发布消息

Parameters:

topic - topic

payload - 消息内容

Returns:

是否发送成功

publish

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

发布消息

Parameters:

topic - topic

payload - 消息内容

qos - MqttQoS

Returns:

是否发送成功

publish

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

发布消息

Parameters:

topic - topic

payload - 消息体

qos - MqttQoS

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

Returns:

是否发送成功

publish

public boolean publish(String topic,
                       ByteBuffer payload)

发布消息

Parameters:

topic - topic

payload - 消息体

Returns:

是否发送成功

publish

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

发布消息

Parameters:

topic - topic

payload - 消息体

qos - MqttQoS

Returns:

是否发送成功

publish

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

发布消息

Parameters:

topic - topic

payload - 消息体

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

Returns:

是否发送成功

publish

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

发布消息

Parameters:

topic - topic

payload - 消息体

qos - MqttQoS

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

Returns:

是否发送成功

reconnect

public void reconnect()

重连

disconnect

public boolean disconnect()

断开 mqtt 连接

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()

获取 MqttClient

Returns:

MqttClient

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

destroy

public void destroy()

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered