MqttHelper (com.github.dathlin:HslCommunication 3.4.0 API)

java.lang.Object
- HslCommunication.MQTT.MqttHelper

```
public class MqttHelper
extends Object
```
Mqtt协议的辅助类，提供了一些协议相关的基础方法，方便客户端和服务器端一起调用。
The auxiliary class of the Mqtt protocol provides some protocol-related basic methods for the client and server to call together.

构造器概要

构造器
构造器和说明

MqttHelper()

构造器
构造器和说明
`MqttHelper()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static OperateResultExOne<byte[]>`	`BuildConnectMqttCommand(MqttConnectionOptions connectionOptions, String protocol)` 创建MQTT连接服务器的报文信息 Create MQTT connection server message information
`static OperateResultExOne<byte[]>`	`BuildConnectMqttCommand(MqttConnectionOptions connectionOptions, String protocol, RSACryptoServiceProvider rsa)` 创建MQTT连接服务器的报文信息 Create MQTT connection server message information
`static byte[]`	`BuildIntBytes(int data)` 从MQTT的缓存信息里，提取长度信息 Extract length information from MQTT cache information
`static OperateResultExOne<byte[]>`	`BuildMqttCommand(byte head, byte[] variableHeader, byte[] payLoad, AesCryptography aesCryptography)` 将一个数据打包成一个mqtt协议的内容 Pack a piece of data into a mqtt protocol
`static OperateResultExOne<byte[]>`	`BuildMqttCommand(byte control, byte flags, byte[] variableHeader, byte[] payLoad)` 将一个数据打包成一个mqtt协议的内容 Pack a piece of data into a mqtt protocol
`static OperateResultExOne<byte[]>`	`BuildMqttCommand(byte control, byte flags, byte[] variableHeader, byte[] payLoad, AesCryptography aesCryptography)` 将一个数据打包成一个mqtt协议的内容 Pack a piece of data into a mqtt protocol
`static OperateResultExOne<byte[]>`	`BuildPublishMqttCommand(MqttPublishMessage message)` 创建Mqtt发送消息的命令 Create Mqtt command to send messages
`static OperateResultExOne<byte[]>`	`BuildPublishMqttCommand(String topic, byte[] payload)` 创建Mqtt发送消息的命令 Create Mqtt command to send messages
`static byte[]`	`BuildSegCommandByString(String message)` 将字符串打包成utf8编码，并且带有2个字节的表示长度的信息 Pack the string into utf8 encoding, and with 2 bytes of length information
`static OperateResultExOne<byte[]>`	`BuildSubscribeMqttCommand(MqttSubscribeMessage message)` 创建MQTT订阅消息的命名 Command to create Mqtt subscription message
`static OperateResultExOne<byte[]>`	`BuildUnSubscribeMqttCommand(MqttSubscribeMessage message)` 创建Mqtt取消订阅消息的命令 Create Mqtt unsubscribe message command
`static OperateResultExOne<byte[]>`	`CalculateLengthToMqttLength(int length)` 根据数据的总长度，计算出剩余的数据长度信息 According to the total length of the data, calculate the remaining data length information
`static OperateResult`	`CheckConnectBack(byte code, byte[] data)` 根据服务器返回的信息判断当前的连接是否是可用的 According to the information returned by the server to determine whether the current connection is available
`static OperateResultExTwo<Integer,Integer>`	`ExtraIntFromBytes(byte[] buffer, int index)` 从MQTT的缓存信息里，提取长度信息 Extract length information from MQTT cache information
`static OperateResultExTwo<String,byte[]>`	`ExtraMqttReceiveData(byte mqttCode, byte[] data)` 解析从MQTT接受的客户端信息，解析成实际的Topic数据及Payload数据 Parse the client information received from MQTT and parse it into actual Topic data and Payload data
`static OperateResultExTwo<String,byte[]>`	`ExtraMqttReceiveData(byte mqttCode, byte[] data, AesCryptography aesCryptography)` 解析从MQTT接受的客户端信息，解析成实际的Topic数据及Payload数据 Parse the client information received from MQTT and parse it into actual Topic data and Payload data
`static OperateResultExTwo<String,Integer>`	`ExtraMsgFromBytes(byte[] buffer, int index)` 从MQTT的缓存信息里，提取文本信息 Extract text information from MQTT cache information
`static String`	`GetMqttCodeText(int status)` 获取当前的错误的描述信息 Get a description of the current error

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - MqttHelper
```
public MqttHelper()
```
- 方法详细资料
  - CalculateLengthToMqttLength
