MqttSession 类 |
Mqtt的会话信息，包含了一些基本的信息内容，客户端的IP地址及端口，Client ID，用户名，活动时间，是否允许发布数据等等
Mqtt's session information includes some basic information content, the client's IP address and port, Client ID, user name, activity time, whether it is allowed to publish data, etc.
Mqtt's session information includes some basic information content, the client's IP address and port, Client ID, user name, activity time, whether it is allowed to publish data, etc.
继承层次SystemObject
HslCommunication.MQTTMqttSession
HslCommunication.MQTTMqttSession
命名空间： HslCommunication.MQTT
程序集： HslCommunication (在 HslCommunication.dll 中) 版本：12.1.2.0 (12.1.2.0)
语法MqttSession 类型公开以下成员。
构造函数| 名称 | 说明 | |
|---|---|---|
 | MqttSession |
实例化一个对象，指定ip地址及端口，以及协议内容 Instantiate an object, specify ip address and port, and protocol content |
属性| 名称 | 说明 | |
|---|---|---|
 | ActiveTime |
当前客户端的激活时间 The activation time of the current client |
| ActiveTimeSpan |
两次活动的最小时间间隔 Minimum time interval between two activities |
| ClientId |
当前接收的客户端ID信息 Client ID information currently received |
| DeveloperPermissions |
获取或设置当前的会话是否拥有开发者权限，在开发者权限下，可以遍历接口信息，默认只有admin账户支持开发者权限，如果自定义设置账户权限，则需要在会话登录的事件里，将本属性值设置为 True Obtain or set whether the current session has developer permissions, under the developer permissions, you can traverse the interface information, by default, only the admin account supports developer permissions, if you customize the account permissions, you need to set the value of this property to True in the session login event |
| EndPoint |
远程的ip地址端口信息 Remote ip address port information |
| ForbidPublishTopic |
获取或设置当前的MQTT客户端是否允许发布消息，默认为False，如果设置为True，就是禁止发布消息，服务器不会触发收到消息的事件。 Gets or sets whether the current MQTT client is allowed to publish messages, the default is False, if set to True, it is forbidden to publish messages, The server does not trigger the event of receiving a message. |
| IsAesCryptography |
获取设置客户端的加密信息
|
| OnlineTime |
获取当前的客户端的上线时间 Get the online time of the current client |
| Protocol |
当前的协议信息，一般为 "MQTT"，如果是同步客户端那么是 "HUSL"，如果是文件客户端就是 "FILE" The current protocol information, generally "MQTT", if it is a synchronous client then it is "HUSL", if it is a file client it is "FILE" |
| Tag |
当前的会话信息关联的自定义信息 Custom information associated with the current session information |
| UserName |
当前的用户名 Current username |
| WillMessage |
遗嘱的消息内容 The message content of the will |
| WillTopic |
遗嘱主题 will topic |
方法| 名称 | 说明 | |
|---|---|---|
| AddSubscribe(String) |
当前的会话信息新增一个订阅的主题信息 The current session information adds a subscribed topic information |
| AddSubscribe(String) |
当前的会话信息新增多个订阅的主题信息 The current session information adds multiple subscribed topic information |
| Equals | Determines whether the specified object is equal to the current object. (继承自 Object。) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (继承自 Object。) |
| GetHashCode | Serves as the default hash function. (继承自 Object。) |
| GetSessionInfo |
获取当前会话的基本信息 Obtain basic information about the current session |
| GetSessionOnlineInfo |
获取当前的会话信息，包含在线时间的信息 Get current session information, including online time information |
| GetTopics |
获取当前客户端订阅的所有的Topic信息 Get all Topic information subscribed by the current client |
| GetType | Gets the Type of the current instance. (继承自 Object。) |
| IsClientSubscribe |
检查当前的会话对象里是否订阅了指定的主题内容 Check whether the specified topic content is subscribed in the current session object |
| MemberwiseClone | Creates a shallow copy of the current Object. (继承自 Object。) |
| RemoveSubscribe(String) |
移除会话信息的一个订阅的主题
|
| RemoveSubscribe(String) |
移除会话信息的一个订阅的主题 Remove a subscribed topic from session information |
| ToString | Returns a string that represents the current object. (重写 ObjectToString.) |
扩展方法| 名称 | 说明 | |
|---|---|---|
 | ToJsonString |
获取当前对象的JSON格式表示的字符串。 (由 HslExtension 定义。)Gets the string represented by the JSON format of the current object. |
参见