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

java.lang.Object
- HslCommunication.Core.Net.NetworkBase.NetworkBase
- - HslCommunication.Core.Net.NetworkBase.NetworkDoubleBase
  - - HslCommunication.MQTT.MqttSyncClient

```
public class MqttSyncClient
extends NetworkDoubleBase
```
基于MQTT协议的RPC调用客户端，支持加密操作。可以访问远程服务器的注册的RPC接口
RPC call client based on MQTT protocol, support encryption operation. The registered RPC interface that can access the remote server

字段概要
- 从类继承的字段 HslCommunication.Core.Net.NetworkBase.NetworkDoubleBase
  AlienSession, isPersistentConn, IsSocketError, isUseAccountCertificate, LogMsgFormatBinary, simpleHybirdLock
- 从类继承的字段 HslCommunication.Core.Net.NetworkBase.NetworkBase
  CoreSocket, fileCacheSize, LogNet, Token

构造器概要

构造器
构造器和说明
`MqttSyncClient(MqttConnectionOptions options)` 实例化一个MQTT的同步客户端 Instantiate an MQTT synchronization client
`MqttSyncClient(String ipAddress, int port)` 通过指定的ip地址及端口来实例化一个同步的MQTT客户端 Instantiate a synchronized MQTT client with the specified IP address and port

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`MqttConnectionOptions`	`getConnectionOptions()`
`String`	`getStringEncoding()` 获取使用字符串访问的时候，使用的编码信息，默认为UT8编码 Get the encoding information used when accessing with a string, the default is UT8 encoding
`protected OperateResult`	`InitializationOnConnect(Socket socket)` 根据实际的协议选择是否重写本方法，有些协议在创建连接之后，需要进行一些初始化的信号握手，才能最终建立网络通道。
`OperateResultExTwo<String,byte[]>`	`Read(String topic, byte[] payload)` 从MQTT服务器同步读取数据，将payload发送到服务器，然后从服务器返回相关的数据 Synchronously read data from the MQTT server, send the payload to the server, and then return relevant data from the server
`OperateResultExTwo<String,byte[]>`	`Read(String topic, byte[] payload, ActionOperateExTwo<Long,Long> sendProgress, ActionOperateExTwo<String,String> handleProgress, ActionOperateExTwo<Long,Long> receiveProgress)` 从MQTT服务器同步读取数据，将payload发送到服务器，然后从服务器返回相关的数据，支持数据发送进度报告，服务器执行进度报告，接收数据进度报告操作 Synchronously read data from the MQTT server, send the payload to the server, and then return relevant data from the server, support data transmission progress report, the server executes the progress report, and receives the data progress report
`OperateResultExOne<byte[]>`	`ReadFromCoreServer(Socket socket, byte[] send)`
`OperateResultExOne<String[]>`	`ReadRetainTopics()` 读取服务器的已经驻留的所有消息的主题列表 Read the topic list of all messages that have resided on the server
`OperateResultExOne<String>`	`ReadRpcApis()` 读取服务器的已经注册的API信息列表，将返回API的主题路径，注释信息，示例的传入的数据信息。
`OperateResultExTwo<String,String>`	`ReadString(String topic, String payload, ActionOperateExTwo<Long,Long> sendProgress, ActionOperateExTwo<String,String> handleProgress, ActionOperateExTwo<Long,Long> receiveProgress)` 从MQTT服务器同步读取数据，将指定编码的字符串payload发送到服务器，然后从服务器返回相关的数据，并转换为指定编码的字符串，支持数据发送进度报告，服务器执行进度报告，接收数据进度报告操作 Synchronously read data from the MQTT server, send the specified encoded string payload to the server, and then return the data from the server, and convert it to the specified encoded string, support data transmission progress report, the server executes the progress report, and receives the data progress report
`void`	`setConnectionOptions(MqttConnectionOptions connectionOptions)`
`void`	`setStringEncoding(String stringEncoding)`
`String`	`toString()` 返回当前对象表示的字符串 Returns the string represented by the current object