```
public static OperateResultExOne<byte[]> CalculateLengthToMqttLength(int length)
```
    根据数据的总长度，计算出剩余的数据长度信息
    According to the total length of the data, calculate the remaining data length information
    
    参数:
    
    length - 数据的总长度
    
    返回:
    
    计算结果
  - BuildMqttCommand
```
public static OperateResultExOne<byte[]> BuildMqttCommand(byte control,
                                                          byte flags,
                                                          byte[] variableHeader,
                                                          byte[] payLoad)
```
    将一个数据打包成一个mqtt协议的内容
    Pack a piece of data into a mqtt protocol
    
    参数:
    
    control - 控制码
    
    flags - 标记
    
    variableHeader - 可变头的字节内容
    
    payLoad - 负载数据
    
    返回:
    
    带有是否成功的结果对象
  - BuildMqttCommand
```
public static OperateResultExOne<byte[]> BuildMqttCommand(byte control,
                                                          byte flags,
                                                          byte[] variableHeader,
                                                          byte[] payLoad,
                                                          AesCryptography aesCryptography)
```
    将一个数据打包成一个mqtt协议的内容
    Pack a piece of data into a mqtt protocol
    
    参数:
    
    control - 控制码
    
    flags - 标记
    
    variableHeader - 可变头的字节内容
    
    payLoad - 负载数据
    
    aesCryptography - AES的加密解密对象
    
    返回:
    
    带有是否成功的结果对象
  - BuildMqttCommand
```
public static OperateResultExOne<byte[]> BuildMqttCommand(byte head,
                                                          byte[] variableHeader,
                                                          byte[] payLoad,
                                                          AesCryptography aesCryptography)
```
    将一个数据打包成一个mqtt协议的内容
    Pack a piece of data into a mqtt protocol
    
    参数:
    
    head - 控制码
    
    variableHeader - 可变头的字节内容
    
    payLoad - 负载数据
    
    aesCryptography - AES加密对象
    
    返回:
    
    带有是否成功的结果对象
  - BuildSegCommandByString
```
public static byte[] BuildSegCommandByString(String message)
```
    将字符串打包成utf8编码，并且带有2个字节的表示长度的信息
    Pack the string into utf8 encoding, and with 2 bytes of length information
    
    参数:
    
    message - 文本消息
    
    返回:
    
    打包之后的信息
  - ExtraMsgFromBytes
```
public static OperateResultExTwo<String,Integer> ExtraMsgFromBytes(byte[] buffer,
                                                                   int index)
```
    从MQTT的缓存信息里，提取文本信息
    Extract text information from MQTT cache information
    
    参数:
    
    buffer - Mqtt的报文
    
    index - 索引
    
    返回:
    
    值
  - ExtraIntFromBytes
```
public static OperateResultExTwo<Integer,Integer> ExtraIntFromBytes(byte[] buffer,
                                                                    int index)
```
    从MQTT的缓存信息里，提取长度信息
    Extract length information from MQTT cache information
    
    参数:
    
    buffer - Mqtt的报文
    
    index - 索引
    
    返回:
    
    值
  - BuildIntBytes
```
public static byte[] BuildIntBytes(int data)
```
    从MQTT的缓存信息里，提取长度信息
    Extract length information from MQTT cache information
    
    参数:
    
    data - 数据信息
    
    返回:
    
    值
  - BuildConnectMqttCommand
```
public static OperateResultExOne<byte[]> BuildConnectMqttCommand(MqttConnectionOptions connectionOptions,
                                                                 String protocol)
```
    创建MQTT连接服务器的报文信息
    Create MQTT connection server message information
    
    参数:
    
    connectionOptions - 连接配置
    
    protocol - 协议的内容
    
    返回:
    
    返回是否成功的信息
  - BuildConnectMqttCommand
