org.nutz.boot.starter.mqtt.client

类 MqttClientStarter

java.lang.Object

org.nutz.boot.starter.mqtt.client.MqttClientStarter

@IocBean
public class MqttClientStarter
extends Object

封装Eclipse Paho项目的Java客户端, 它实现了Mqtt 3.1.1/3.1协议, 兼容实现了该协议的服务器端,包括paho和emqtt

作者:

wendal(wendal1985@gmail.com)

字段概要

字段

限定符和类型	字段和说明
protected org.nutz.ioc.impl.PropertiesProxy	conf
protected org.nutz.ioc.Ioc	ioc
protected static String	PRE 这是客户端,暂定前缀
static String	PROP_CLIENT_ID
static String	PROP_CONNECT_ON_START
static String	PROP_OPTIONS_AUTOMATIC_RECONNECT
static String	PROP_OPTIONS_CLEAN_SESSION
static String	PROP_OPTIONS_CONNECTION_TIMEOUT
static String	PROP_OPTIONS_KEEP_ALIVE_INTERVAL
static String	PROP_OPTIONS_PASSWORD
static String	PROP_OPTIONS_URLS
static String	PROP_OPTIONS_USERNAME
static String	PROP_OPTIONS_WILL_PAYLOAD
static String	PROP_OPTIONS_WILL_QOS
static String	PROP_OPTIONS_WILL_RETAINED
static String	PROP_OPTIONS_WILL_TOPIC
static String	PROP_PERSISTENCE_PATH
static String	PROP_PERSISTENCE_TYPE
static String	PROP_TIME_TO_WAIT
static String	PROP_URL

构造器概要

构造器

构造器和说明
MqttClientStarter()

方法概要

限定符和类型	方法和说明
org.eclipse.paho.client.mqttv3.MqttAsyncClient	createMqttAsyncClient(org.eclipse.paho.client.mqttv3.MqttConnectOptions mqttConnectOptions, org.eclipse.paho.client.mqttv3.MqttClientPersistence mqttClientPersistence) 异步客户端
org.eclipse.paho.client.mqttv3.MqttClient	createMqttClient(org.eclipse.paho.client.mqttv3.MqttConnectOptions mqttConnectOptions, org.eclipse.paho.client.mqttv3.MqttClientPersistence mqttClientPersistence) 同步阻塞客户端, 然后它不支持通过MqttAsyncClient来构建,真蛋疼
org.eclipse.paho.client.mqttv3.MqttClientPersistence	createMqttClientPersistence() mqtt持久化策略, 默认行为是存到内存
org.eclipse.paho.client.mqttv3.MqttConnectOptions	createMqttConnectOptions() MqttClient的主要配置来至于MqttConnectOptions

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

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

字段详细资料

PRE

protected static final String PRE

这是客户端,暂定前缀

另请参阅:

常量字段值

PROP_URL

@PropDoc(value="\u670d\u52a1\u5668\u5730\u5740",
         defaultValue="tcp://127.0.0.1:1883")
public static final String PROP_URL

另请参阅:

常量字段值

PROP_CLIENT_ID

@PropDoc(value="\u5ba2\u6237\u7aefid",
         defaultValue="MqttClient.generateClientId()")
public static final String PROP_CLIENT_ID

另请参阅:

常量字段值

PROP_TIME_TO_WAIT

@PropDoc(value="\u540c\u6b65\u5ba2\u6237\u7aef\u7684\u6700\u5927\u7b49\u5f85\u65f6\u95f4",
         defaultValue="-1")
public static final String PROP_TIME_TO_WAIT

另请参阅:

常量字段值

PROP_CONNECT_ON_START

@PropDoc(value="\u542f\u52a8\u65f6\u81ea\u52a8\u8fde\u63a5",
         defaultValue="true")
public static final String PROP_CONNECT_ON_START

另请参阅:

常量字段值

PROP_OPTIONS_AUTOMATIC_RECONNECT

@PropDoc(value="\u81ea\u52a8\u91cd\u8fde",
         defaultValue="true")
public static final String PROP_OPTIONS_AUTOMATIC_RECONNECT

另请参阅:

常量字段值

PROP_OPTIONS_KEEP_ALIVE_INTERVAL

@PropDoc(value="\u5fc3\u8df3\u9891\u7387,\u5355\u4f4d\u79d2",
         defaultValue="60")
public static final String PROP_OPTIONS_KEEP_ALIVE_INTERVAL

另请参阅:

常量字段值

PROP_OPTIONS_WILL_TOPIC

@PropDoc(value="Will\u6d88\u606f\u7684topic")
public static final String PROP_OPTIONS_WILL_TOPIC