从类继承的方法 HslCommunication.Core.Net.NetworkBase.NetworkBase
CheckRemoteToken, CloseSocket, CreateSocketAndConnect, CreateSocketAndConnect, CreateSocketAndConnect, ReadStream, Receive, Receive, Receive, ReceiveAndCheckBytes, ReceiveByMessage, ReceiveByMessage, ReceiveBytesContentFromSocket, ReceiveBytesContentFromSocket, ReceiveCommandLineFromSocket, ReceiveCommandLineFromSocket, ReceiveCommandLineFromSocket, ReceiveCommandLineFromSocket, ReceiveFrameWebSocketPayload, ReceiveHslMessage, ReceiveMqttMessage, ReceiveRedisCommand, ReceiveRedisCommandString, ReceiveStringArrayContentFromSocket, ReceiveStringArrayContentFromSocket, ReceiveStringContentFromSocket, ReceiveStringContentFromSocket, ReceiveWebSocketPayload, Send, Send, SendAccountAndCheckReceive, SendBaseAndCheckReceive, SendBytesAndCheckReceive, SendStreamToSocket, SendStringAndCheckReceive, SendStringAndCheckReceive, ThreadPoolCheckTimeOut, WriteStream, WriteStreamFromSocket

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

- 构造器详细资料
  - MqttSyncClient
```
public MqttSyncClient(MqttConnectionOptions options)
```
    实例化一个MQTT的同步客户端
    Instantiate an MQTT synchronization client
    
    参数:
    
    options - 连接的配置信息
  - MqttSyncClient
```
public MqttSyncClient(String ipAddress,
                      int port)
```
    通过指定的ip地址及端口来实例化一个同步的MQTT客户端
    Instantiate a synchronized MQTT client with the specified IP address and port
    
    参数:
    
    ipAddress - IP地址信息
    
    port - 端口号信息
- 方法详细资料
  - InitializationOnConnect
```
protected OperateResult InitializationOnConnect(Socket socket)
```
    从类复制的说明: NetworkDoubleBase
    
    根据实际的协议选择是否重写本方法，有些协议在创建连接之后，需要进行一些初始化的信号握手，才能最终建立网络通道。
    Whether to rewrite this method is based on the actual protocol. Some protocols require some initial signal handshake to establish a network channel after the connection is created.
    
    覆盖:
    
    InitializationOnConnect 在类中 NetworkDoubleBase
    
    参数:
    
    socket - 网络套接字
    
    返回:
    
    结果类对象
  - ReadFromCoreServer
```
public OperateResultExOne<byte[]> ReadFromCoreServer(Socket socket,
                                                     byte[] send)
```
  - Read
```
public OperateResultExTwo<String,byte[]> Read(String topic,
                                              byte[] payload,
                                              ActionOperateExTwo<Long,Long> sendProgress,
                                              ActionOperateExTwo<String,String> handleProgress,
                                              ActionOperateExTwo<Long,Long> receiveProgress)
```
    从MQTT服务器同步读取数据，将payload发送到服务器，然后从服务器返回相关的数据，支持数据发送进度报告，服务器执行进度报告，接收数据进度报告操作
    Synchronously read data from the MQTT server, send the payload to the server, and then return relevant data from the server, support data transmission progress report, the server executes the progress report, and receives the data progress report
    
    参数:
    
    topic - 主题信息
    
    payload - 负载数据
    
    sendProgress - 发送数据给服务器时的进度报告，第一个参数为已发送数据，第二个参数为总发送数据
    
    handleProgress - 服务器处理数据的进度报告，第一个参数Topic自定义，通常用来传送操作百分比，第二个参数自定义，通常用来表示服务器消息
    
    receiveProgress - 从服务器接收数据的进度报告，第一个参数为已接收数据，第二个参数为总接收数据
    
    返回:
    
    服务器返回的数据信息
  - Read
