点击或拖拽改变大小

MqttServer 方法

MqttServer 类型公开以下成员。

方法
  名称说明
公共方法CloseFileServer
关闭文件服务功能
受保护的方法DeleteFileByName
删除一个指定的文件,如果文件不存在,直接返回 True,如果文件存在则直接删除,删除成功返回 True,如果发生了异常,返回False
Delete a specified file, if the file does not exist, return True directly, if the file exists, delete it directly, if the deletion is successful, return True, if an exception occurs, return False
公共方法DeleteRetainTopic
删除服务器里的指定主题的驻留消息。
Delete the resident message of the specified topic in the server.
公共方法Dispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
受保护的方法Dispose(Boolean)
释放当前的对象
公共方法Equals
Determines whether the specified object is equal to the current object.
(继承自 Object。)
受保护的方法ExtraOnClose
关闭的时候额外执行的功能代码
(重写 CommunicationTcpServerExtraOnClose.)
受保护的方法ExtraOnStart
服务器启动的时候额外执行的功能代码
(重写 CommunicationTcpServerExtraOnStart.)
受保护的方法Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(继承自 Object。)
公共方法GetAllMqttRpcApiInfo
获取当前所有注册的RPC接口信息,将返回一个数据列表。
Get all currently registered RPC interface information, and a data list will be returned.
公共方法GetAllRetainTopics
获取所有的驻留的消息的主题,如果消息发布的时候没有使用Retain属性,就无法通过本方法查到
Get the subject of all resident messages. If the Retain attribute is not used when the message is published, it cannot be found by this method
公共方法GetGroupFromFilePath
根据路径信息获取到文件列表管理容器,如果返回空,表示不存在。
The file list management container is obtained according to the path information. If the return is empty, it means that it does not exist.
公共方法GetHashCode
Serves as the default hash function.
(继承自 Object。)
公共方法GetMonitorItemsSnapShoot
获取当前实时的文件上传下载的监控信息,操作的客户端信息,文件分类,文件名,上传或下载的速度等
Obtain current real-time file upload and download monitoring information, operating client information, file classification, file name, upload or download speed, etc.
公共方法GetMqttSessionsByTopic
获取订阅了某个主题的所有的会话列表信息
Get all the conversation list information subscribed to a topic
公共方法GetTrustedClients
获取受信任的客户端列表
Get a list of trusted clients
(继承自 CommunicationTcpServer。)
公共方法GetType
Gets the Type of the current instance.
(继承自 Object。)
公共方法GroupFileContainerCount
获取当前的针对文件夹的文件管理容器的数量
Get the current number of file management containers for the folder
受保护的方法LogDebugMsg
记录当前的日志信息
(继承自 CommunicationTcpServer。)
受保护的方法MemberwiseClone
Creates a shallow copy of the current Object.
(继承自 Object。)
公共方法PublishAllClientTopicPayload
向所有的客户端强制发送主题及负载数据,默认消息不驻留
Send subject and payload data to all clients compulsively, and the default message does not retain
公共方法PublishTopicPayload(String, Byte, Boolean)
从服务器向订阅了指定的主题的客户端发送消息,默认消息不驻留
Sends a message from the server to a client that subscribes to the specified topic; the default message does not retain
公共方法PublishTopicPayload(MqttSession, String, Byte)
向指定的客户端发送主题及负载数据
Sends the topic and payload data to the specified client
公共方法PublishTopicPayload(String, Byte, Boolean, FuncMqttSession, Boolean)
使用指定的规则向客户端发布主题及负载数据,可以根据会话的登录用户名,客户端ID信息进行筛选,例如只发布用户名admin的账户:( session ) => session.UserName == "admin"
Use the specified rules to publish topic and load data to the client, which can be filtered according to the session login user name and client ID information. For example, only the account with the user name admin is published: ( session ) => session.UserName == "admin"
公共方法PublishTopicPayload(String, String, Byte, Boolean)
向指定的客户端ID强制发送消息,默认消息不驻留
Forces a message to the specified client ID, and the default message does not retain
公共方法RegisterMqttRpcApi(Object)
注册一个RPC的服务接口,可以指定当前的控制器名称,以及提供RPC服务的原始对象
Register an RPC service interface, you can specify the current controller name, and the original object that provides the RPC service
公共方法RegisterMqttRpcApi(String, Object)
注册一个RPC的服务接口,可以指定当前的控制器名称,以及提供RPC服务的原始对象
Register an RPC service interface, you can specify the current controller name, and the original object that provides the RPC service
公共方法RegisterMqttRpcApi(String, Object, HslMqttPermissionAttribute)
注册一个RPC的服务接口,可以指定当前的控制器名称,以及提供RPC服务的原始对象,指定统一的权限控制。
Register an RPC service interface, you can specify the current controller name, and the original object that provides the RPC service, Specify unified access control
公共方法RemoveAndCloseSession
让MQTT客户端正常下线,调用本方法即可自由控制会话客户端强制下线操作。
公共方法ReportObjectApiMethod
使用指定的对象来返回网络的API接口,前提是传入的数据为json参数,返回的数据为 OperateResult<string> 数据,详细参照说明
Use the specified object to return the API interface of the network, provided that the incoming data is json parameters and the returned data is OperateResult<string> data, please refer to the description for details
公共方法ReportOperateResult(MqttSession, OperateResultString)
向客户端发布一个操作结果的信息,仅用于同步网络的时候反馈操作结果,该操作可能成功,可能失败,客户端就知道服务器发生了什么,以及结果如何。
Publish an operation result information to the client, which is only used to feed back the operation result when synchronizing the network. The operation may succeed or fail, and the client knows what happened to the server and the result.
公共方法ReportOperateResult(MqttSession, String)
向客户端发布一个失败的操作信息,仅用于同步网络的时候反馈失败结果,将错误的信息反馈回客户端,客户端就知道服务器发生了什么,为什么反馈失败。
Publish a failed operation information to the client, which is only used to feed back the failure result when synchronizing the network. If the error information is fed back to the client, the client will know what happened to the server and why the feedback failed.
公共方法ReportProgress
向客户端发布一个进度报告的信息,仅用于同步网络的时候才支持进度报告,将进度及消息发送给客户端,比如你的服务器需要分成5个部分完成,可以按照百分比提示给客户端当前服务器发生了什么
Publish the information of a progress report to the client. The progress report is only supported when the network is synchronized. The progress and the message are sent to the client. For example, your server needs to be divided into 5 parts to complete. You can prompt the client according to the percentage. What happened to the server
受保护的方法ReturnAbsoluteFileName
返回服务器的绝对路径,包含根目录的信息 [Root Dir][A][B][C]...[FileName] 信息
公共方法ServerClose
关闭服务器的引擎
Shut down the server's engine
(继承自 CommunicationTcpServer。)
公共方法ServerStart
指定端口号来启动服务器的引擎
Specify the port number to start the server's engine
(继承自 CommunicationTcpServer。)
公共方法ServerStart(Int32)
指定端口号来启动服务器的引擎
Specify the port number to start the server's engine
(继承自 CommunicationTcpServer。)
公共方法SetSslPipeAction
设置一个SSL的管道操作对象,在管道实例化之后,可以进行一些初始化的属性设置,例如自定义 SslProtocols 枚举
(继承自 CommunicationTcpServer。)
公共方法SetTrustedIpAddress
设置并启动受信任的客户端登录并读写,如果为null,将关闭对客户端的ip验证
Set and start the trusted client login and read and write, if it is null, the client's IP verification will be turned off
(继承自 CommunicationTcpServer。)
受保护的方法SocketAcceptExtraCheck
当客户端的socket登录的时候额外检查的操作,并返回操作的结果信息。
The operation is additionally checked when the client's socket logs in, and the result information of the operation is returned.
(继承自 CommunicationTcpServer。)
受保护的方法ThreadPoolLogin
当客户端连接到服务器,并听过额外的检查后,进行回调的方法
Callback method when the client connects to the server and has heard additional checks
(重写 CommunicationTcpServerThreadPoolLogin(PipeTcpNet, IPEndPoint).)
公共方法ToString
Returns a string that represents the current object.
(重写 ObjectToString.)
公共方法UnRegisterHttpRpcApiSingle
卸载一个指定的RPC接口,需要指定唯一的接口名称,如果接口重命名了,需要使用实际访问的时候的接口名称,返回是否成功卸载接口
To uninstall a specified RPC interface, you need to specify a unique interface name. If the interface is renamed, you need to use the interface name during the actual access, and return whether the interface is successfully uninstalled
公共方法UnRegisterMqttRpcApi(Object)
卸载一个已经注册的RPC接口,想要卸载指定的接口,此处就需要传入注册时一样的参数
Uninstall a registered RPC interface. If you want to uninstall the specified interface, you need to pass in the same parameters as the registration
公共方法UnRegisterMqttRpcApi(String, Object)
卸载一个已经注册的RPC接口,想要卸载指定的接口,此处就需要传入注册时一样的参数
Uninstall a registered RPC interface. If you want to uninstall the specified interface, you need to pass in the same parameters as the registration
公共方法UseFileServer
启动文件服务功能,协议头为FILE,需要指定服务器存储的文件路径
Start the file service function, the protocol header is FILE, you need to specify the file path stored by the server
公共方法UseSSL(X509Certificate)
使用SSL通信,传递一个证书的对象
(继承自 CommunicationTcpServer。)
公共方法UseSSL(String, String)
使用SSL通信,传递一个证书的路径,以及证书的密码
(继承自 CommunicationTcpServer。)
Top
扩展方法
  名称说明
公共扩展器方法ToJsonString
获取当前对象的JSON格式表示的字符串。
Gets the string represented by the JSON format of the current object.
(由 HslExtension 定义。)
Top
参见