另请参阅:

常量字段值

PROP_OPTIONS_WILL_PAYLOAD

@PropDoc(value="Will\u6d88\u606f\u7684\u5185\u5bb9")
public static final String PROP_OPTIONS_WILL_PAYLOAD

另请参阅:

常量字段值

PROP_OPTIONS_WILL_QOS

@PropDoc(value="Will\u6d88\u606f\u7684QOS",
         defaultValue="2")
public static final String PROP_OPTIONS_WILL_QOS

另请参阅:

常量字段值

PROP_OPTIONS_WILL_RETAINED

@PropDoc(value="Will\u6d88\u606f\u662f\u5426retained",
         defaultValue="true")
public static final String PROP_OPTIONS_WILL_RETAINED

另请参阅:

常量字段值

PROP_OPTIONS_USERNAME

@PropDoc(value="\u7528\u6237\u540d")
public static final String PROP_OPTIONS_USERNAME

另请参阅:

常量字段值

PROP_OPTIONS_PASSWORD

@PropDoc(value="\u5bc6\u7801")
public static final String PROP_OPTIONS_PASSWORD

另请参阅:

常量字段值

PROP_OPTIONS_CLEAN_SESSION

@PropDoc(value="\u6e05\u9664session",
         defaultValue="true")
public static final String PROP_OPTIONS_CLEAN_SESSION

另请参阅:

常量字段值

PROP_OPTIONS_CONNECTION_TIMEOUT

@PropDoc(value="\u8fde\u63a5\u8d85\u65f6\u8bbe\u7f6e",
         defaultValue="30")
public static final String PROP_OPTIONS_CONNECTION_TIMEOUT

另请参阅:

常量字段值

PROP_OPTIONS_URLS

@PropDoc(value="\u591a\u670d\u52a1\u5668\u5730\u5740\u8bbe\u7f6e")
public static final String PROP_OPTIONS_URLS

另请参阅:

常量字段值

PROP_PERSISTENCE_TYPE

@PropDoc(value="\u6301\u4e45\u5316\u65b9\u5f0f",
         defaultValue="memory",
         possible={"memory","file"})
public static final String PROP_PERSISTENCE_TYPE

另请参阅:

常量字段值

PROP_PERSISTENCE_PATH

@PropDoc(value="\u6587\u4ef6\u6301\u4e45\u5316\u65f6\u7684\u76ee\u5f55",
         defaultValue="\u7528\u6237\u4e3b\u76ee\u5f55")
public static final String PROP_PERSISTENCE_PATH

另请参阅:

常量字段值

conf

@Inject
protected org.nutz.ioc.impl.PropertiesProxy conf

ioc

@Inject(value="refer:$ioc")
protected org.nutz.ioc.Ioc ioc

构造器详细资料

MqttClientStarter

public MqttClientStarter()

方法详细资料

createMqttConnectOptions

@IocBean(name="mqttConnectOptions")
public org.eclipse.paho.client.mqttv3.MqttConnectOptions createMqttConnectOptions()

MqttClient的主要配置来至于MqttConnectOptions

createMqttClientPersistence

@IocBean(name="mqttClientPersistence")
public org.eclipse.paho.client.mqttv3.MqttClientPersistence createMqttClientPersistence()

mqtt持久化策略, 默认行为是存到内存

createMqttClient

@IocBean(name="mqttClient",
         depose="close")
public org.eclipse.paho.client.mqttv3.MqttClient createMqttClient(@Inject
                                                                                                                         org.eclipse.paho.client.mqttv3.MqttConnectOptions mqttConnectOptions,
                                                                                                                         @Inject
                                                                                                                         org.eclipse.paho.client.mqttv3.MqttClientPersistence mqttClientPersistence)
                                                                                                                  throws org.eclipse.paho.client.mqttv3.MqttException

同步阻塞客户端, 然后它不支持通过MqttAsyncClient来构建,真蛋疼

抛出:

org.eclipse.paho.client.mqttv3.MqttException

createMqttAsyncClient

@IocBean(name="mqttAsyncClient",
         depose="close")
public org.eclipse.paho.client.mqttv3.MqttAsyncClient createMqttAsyncClient(@Inject
                                                                                                                                        org.eclipse.paho.client.mqttv3.MqttConnectOptions mqttConnectOptions,
                                                                                                                                        @Inject
                                                                                                                                        org.eclipse.paho.client.mqttv3.MqttClientPersistence mqttClientPersistence)
                                                                                                                                 throws org.eclipse.paho.client.mqttv3.MqttException

异步客户端

抛出:

org.eclipse.paho.client.mqttv3.MqttException