点击或拖拽改变大小

MqttSyncClient 方法

MqttSyncClient 类型公开以下成员。

方法
  名称说明
公共方法代码示例ConnectClose
手动断开与远程服务器的连接,如果当前是长连接模式,那么就会切换到短连接模式
Manually disconnect from the remote server, if it is currently in long connection mode, it will switch to short connection mode
(继承自 TcpNetCommunication。)
公共方法代码示例ConnectCloseAsync
手动断开与远程服务器的连接,如果当前是长连接模式,那么就会切换到短连接模式
Manually disconnect from the remote server, if it is currently in long connection mode, it will switch to short connection mode
(继承自 TcpNetCommunication。)
公共方法代码示例ConnectServer
尝试连接远程的服务器,如果连接成功,就切换短连接模式到长连接模式,后面的每次请求都共享一个通道,使得通讯速度更快速
Try to connect to a remote server. If the connection is successful, switch the short connection mode to the long connection mode. Each subsequent request will share a channel, making the communication speed faster.
(继承自 TcpNetCommunication。)
公共方法代码示例ConnectServerAsync
尝试连接远程的服务器,如果连接成功,就切换短连接模式到长连接模式,后面的每次请求都共享一个通道,使得通讯速度更快速
Try to connect to a remote server. If the connection is successful, switch the short connection mode to the long connection mode. Each subsequent request will share a channel, making the communication speed faster.
(继承自 TcpNetCommunication。)
受保护的方法DecideWhetherQAMessage
决定当前的消息是否是用于问答机制返回的消息,默认直接返回 true, 实际的情况需要根据协议进行重写方法
To determine whether the current message is the message returned by the question answering mechanism, the default is true. In actual cases, the rewriting method needs to be performed according to the protocol
(继承自 BinaryCommunication。)
公共方法DeleteFile(String, String)
[文件引擎] 删除服务器的指定的文件名,需要指定分类信息,文件名
[File Engine] Delete the specified file name of the server, need to specify the classification information, file name
公共方法DeleteFile(String, String)
[文件引擎] 删除服务器的指定的文件名,需要指定分类信息,文件名
[File Engine] Delete the specified file name of the server, need to specify the classification information, file name
公共方法DeleteFileAsync(String, String)
[文件引擎] 删除服务器的指定的文件名,需要指定分类信息,文件名
[File Engine] Delete the specified file name of the server, need to specify the classification information, file name
公共方法DeleteFileAsync(String, String)
[文件引擎] 删除服务器的指定的文件名,需要指定分类信息,文件名
[File Engine] Delete the specified file name of the server, need to specify the classification information, file name
公共方法DeleteFolder
[文件引擎] 删除服务器上指定的分类信息及管理的所有的文件,包含所有的子分类信息,不可逆操作,谨慎操作。
[File Engine] Delete the specified classification information and all files managed on the server, including all sub-classification information, irreversible operation, and careful operation.
公共方法DeleteFolderAsync
[文件引擎] 删除服务器上指定的分类信息及管理的所有的文件,包含所有的子分类信息,不可逆操作,谨慎操作。
[File Engine] Delete the specified classification information and all files managed on the server, including all sub-classification information, irreversible operation, and careful operation.
公共方法DeleteFolderFiles
[文件引擎] 删除服务器上指定的分类的所有的文件,不可逆操作,谨慎操作。
[File Engine] Delete the specified classification information and all files managed on the server, irreversible operation, and careful operation.
公共方法DeleteFolderFilesAsync
[文件引擎] 删除服务器上指定的分类的所有的文件,不可逆操作,谨慎操作。
[File Engine] Delete the specified classification information and all files managed on the server, irreversible operation, and careful operation.
公共方法DownloadBitmap
[文件引擎] 从远程服务器下载一个文件,生成一个Bitmap图片对象,需要指定文件类别,文件名,进度报告,可用于用户头像的存储
[File Engine] Download a file from a remote server and generate a Bitmap image object. You need to specify the file category, file name, and progress report, which can be used to store the user's avatar
公共方法DownloadBitmapAsync
[文件引擎] 从远程服务器下载一个文件,生成一个Bitmap图片对象,需要指定文件类别,文件名,进度报告,可用于用户头像的存储
[File Engine] Download a file from a remote server and generate a Bitmap image object. You need to specify the file category, file name, and progress report, which can be used to store the user's avatar
公共方法DownloadFile(String, String, ActionInt64, Int64, Stream, HslCancelToken)
[文件引擎] 从远程服务器下载一个文件到流中,需要指定文件类别,文件名,进度报告,本地保存的文件名
To download a file from a remote server to the stream, you need to specify the file category, file name, progress report, and file name saved locally
公共方法DownloadFile(String, String, ActionInt64, Int64, String, HslCancelToken)
[文件引擎] 从远程服务器下载一个文件到本地,需要指定文件类别,文件名,进度报告,本地保存的文件名
[File Engine] To download a file from a remote server to the local, you need to specify the file category, file name, progress report, and file name saved locally
公共方法DownloadFileAsync(String, String, ActionInt64, Int64, Stream, HslCancelToken)
[文件引擎] 从远程服务器下载一个文件到流中,需要指定文件类别,文件名,进度报告,本地保存的文件名
To download a file from a remote server to the stream, you need to specify the file category, file name, progress report, and file name saved locally
公共方法DownloadFileAsync(String, String, ActionInt64, Int64, String, HslCancelToken)
[文件引擎] 从远程服务器下载一个文件到本地,需要指定文件类别,文件名,进度报告,本地保存的文件名
[File Engine] To download a file from a remote server to the local, you need to specify the file category, file name, progress report, and file name saved locally
公共方法DownloadPathFileNames
[文件引擎] 下载指定分类信息的所有的文件描述信息,需要指定分类信息,例如:Files/Personal/Admin
[File Engine] To download all the file description information of the specified classification information, you need to specify the classification information, for example: Files/Personal/Admin
公共方法DownloadPathFileNamesAsync
[文件引擎] 下载指定分类信息的所有的文件描述信息,需要指定分类信息,例如:Files/Personal/Admin
[File Engine] To download all the file description information of the specified classification information, you need to specify the classification information, for example: Files/Personal/Admin
公共方法DownloadPathFolders
下载指定分类信息的全部子分类信息
Download all sub-category information of the specified category information
公共方法DownloadPathFoldersAsync
下载指定分类信息的全部子分类信息
Download all sub-category information of the specified category information
公共方法Equals
Determines whether the specified object is equal to the current object.
(继承自 Object。)
受保护的方法ExtraAfterReadFromCoreServer
和服务器交互完成的时候调用的方法,可以根据读写结果进行一些额外的操作,具体的操作需要根据实际的需求来重写实现
The method called when the interaction with the server is completed can perform some additional operations based on the read and write results. The specific operations need to be rewritten according to actual needs.
(继承自 BinaryCommunication。)
受保护的方法代码示例ExtraOnDisconnect
根据实际的协议选择是否重写本方法,有些协议在断开连接之前,需要发送一些报文来关闭当前的网络通道
Select whether to rewrite this method according to the actual protocol. Some protocols need to send some packets to close the current network channel before disconnecting.
(继承自 BinaryCommunication。)
受保护的方法代码示例ExtraOnDisconnectAsync
根据实际的协议选择是否重写本方法,有些协议在断开连接之前,需要发送一些报文来关闭当前的网络通道
Select whether to rewrite this method according to the actual protocol. Some protocols need to send some packets to close the current network channel before disconnecting.
(继承自 BinaryCommunication。)
受保护的方法Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(继承自 Object。)
公共方法GetGroupFileInfo
[文件引擎] 获取服务器文件夹的指定目录的文件统计信息,包括文件数量,总大小,最后更新时间
[File Engine] Get the file statistics of the specified directory of the server folder, including the number of files, the total size, and the last update time
公共方法GetGroupFileInfoAsync
[文件引擎] 获取服务器文件夹的指定目录的文件统计信息,包括文件数量,总大小,最后更新时间
[File Engine] Get the file statistics of the specified directory of the server folder, including the number of files, the total size, and the last update time
公共方法GetHashCode
Serves as the default hash function.
(继承自 Object。)
受保护的方法GetLogTextFromBinary
获取当前的报文进行日志记录的时候,是否使用二进制的格式记录,默认返回 LogMsgFormatBinary,重写可以根据session对象分别返回不同记录模式
Whether to log the current packet in binary format, the default return is LogMsgFormatBinary. If you want to override it, different recording modes can be returned according to session
(继承自 BinaryCommunication。)
受保护的方法GetNewNetMessage
获取一个新的消息对象的方法,需要在继承类里面进行重写
The method to get a new message object needs to be overridden in the inheritance class
(继承自 BinaryCommunication。)
公共方法GetSubGroupFileInfos
[文件引擎] 获取服务器文件夹的指定目录的所有子目录的文件信息,包括每个子目录的文件数量,总大小,最后更新时间
[File Engine] Get the file information of all subdirectories of the specified directory of the server folder, including the number of files in each subdirectory, the total size, and the last update time
公共方法GetSubGroupFileInfosAsync
[文件引擎] 获取服务器文件夹的指定目录的所有子目录的文件信息,包括每个子目录的文件数量,总大小,最后更新时间
[File Engine] Get the file information of all subdirectories of the specified directory of the server folder, including the number of files in each subdirectory, the total size, and the last update time
公共方法GetType
Gets the Type of the current instance.
(继承自 Object。)
受保护的方法代码示例InitializationOnConnect
根据实际的协议选择是否重写本方法,有些协议在创建连接之后,需要进行一些初始化的信号握手,才能最终建立网络通道。
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.
(重写 BinaryCommunicationInitializationOnConnect.)
受保护的方法代码示例InitializationOnConnectAsync
根据实际的协议选择是否重写本方法,有些协议在创建连接之后,需要进行一些初始化的信号握手,才能最终建立网络通道。
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.
(重写 BinaryCommunicationInitializationOnConnectAsync.)
公共方法IpAddressPing
对当前设备的IP地址进行PING的操作,返回PING的结果,正常来说,返回Success
PING the IP address of the current device and return the PING result. Normally, it returns Success
(继承自 TcpNetCommunication。)
公共方法IsFileExists
[文件引擎] 请求服务器指定分类是否存在指定的文件名,需要指定分类信息,文件名
[File Engine] Request the server to specify whether the specified file name exists in the specified category, need to specify the category information, file name
公共方法IsFileExistsAsync
[文件引擎] 请求服务器指定分类是否存在指定的文件名,需要指定分类信息,文件名
[File Engine] Request the server to specify whether the specified file name exists in the specified category, need to specify the category information, file name
受保护的方法LogRevcMessage(Byte)
使用日志记录一个接收的报文信息
` Logs are used to record information about a received packet
(继承自 BinaryCommunication。)
受保护的方法LogRevcMessage(Byte, PipeSession)
使用日志记录一个接收的报文信息
` Logs are used to record information about a received packet
(继承自 BinaryCommunication。)
受保护的方法LogSendMessage(Byte)
使用日志记录一个发送的报文信息
Logs are used to record information about a send packet
(继承自 BinaryCommunication。)
受保护的方法LogSendMessage(Byte, PipeSession)
使用日志记录一个发送的报文信息
Logs are used to record information about a send packet
(继承自 BinaryCommunication。)
受保护的方法MemberwiseClone
Creates a shallow copy of the current Object.
(继承自 Object。)
公共方法PackCommandWithHeader
对当前的命令进行打包处理,通常是携带命令头内容,标记当前的命令的长度信息,需要进行重写,否则默认不打包
The current command is packaged, usually carrying the content of the command header, marking the length of the current command, and it needs to be rewritten, otherwise it is not packaged by default
(继承自 BinaryCommunication。)
公共方法Read
从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
公共方法ReadAsync
从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
公共方法代码示例ReadFromCoreServer(Byte)
将二进制的数据发送到管道中去,然后从管道里接收二进制的数据回来,并返回是否成功的结果对象。
Send binary data to the pipeline, and then receive binary data back from the pipeline, and return whether the success of the result object
(继承自 BinaryCommunication。)
公共方法ReadFromCoreServer(IEnumerableByte) (继承自 BinaryCommunication。)
公共方法代码示例ReadFromCoreServer(Byte, Boolean, Boolean)
将二进制的数据发送到管道中去,然后从管道里接收二进制的数据回来,并返回是否成功的结果对象。
Send binary data to the pipeline, and then receive binary data back from the pipeline, and return whether the success of the result object
(继承自 BinaryCommunication。)
公共方法ReadFromCoreServer(CommunicationPipe, Byte, Boolean, Boolean)
使用指定的管道来进行数据通信,发送原始数据到管道,然后从管道接收相关的数据返回,本方法无锁
(重写 BinaryCommunicationReadFromCoreServer(CommunicationPipe, Byte, Boolean, Boolean).)
公共方法代码示例ReadFromCoreServerAsync(Byte)
将二进制的数据发送到管道中去,然后从管道里接收二进制的数据回来,并返回是否成功的结果对象。
Send binary data to the pipeline, and then receive binary data back from the pipeline, and return whether the success of the result object
(继承自 BinaryCommunication。)
公共方法ReadFromCoreServerAsync(IEnumerableByte) (继承自 BinaryCommunication。)
公共方法代码示例ReadFromCoreServerAsync(Byte, Boolean, Boolean)
将二进制的数据发送到管道中去,然后从管道里接收二进制的数据回来,并返回是否成功的结果对象。
Send binary data to the pipeline, and then receive binary data back from the pipeline, and return whether the success of the result object
(继承自 BinaryCommunication。)
公共方法ReadFromCoreServerAsync(CommunicationPipe, Byte, Boolean, Boolean)
使用指定的管道来进行数据通信,发送原始数据到管道,然后从管道接收相关的数据返回,本方法无锁
(重写 BinaryCommunicationReadFromCoreServerAsync(CommunicationPipe, Byte, Boolean, Boolean).)
公共方法ReadRetainTopics
读取服务器的已经驻留的所有消息的主题列表
Read the topic list of all messages that have resided on the server
公共方法ReadRetainTopicsAsync
读取服务器的已经驻留的所有消息的主题列表
Read the topic list of all messages that have resided on the server
公共方法ReadRpcT(String, Object)
读取MQTT服务器注册的RPC接口,忽略返回的Topic数据,直接将结果转换为泛型对象,如果JSON转换失败,将返回错误,参数传递主题和数据负载, 数据负载示例:new { address = "", length = 0 } 本质是一个匿名对象。
Read the RPC interface registered by the MQTT server, ignore the returned Topic data, and directly convert the result into a generic object. If the JSON conversion fails, an error will be returned. The parameter passes the topic and the data payload. The data payload example: new { address = "", length = 0 } is essentially an anonymous object.
公共方法ReadRpcT(String, String)
读取MQTT服务器注册的RPC接口,忽略返回的Topic数据,直接将结果转换为泛型对象,如果JSON转换失败,将返回错误,参数传递主题和数据负载, 数据负载示例:"{\"address\": \"100\",\"length\": 10}" 本质是一个字符串。
Read the RPC interface registered by the MQTT server, ignore the returned Topic data, and directly convert the result into a generic object. If the JSON conversion fails, an error will be returned. The parameter passes the topic and the data payload. The data payload example: "{\"address\ ": \"100\",\"length\": 10}" is essentially a string.
公共方法ReadRpcApiLog
读取服务器的指定的API接口的每天的调用次数,如果API接口不存在,或是还没有调用数据,则返回失败。
Read the number of calls per day of the designated API interface of the server. If the API interface does not exist or the data has not been called yet, it returns a failure.
公共方法ReadRpcApiLogAsync
读取服务器的指定的API接口的每天的调用次数,如果API接口不存在,或是还没有调用数据,则返回失败。
Read the number of calls per day of the designated API interface of the server. If the API interface does not exist or the data has not been called yet, it returns a failure.
公共方法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.
公共方法ReadRpcApisAsync
读取服务器的已经注册的API信息列表,将返回API的主题路径,注释信息,示例的传入的数据信息。
Read the registered API information list of the server, and return the API subject path, annotation information, and sample incoming data information.
公共方法ReadRpcAsyncT(String, Object)
读取MQTT服务器注册的RPC接口,忽略返回的Topic数据,直接将结果转换为泛型对象,如果JSON转换失败,将返回错误,参数传递主题和数据负载, 数据负载示例:new { address = "", length = 0 } 本质是一个匿名对象。
Read the RPC interface registered by the MQTT server, ignore the returned Topic data, and directly convert the result into a generic object. If the JSON conversion fails, an error will be returned. The parameter passes the topic and the data payload. The data payload example: new { address = "", length = 0 } is essentially an anonymous object.
公共方法ReadRpcAsyncT(String, String)
读取MQTT服务器注册的RPC接口,忽略返回的Topic数据,直接将结果转换为泛型对象,如果JSON转换失败,将返回错误,参数传递主题和数据负载, 数据负载示例:"{\"address\": \"100\",\"length\": 10}" 本质是一个字符串。
Read the RPC interface registered by the MQTT server, ignore the returned Topic data, and directly convert the result into a generic object. If the JSON conversion fails, an error will be returned. The parameter passes the topic and the data payload. The data payload example: "{\"address\ ": \"100\",\"length\": 10}" is essentially a string.
公共方法ReadSessions
读取服务器里当前的会话信息
公共方法ReadString
从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
公共方法ReadStringAsync
从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
公共方法ReadTopicPayload
读取服务器的已经驻留的指定主题的消息内容
Read the topic list of all messages that have resided on the server
公共方法ReadTopicPayloadAsync
读取服务器的已经驻留的指定主题的消息内容
Read the topic list of all messages that have resided on the server
公共方法RenameFolder
[文件引擎] 重命名服务器上指定的路径信息,需要指定新的路径名称,当新的路径已经存在的时候,命名失败。
[File Engine] Renames the specified path information on the server, you need to specify a new path name, and when the new path already exists, the naming fails.
公共方法RenameFolderAsync
[文件引擎] 重命名服务器上指定的路径信息,需要指定新的路径名称,当新的路径已经存在的时候,命名失败。
[File Engine] Renames the specified path information on the server, you need to specify a new path name, and when the new path already exists, the naming fails.
公共方法SetDtuPipe
将当前的通信对象设置DTU模式,允许传入现成的管道,并返回初始化结果,如果该设备重写了握手报文,就是返回握手结果
Set the current communication object to DTU mode, allow the existing pipe to be passed in, and return the initialization result, if the device rewrites the handshake packet, the handshake result is returned
(继承自 BinaryCommunication。)
公共方法SetDtuPipeAsync
将当前的通信对象设置DTU模式,允许传入现成的管道,并返回初始化结果,如果该设备重写了握手报文,就是返回握手结果
Set the current communication object to DTU mode, allow the existing pipe to be passed in, and return the initialization result, if the device rewrites the handshake packet, the handshake result is returned
(继承自 BinaryCommunication。)
公共方法ToString
Returns a string that represents the current object.
(重写 TcpNetCommunicationToString.)
公共方法UnpackResponseContent
根据对方返回的报文命令,对命令进行基本的拆包,例如各种Modbus协议拆包为统一的核心报文,还支持对报文的验证
According to the message command returned by the other party, the command is basically unpacked, for example, various Modbus protocols are unpacked into a unified core message, and the verification of the message is also supported
(继承自 BinaryCommunication。)
公共方法UploadFile(String, String, String, ActionInt64, Int64, HslCancelToken)
[文件引擎] 上传文件给服务器,需要指定上传文件的路径信息(服务器保存的名称就是文件名),以及上传到服务器的分类信息,支持进度汇报功能。
[File Engine] To upload a file to the server, you need to specify the path information of the uploaded file (the name saved by the server is the file name), as well as the classification information uploaded to the server, to support the progress report function.
公共方法UploadFile(Bitmap, String, String, String, ActionInt64, Int64, HslCancelToken)
[文件引擎] 上传一个Bitmap图片对象到服务器指定的分类下面,需要指定分类信息,服务器保存的文件名,描述信息,支持进度报告
[File Engine] Upload a Bitmap image object to the category specified by the server, you need to specify the category information, the file name saved by the server, description information, and support for progress reports
公共方法UploadFile(Stream, String, String, String, ActionInt64, Int64, HslCancelToken)
[文件引擎] 上传流给服务器,需要指定流,服务器保存的名字,以及上传到服务器的分类信息,支持进度汇报功能。
[File Engine] To upload a stream to the server, you need to specify the stream, the name saved by the server, and the classification information uploaded to the server to support the progress reporting function.
公共方法UploadFile(String, String, String, String, ActionInt64, Int64, HslCancelToken)
[文件引擎] 上传文件给服务器,需要指定上传文件的路径信息,服务器保存的名字,以及上传到服务器的分类信息,支持进度汇报功能。
[File Engine] To upload a file to the server, you need to specify the path information of the uploaded file, the name saved by the server, and the classification information uploaded to the server to support the progress report function.
公共方法UploadFileAsync(String, String, String, ActionInt64, Int64, HslCancelToken)
[文件引擎] 上传文件给服务器,需要指定上传文件的路径信息(服务器保存的名称就是文件名),以及上传到服务器的分类信息,支持进度汇报功能。
[File Engine] To upload a file to the server, you need to specify the path information of the uploaded file (the name saved by the server is the file name), as well as the classification information uploaded to the server, to support the progress report function.
公共方法UploadFileAsync(Bitmap, String, String, String, ActionInt64, Int64, HslCancelToken)
[文件引擎] 上传一个Bitmap图片对象到服务器指定的分类下面,需要指定分类信息,服务器保存的文件名,描述信息,支持进度报告
[File Engine] Upload a Bitmap image object to the category specified by the server, you need to specify the category information, the file name saved by the server, description information, and support for progress reports
公共方法UploadFileAsync(Stream, String, String, String, ActionInt64, Int64, HslCancelToken)
[文件引擎] 上传流给服务器,需要指定流,服务器保存的名字,以及上传到服务器的分类信息,支持进度汇报功能。
[File Engine] To upload a stream to the server, you need to specify the stream, the name saved by the server, and the classification information uploaded to the server to support the progress reporting function.
公共方法UploadFileAsync(String, String, String, String, ActionInt64, Int64, HslCancelToken)
[文件引擎] 上传文件给服务器,需要指定上传文件的路径信息,服务器保存的名字,以及上传到服务器的分类信息,支持进度汇报功能。
[File Engine] To upload a file to the server, you need to specify the path information of the uploaded file, the name saved by the server, and the classification information uploaded to the server to support the progress report function.
Top
扩展方法
  名称说明
公共扩展器方法ToJsonString
获取当前对象的JSON格式表示的字符串。
Gets the string represented by the JSON format of the current object.
(由 HslExtension 定义。)
Top
参见