```
public static OperateResultExOne<byte[]> BuildConnectMqttCommand(MqttConnectionOptions connectionOptions,
                                                                 String protocol,
                                                                 RSACryptoServiceProvider rsa)
```
    创建MQTT连接服务器的报文信息
    Create MQTT connection server message information
    
    参数:
    
    connectionOptions - 连接配置
    
    protocol - 协议的内容
    
    rsa - rsa加密对象
    
    返回:
    
    返回是否成功的信息
  - CheckConnectBack
```
public static OperateResult CheckConnectBack(byte code,
                                             byte[] data)
```
    根据服务器返回的信息判断当前的连接是否是可用的
    According to the information returned by the server to determine whether the current connection is available
    
    参数:
    
    code - 功能码
    
    data - 数据内容
    
    返回:
    
    是否可用的连接
  - GetMqttCodeText
```
public static String GetMqttCodeText(int status)
```
    获取当前的错误的描述信息
    Get a description of the current error
    
    参数:
    
    status - 状态信息
    
    返回:
    
    描述信息
  - BuildPublishMqttCommand
```
public static OperateResultExOne<byte[]> BuildPublishMqttCommand(MqttPublishMessage message)
```
    创建Mqtt发送消息的命令
    Create Mqtt command to send messages
    
    参数:
    
    message - 封装后的消息内容
    
    返回:
    
    结果内容
  - BuildPublishMqttCommand
```
public static OperateResultExOne<byte[]> BuildPublishMqttCommand(String topic,
                                                                 byte[] payload)
```
    创建Mqtt发送消息的命令
    Create Mqtt command to send messages
    
    参数:
    
    topic - 主题消息内容
    
    payload - 数据负载
    
    返回:
    
    结果内容
  - BuildSubscribeMqttCommand
```
public static OperateResultExOne<byte[]> BuildSubscribeMqttCommand(MqttSubscribeMessage message)
```
    创建MQTT订阅消息的命名
    Command to create Mqtt subscription message
    
    参数:
    
    message - 订阅的主题
    
    返回:
    
    结果内容
  - BuildUnSubscribeMqttCommand
```
public static OperateResultExOne<byte[]> BuildUnSubscribeMqttCommand(MqttSubscribeMessage message)
```
    创建Mqtt取消订阅消息的命令
    Create Mqtt unsubscribe message command
    
    参数:
    
    message - 订阅的主题
    
    返回:
    
    结果内容
  - ExtraMqttReceiveData
```
public static OperateResultExTwo<String,byte[]> ExtraMqttReceiveData(byte mqttCode,
                                                                     byte[] data)
```
    解析从MQTT接受的客户端信息，解析成实际的Topic数据及Payload数据
    Parse the client information received from MQTT and parse it into actual Topic data and Payload data
    
    参数:
    
    mqttCode - MQTT的命令码
    
    data - 接收的MQTT原始的消息内容
    
    返回:
    
    解析的数据结果信息
  - ExtraMqttReceiveData
```
public static OperateResultExTwo<String,byte[]> ExtraMqttReceiveData(byte mqttCode,
                                                                     byte[] data,
                                                                     AesCryptography aesCryptography)
```
    解析从MQTT接受的客户端信息，解析成实际的Topic数据及Payload数据
    Parse the client information received from MQTT and parse it into actual Topic data and Payload data
    
    参数:
    
    mqttCode - MQTT的命令码
    
    data - 接收的MQTT原始的消息内容
    
    aesCryptography - AES加密解密的对象
    
    返回:
    
    解析的数据结果信息

类 MqttHelper

构造器概要

方法概要

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

构造器详细资料

MqttHelper

方法详细资料

CalculateLengthToMqttLength

BuildMqttCommand

BuildMqttCommand

BuildMqttCommand

BuildSegCommandByString

ExtraMsgFromBytes

ExtraIntFromBytes

BuildIntBytes

BuildConnectMqttCommand

BuildConnectMqttCommand

CheckConnectBack

GetMqttCodeText

BuildPublishMqttCommand

BuildPublishMqttCommand

BuildSubscribeMqttCommand

BuildUnSubscribeMqttCommand

ExtraMqttReceiveData

ExtraMqttReceiveData