```
public OperateResultExTwo<String,byte[]> Read(String topic,
                                              byte[] payload)
```
    从MQTT服务器同步读取数据，将payload发送到服务器，然后从服务器返回相关的数据
    Synchronously read data from the MQTT server, send the payload to the server, and then return relevant data from the server
    
    参数:
    
    topic - 主题信息
    
    payload - 负载数据
    
    返回:
    
    服务器返回的数据信息
  - ReadString
```
public OperateResultExTwo<String,String> ReadString(String topic,
                                                    String payload,
                                                    ActionOperateExTwo<Long,Long> sendProgress,
                                                    ActionOperateExTwo<String,String> handleProgress,
                                                    ActionOperateExTwo<Long,Long> receiveProgress)
```
    从MQTT服务器同步读取数据，将指定编码的字符串payload发送到服务器，然后从服务器返回相关的数据，并转换为指定编码的字符串，支持数据发送进度报告，服务器执行进度报告，接收数据进度报告操作
    Synchronously read data from the MQTT server, send the specified encoded string payload to the server, and then return the data from the server, and convert it to the specified encoded string, support data transmission progress report, the server executes the progress report, and receives the data progress report
    
    参数:
    
    topic - 主题信息
    
    payload - 负载数据
    
    sendProgress - 发送数据给服务器时的进度报告，第一个参数为已发送数据，第二个参数为总发送数据
    
    handleProgress - 服务器处理数据的进度报告，第一个参数Topic自定义，通常用来传送操作百分比，第二个参数自定义，通常用来表示服务器消息
    
    receiveProgress - 从服务器接收数据的进度报告，第一个参数为已接收数据，第二个参数为总接收数据
    
    返回:
    
    服务器返回的数据信息
  - ReadRpcApis
```
public OperateResultExOne<String> ReadRpcApis()
```
    读取服务器的已经注册的API信息列表，将返回API的主题路径，注释信息，示例的传入的数据信息。
    Read the registered API information list of the server, and return the API subject path, annotation information, and sample incoming data information.
    
    注意，返回的数据是JSON格式的
    
    返回:
    
    包含是否成功的api信息的列表
  - ReadRetainTopics
```
public OperateResultExOne<String[]> ReadRetainTopics()
```
    读取服务器的已经驻留的所有消息的主题列表
    Read the topic list of all messages that have resided on the server
    
    返回:
    
    消息列表对象
  - getConnectionOptions
```
public MqttConnectionOptions getConnectionOptions()
```
  - setConnectionOptions
```
public void setConnectionOptions(MqttConnectionOptions connectionOptions)
```
  - getStringEncoding
```
public String getStringEncoding()
```
    获取使用字符串访问的时候，使用的编码信息，默认为UT8编码 Get the encoding information used when accessing with a string, the default is UT8 encoding
    
    返回:
    
    字符串的编码信息
  - setStringEncoding
```
public void setStringEncoding(String stringEncoding)
```
  - toString
```
public String toString()
```
    从类复制的说明: NetworkBase
    
    返回当前对象表示的字符串
    Returns the string represented by the current object
    
    覆盖:
    
    toString 在类中 NetworkDoubleBase
    
    返回:
    
    字符串信息

类 MqttSyncClient

字段概要

从类继承的字段 HslCommunication.Core.Net.NetworkBase.NetworkDoubleBase

从类继承的字段 HslCommunication.Core.Net.NetworkBase.NetworkBase

构造器概要

方法概要

从类继承的方法 HslCommunication.Core.Net.NetworkBase.NetworkDoubleBase

从类继承的方法 HslCommunication.Core.Net.NetworkBase.NetworkBase

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

构造器详细资料

MqttSyncClient

MqttSyncClient

方法详细资料

InitializationOnConnect

ReadFromCoreServer

Read

Read

ReadString

ReadRpcApis

ReadRetainTopics

getConnectionOptions

setConnectionOptions

getStringEncoding

setStringEncoding

toString