YS-SCADA-LiShun-New/src/YSAI.DAQ/YSAI.Pack/YSAI.Mqtt.Pack/YSAI.Mqtt.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>YSAI.Mqtt</name>
    </assembly>
    <members>
        <member name="T:YSAI.Mqtt.client.MqttClientData">
            <summary>
            mqtt 客户端数据
            </summary>
        </member>
        <member name="T:YSAI.Mqtt.client.MqttClientData.Basics">
            <summary>
            基础数据
            </summary>
        </member>
        <member name="P:YSAI.Mqtt.client.MqttClientData.Basics.SN">
            <summary>
            唯一标识符
            </summary>
        </member>
        <member name="P:YSAI.Mqtt.client.MqttClientData.Basics.Ip">
            <summary>
            IP地址
            </summary>
        </member>
        <member name="P:YSAI.Mqtt.client.MqttClientData.Basics.Port">
            <summary>
            端口
            </summary>
        </member>
        <member name="P:YSAI.Mqtt.client.MqttClientData.Basics.UserName">
            <summary>
            用户
            </summary>
        </member>
        <member name="P:YSAI.Mqtt.client.MqttClientData.Basics.Password">
            <summary>
            密码
            </summary>
        </member>
        <member name="P:YSAI.Mqtt.client.MqttClientData.Basics.ClientID">
            <summary>
            客户端ID
            不输入默认生成随机
            </summary>
        </member>
        <member name="P:YSAI.Mqtt.client.MqttClientData.Basics.QualityOfServiceLevel">
            <summary>
            QoS0 是最低级别，基本上等同于 Fire and Forget 模式，发送者发送完数据之后，不关心消息是否已经投递到了接收者那边。
            QoS1 是中间级别，保证消息至少送达一次。MQTT 通过简单的 ACK 机制来保证 QoS1。
            QoS2 是最高级别，保证到且仅到一次。这通过更加复杂的消息流程保证。
            
            注意：QoS 级别越高，流程越复杂，系统资源消耗越大
            </summary>
        </member>
        <member name="M:YSAI.Mqtt.client.MqttClientData.Basics.Equals(System.Object)">
            <summary>
            重写基类中的Equals方法
            </summary>
            <param name="obj"></param>
            <returns></returns>
        </member>
        <member name="T:YSAI.Mqtt.client.MqttClientOperate">
            <summary>
            Mqtt 客户端
            </summary>
        </member>
        <member name="M:YSAI.Mqtt.client.MqttClientOperate.Instance(YSAI.Mqtt.client.MqttClientData.Basics)">
            <summary>
            单例模式
            </summary>
            <returns></returns>
        </member>
        <member name="M:YSAI.Mqtt.client.MqttClientOperate.#ctor(YSAI.Mqtt.client.MqttClientData.Basics)">
            <summary>
            构造函数
            </summary>
        </member>
        <member name="F:YSAI.Mqtt.client.MqttClientOperate.mqttClientData">
            <summary>
            基础数据
            </summary>
        </member>
        <member name="F:YSAI.Mqtt.client.MqttClientOperate.mqttClient">
            <summary>
            MQTT 客户端
            </summary>
        </member>
        <member name="M:YSAI.Mqtt.client.MqttClientOperate.MqttClient_ApplicationMessageReceivedAsync(MQTTnet.Client.MqttApplicationMessageReceivedEventArgs)">
            <summary>
            消息事件
            </summary>
        </member>
        <member name="M:YSAI.Mqtt.client.MqttClientOperate.PublishAsync(System.String,System.String,System.Int32,System.Boolean)">
            <summary>
            发布订阅
            </summary>
            <param name="Topic">主题</param>
            <param name="Content">内容</param>
            <param name="QoSLevel">
            消息等级
            QoS 0 是最低级别，基本上等同于 Fire and Forget 模式，发送者发送完数据之后，不关心消息是否已经投递到了接收者那边。
            QoS 1 是中间级别，保证消息至少送达一次。MQTT 通过简单的 ACK 机制来保证 QoS1。
            QoS 2 是最高级别，保证到且仅到一次。这通过更加复杂的消息流程保证。
            
            注意：QoS 级别越高，流程越复杂，系统资源消耗越大
            </param>
            <param name="Retain">消息是否保留</param>
            <returns>统一结果</returns>
        </member>
        <member name="M:YSAI.Mqtt.client.MqttClientOperate.Publish(System.String,System.String,System.Int32,System.Boolean)">
            <summary>
            发布订阅
            </summary>
            <param name="Topic">主题</param>
            <param name="Content">内容</param>
            <param name="QoSLevel">
            消息等级
            QoS 0 是最低级别，基本上等同于 Fire and Forget 模式，发送者发送完数据之后，不关心消息是否已经投递到了接收者那边。
            QoS 1 是中间级别，保证消息至少送达一次。MQTT 通过简单的 ACK 机制来保证 QoS1。
            QoS 2 是最高级别，保证到且仅到一次。这通过更加复杂的消息流程保证。
            
            注意：QoS 级别越高，流程越复杂，系统资源消耗越大
            </param>
            <param name="Retain">消息是否保留</param>
            <returns>统一结果</returns>
        </member>
        <member name="M:YSAI.Mqtt.client.MqttClientOperate.AddSubscribeAsync(System.String,System.Int32)">
            <summary>
            添加订阅
            </summary>
            <param name="Topic">主题</param>
            <param name="QoSLevel">
            消息等级
            QoS 0 是最低级别，基本上等同于 Fire and Forget 模式，发送者发送完数据之后，不关心消息是否已经投递到了接收者那边。
            QoS 1 是中间级别，保证消息至少送达一次。MQTT 通过简单的 ACK 机制来保证 QoS1。
            QoS 2 是最高级别，保证到且仅到一次。这通过更加复杂的消息流程保证。
            
            注意：QoS 级别越高，流程越复杂，系统资源消耗越大
            </param>
            <returns>统一结果</returns>
        </member>
        <member name="M:YSAI.Mqtt.client.MqttClientOperate.AddSubscribe(System.String,System.Int32)">
            <summary>
            添加订阅
            </summary>
            <param name="Topic">主题</param>
            <param name="QoSLevel">
            消息等级
            QoS 0 是最低级别，基本上等同于 Fire and Forget 模式，发送者发送完数据之后，不关心消息是否已经投递到了接收者那边。
            QoS 1 是中间级别，保证消息至少送达一次。MQTT 通过简单的 ACK 机制来保证 QoS1。
            QoS 2 是最高级别，保证到且仅到一次。这通过更加复杂的消息流程保证。
            
            注意：QoS 级别越高，流程越复杂，系统资源消耗越大
            </param>
            <returns>统一结果</returns>
        </member>
        <member name="M:YSAI.Mqtt.client.MqttClientOperate.RemoveSubscribeAsync(System.String)">
            <summary>
            移除订阅
            </summary>
            <param name="Topic">主题</param>
            <returns>统一结果</returns>
        </member>
        <member name="M:YSAI.Mqtt.client.MqttClientOperate.RemoveSubscribe(System.String)">
            <summary>
            移除订阅
            </summary>
            <param name="Topic">主题</param>
            <returns>统一结果</returns>
        </member>
        <member name="T:YSAI.Mqtt.service.MqttServiceData">
            <summary>
            mqtt 服务 数据
            </summary>
        </member>
        <member name="T:YSAI.Mqtt.service.MqttServiceData.Basics">
            <summary>
            基础数据
            </summary>
        </member>
        <member name="P:YSAI.Mqtt.service.MqttServiceData.Basics.Port">
            <summary>
            端口
            </summary>
        </member>
        <member name="P:YSAI.Mqtt.service.MqttServiceData.Basics.UserName">
            <summary>
            用户
            </summary>
        </member>
        <member name="P:YSAI.Mqtt.service.MqttServiceData.Basics.Password">
            <summary>
            密码
            </summary>
        </member>
        <member name="P:YSAI.Mqtt.service.MqttServiceData.Basics.MaxNumber">
            <summary>
            最大连接数
            </summary>
        </member>
        <member name="M:YSAI.Mqtt.service.MqttServiceData.Basics.Equals(System.Object)">
            <summary>
            重写基类中的Equals方法
            </summary>
            <param name="obj"></param>
            <returns></returns>
        </member>
        <member name="T:YSAI.Mqtt.service.MqttServiceData.Steps">
            <summary>
            哪一个步骤
            </summary>
        </member>
        <member name="T:YSAI.Mqtt.service.MqttServiceData.States">
            <summary>
            状态
            </summary>
        </member>
        <member name="F:YSAI.Mqtt.service.MqttServiceData.States.On">
            <summary>
            已启动
            </summary>
        </member>
        <member name="F:YSAI.Mqtt.service.MqttServiceData.States.Off">
            <summary>
            已停止
            </summary>
        </member>
        <member name="F:YSAI.Mqtt.service.MqttServiceData.States.Null">
            <summary>
            啥也没干
            </summary>
        </member>
        <member name="T:YSAI.Mqtt.service.MqttServiceOperate">
            <summary>
            mqtt 服务端
            </summary>
        </member>
        <member name="M:YSAI.Mqtt.service.MqttServiceOperate.Instance(YSAI.Mqtt.service.MqttServiceData.Basics)">
            <summary>
            单例模式
            </summary>
            <returns></returns>
        </member>
        <member name="M:YSAI.Mqtt.service.MqttServiceOperate.#ctor(YSAI.Mqtt.service.MqttServiceData.Basics)">
            <summary>
            构造函数
            </summary>
            <param name="mqttServiceData">参数</param>
        </member>
        <member name="F:YSAI.Mqtt.service.MqttServiceOperate.mqttServiceData">
            <summary>
            参数
            </summary>
        </member>
        <member name="F:YSAI.Mqtt.service.MqttServiceOperate.mqttServer">
            <summary>
            MQTT 服务
            </summary>
        </member>
        <member name="F:YSAI.Mqtt.service.MqttServiceOperate.states">
            <summary>
            状态
            </summary>
        </member>
        <member name="M:YSAI.Mqtt.service.MqttServiceOperate.MqttServer_StoppedAsync(System.EventArgs)">
            <summary>
            服务停止后
            </summary>
        </member>
        <member name="M:YSAI.Mqtt.service.MqttServiceOperate.MqttServer_StartedAsync(System.EventArgs)">
            <summary>
            服务启动后
            </summary>
        </member>
        <member name="M:YSAI.Mqtt.service.MqttServiceOperate.MqttServer_ClientUnsubscribedTopicAsync(MQTTnet.Server.ClientUnsubscribedTopicEventArgs)">
            <summary>
            客户端取消订阅
            </summary>
        </member>
        <member name="M:YSAI.Mqtt.service.MqttServiceOperate.MqttServer_ClientSubscribedTopicAsync(MQTTnet.Server.ClientSubscribedTopicEventArgs)">
            <summary>
            客户端订阅
            </summary>
        </member>
        <member name="M:YSAI.Mqtt.service.MqttServiceOperate.MqttServer_ApplicationMessageNotConsumedAsync(MQTTnet.Server.ApplicationMessageNotConsumedEventArgs)">
            <summary>
            客户端消息接收
            </summary>
        </member>
        <member name="M:YSAI.Mqtt.service.MqttServiceOperate.MqttServer_ClientDisconnectedAsync(MQTTnet.Server.ClientDisconnectedEventArgs)">
            <summary>
            客户端断开
            </summary>
        </member>
        <member name="M:YSAI.Mqtt.service.MqttServiceOperate.MqttServer_ClientConnectedAsync(MQTTnet.Server.ClientConnectedEventArgs)">
            <summary>
            客户端连接
            </summary>
        </member>
        <member name="M:YSAI.Mqtt.service.MqttServiceOperate.MqttServer_ValidatingConnectionAsync(MQTTnet.Server.ValidatingConnectionEventArgs)">
            <summary>
            身份验证
            </summary>
            <param name="arg"></param>
            <returns></returns>
            <exception cref="T:System.NotImplementedException"></exception>
        </member>
        <member name="M:YSAI.Mqtt.service.MqttServiceOperate.GetState">
            <summary>
            获取状态
            </summary>
            <returns></returns>
        </member>
        <member name="M:YSAI.Mqtt.service.MqttServiceOperate.Dispose">
            <summary>
            释放
            </summary>
        </member>
        <member name="M:YSAI.Mqtt.service.MqttServiceOperate.On">
            <summary>
            打开
            </summary>
            <returns>统一泛型结果</returns>
        </member>
        <member name="M:YSAI.Mqtt.service.MqttServiceOperate.OnAsync">
            <summary>
            异步打开
            </summary>
            <returns>统一泛型结果</returns>
        </member>
        <member name="M:YSAI.Mqtt.service.MqttServiceOperate.Off">
            <summary>
            关闭
            </summary>
            <returns>统一泛型结果</returns>
        </member>
        <member name="M:YSAI.Mqtt.service.MqttServiceOperate.OffAsync">
            <summary>
            异步关闭
            </summary>
            <returns>统一泛型结果</returns>
        </member>
        <member name="T:YSAI.Mqtt.service.websocket.MqttWebSocketServiceData">
            <summary>
            websocketservice 数据
            </summary>
        </member>
        <member name="T:YSAI.Mqtt.service.websocket.MqttWebSocketServiceData.IMqttWebSocketService">
            <summary>
            MQTTwebsocket 接口
            </summary>
        </member>
        <member name="T:YSAI.Mqtt.service.websocket.MqttWebSocketServiceData.Basics">
            <summary>
            基础数据
            </summary>
        </member>
        <member name="P:YSAI.Mqtt.service.websocket.MqttWebSocketServiceData.Basics.Port">
            <summary>
            MQTT服务端口
            </summary>
        </member>
        <member name="P:YSAI.Mqtt.service.websocket.MqttWebSocketServiceData.Basics.WsPort">
            <summary>
            端口 Mqtt WEBSOCKET 使用
            </summary>
        </member>
        <member name="P:YSAI.Mqtt.service.websocket.MqttWebSocketServiceData.Basics.UserName">
            <summary>
            用户
            </summary>
        </member>
        <member name="P:YSAI.Mqtt.service.websocket.MqttWebSocketServiceData.Basics.Password">
            <summary>
            密码
            </summary>
        </member>
        <member name="P:YSAI.Mqtt.service.websocket.MqttWebSocketServiceData.Basics.Uri">
            <summary>
            地址
            </summary>
        </member>
        <member name="M:YSAI.Mqtt.service.websocket.MqttWebSocketServiceData.Basics.Equals(System.Object)">
            <summary>
            重写基类中的Equals方法
            </summary>
            <param name="obj"></param>
            <returns></returns>
        </member>
        <member name="T:YSAI.Mqtt.service.websocket.MqttWebSocketServiceData.Steps">
            <summary>
            哪一个步骤
            </summary>
        </member>
        <member name="T:YSAI.Mqtt.service.websocket.MqttWebSocketServiceOperate">
            <summary>
            MQTT WEBSOCKET 服务
            </summary>
        </member>
        <member name="M:YSAI.Mqtt.service.websocket.MqttWebSocketServiceOperate.Instance(YSAI.Mqtt.service.websocket.MqttWebSocketServiceData.Basics)">
            <summary>
            单例模式
            </summary>
            <returns></returns>
        </member>
        <member name="P:YSAI.Mqtt.service.websocket.MqttWebSocketServiceOperate.mqttServiceData">
            <summary>
            配置数据
            </summary>
        </member>
        <member name="P:YSAI.Mqtt.service.websocket.MqttWebSocketServiceOperate.mqttServiceData_Static">
            <summary>
            配置数据（静态）
            </summary>
        </member>
        <member name="M:YSAI.Mqtt.service.websocket.MqttWebSocketServiceOperate.#ctor(YSAI.Mqtt.service.websocket.MqttWebSocketServiceData.Basics)">
            <summary>
            构造函数
            </summary>
            <param name="param"></param>
        </member>
        <member name="M:YSAI.Mqtt.service.websocket.MqttWebSocketServiceOperate.GetWriteHead">
            <summary>
            获取控制台输出头
            </summary>
            <returns></returns>
        </member>
        <member name="E:YSAI.Mqtt.service.websocket.MqttWebSocketServiceOperate.OnEvent">
            <summary>
            信息传递
            </summary>
        </member>
        <member name="F:YSAI.Mqtt.service.websocket.MqttWebSocketServiceOperate.OnEventHandler">
            <summary>
            信息传递
            </summary>
        </member>
        <member name="T:YSAI.Mqtt.service.websocket.MqttWebSocketServiceOperate.MqttController">
            <summary>
            MQTT控制器
            </summary>
        </member>
        <member name="M:YSAI.Mqtt.service.websocket.MqttWebSocketServiceOperate.MqttController.MqttServer_ClientUnsubscribedTopicAsync(MQTTnet.Server.ClientUnsubscribedTopicEventArgs)">
            <summary>
            客户端取消订阅
            </summary>
        </member>
        <member name="M:YSAI.Mqtt.service.websocket.MqttWebSocketServiceOperate.MqttController.MqttServer_ClientSubscribedTopicAsync(MQTTnet.Server.ClientSubscribedTopicEventArgs)">
            <summary>
            客户端订阅
            </summary>
        </member>
        <member name="M:YSAI.Mqtt.service.websocket.MqttWebSocketServiceOperate.MqttController.MqttServer_ApplicationMessageNotConsumedAsync(MQTTnet.Server.ApplicationMessageNotConsumedEventArgs)">
            <summary>
            客户端消息接收
            </summary>
        </member>
        <member name="M:YSAI.Mqtt.service.websocket.MqttWebSocketServiceOperate.MqttController.MqttServer_ClientDisconnectedAsync(MQTTnet.Server.ClientDisconnectedEventArgs)">
            <summary>
            客户端断开
            </summary>
        </member>
        <member name="M:YSAI.Mqtt.service.websocket.MqttWebSocketServiceOperate.MqttController.MqttServer_ClientConnectedAsync(MQTTnet.Server.ClientConnectedEventArgs)">
            <summary>
            客户端连接
            </summary>
        </member>
        <member name="M:YSAI.Mqtt.service.websocket.MqttWebSocketServiceOperate.MqttController.MqttServer_ValidatingConnectionAsync(MQTTnet.Server.ValidatingConnectionEventArgs)">
            <summary>
            身份验证
            </summary>
            <param name="arg"></param>
            <returns></returns>
            <exception cref="T:System.NotImplementedException"></exception>
        </member>
        <member name="T:YSAI.Mqtt.service.websocket.MqttWebSocketServiceOperate.Startup">
            <summary>
            启动
            </summary>
        </member>
        <member name="M:YSAI.Mqtt.service.websocket.MqttWebSocketServiceOperate.Startup.Configure(Microsoft.AspNetCore.Builder.IApplicationBuilder,Microsoft.AspNetCore.Hosting.IWebHostEnvironment,YSAI.Mqtt.service.websocket.MqttWebSocketServiceOperate.MqttController)">
            <summary>
            配置
            </summary>
        </member>
        <member name="M:YSAI.Mqtt.service.websocket.MqttWebSocketServiceOperate.Startup.ConfigureServices(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
            <summary>
            配置服务
            </summary>
            <param name="services"></param>
        </member>
    </members>
</doc>